Merchant

The Merchant object represents the merchant account. It holds detailed information about the merchant organization. The individual merchant can perform API operations on it’s own behalf. The merchant can perform payment operations, retrieve payment/transactions details and more

LIVE merchants are merchants that can process real transactions as well as test transactions. As a developer, when you sign up with Prahsys, your merchant account is considered a LIVE account. You cannot process test transactions until you generate a LIVE API key.

SANDBOX merchants are merchants that can only process test transactions. They are used for testing purposes and cannot process real transactions. You can create a SANDBOX merchant account if you are a channel partner. You can create as many SANDBOX accounts as you want.

Properties

  • Name

    id

    Type
    string(required)
    Description
    The unique id of the merchant
    Length Constraints

    Length constraints:

    Min Length: 1
    Example

    Example:

    "org_1234567890"
  • Name

    name

    Type
    string(required)
    Description
    The name of the organization
    Length Constraints

    Length constraints:

    Min Length: 1
    Example

    Example:

    "Merchant Name"
  • Name

    slug

    Type
    string(nullable)
    Description
    The slug for the merchant. This can be used to easily redirect a user to the merchant's dashboard: https://dashboard.prahsys.com/{slug}
    Example

    Example:

    "merchant-name"
  • Name

    applicationId

    Type
    number(nullable)
    Description
    The underwriting application number for payment processing
    Example

    Example:

    123456789
  • Name

    createdAt

    Type
    string(required)
    Description
    Example

    Example:

    "2023-01-01T00:00:00.000Z"
  • Name

    readyForProcessing

    Type
    boolean(required)
    Description
    If Merchant is ready for payment processing
    Example

    Example:

    true
  • Name

    signed

    Type
    boolean(required)
    Description
    If Merchant has signed the agreement or not
    Example

    Example:

    true
  • Name

    type

    Type
    string(required)
    Description
    The type of organization
    Enum

    Possible values:

    LIVESANDBOX
    Example

    Example:

    "SANDBOX"
  • Name

    enabledDirectPay

    Type
    string(nullable)
    Description
    A merchant is allowed to accept payments using the raw card information within sourceOfFunds.
    Example

    Example:

    "2023-01-01T00:00:00.000Z"
  • Name

    status

    Type
    string(required)
    Description
    The status of the merchant current status.
    Enum

    Possible values:

    ONBOARDING_TO_GATEWAYWAITLISTEDAPPROVED_SANDBOXAPPLICATION_PENDINGAPPLICATION_IN_REVIEWAPPLICATION_INFORMATION_REQUESTEDAPPLICATION_ABANDONEDAPPLICATION_APPROVEDAPPLICATION_DENIEDAPPLICATION_REQUIRES_DOCUMENTAPPLICATION_AWAITING_DIGITAL_SIGNATURE
    Example

    Example:

    "APPLICATION_APPROVED"
  • Name

    statusUpdatedAt

    Type
    string(nullable)
    Description
    Latest time status has updated at
    Example

    Example:

    "2023-01-01T00:00:00.000Z"
  • Name

    cardPresentTerminalIds

    Type
    array(required)
    Description
    List of card-present terminal ids of registered merchant
    Example

    Example:

    [ "22823427", "73821217" ]
  • Name

    cardNotPresentTerminalIds

    Type
    array(required)
    Description
    List of card-not-present terminal ids of registered merchant
    Example

    Example:

    [ "83942347" ]
  • Name

    primaryContactEmail

    Type
    string(required)
    Description
    The primary contact email of the merchant.
    Example

    Example:

    "contact@prahsys.com"
  • Name

    primaryContactPhone

    Type
    string(required)
    Description
    The primary contact phone of the merchant
    Pattern

    Pattern:

    ^\+(?:[0-9]){6,14}[0-9]$
    Example

    Example:

    "+1234567890"
  • Name

    primaryContactFirstName

    Type
    string(required)
    Description
    The primary contact first name of the merchant.
    Example

    Example:

    "John"
  • Name

    primaryContactLastName

    Type
    string(required)
    Description
    The primary contact last name of the merchant.
    Example

    Example:

    "Doe"
  • Name

    signingUrl

    Type
    string(nullable)
    Description
    The signing URL for the merchant to sign the agreement in order to start the underwriting process. (If required for merchant)
    Example

    Example: