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:
"MxExRxCxHxAxNxT"
- Name
taxId- Type
string(nullable)- Description
- Masked Tax id of the merchant
- Example
Example:
"******123"
- Name
name- Type
string(required)- Description
- The name of the organization
- Length Constraints
Length constraints:
Min Length: 1- Example
Example:
"Merchant Name"
- Name
legalName- Type
string(nullable)- Description
- The legal name of the merchant
- Example
Example:
"Merchant Inc"
- Name
slug- Type
string(required)- 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
website- Type
string(nullable)- Description
- The website of the merchant
- Example
Example:
"https://test.com"
- Name
applicationId- Type
number(nullable)- Description
- The underwriting application number for payment processing
- Example
Example:
123456789
- Name
applicationLevel- Type
string(required)- Description
- Application level of a merchant
- Example
Example:
"LEVEL3"
- 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:
"LIVE"
- 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
enabledTokenByPaymentId- Type
string(nullable)- Description
- A merchant is allowed to tokenize by payment id.
- Example
Example:
"2023-01-08T00:00:00.000Z"
- Name
monthlyAVT- Type
number(nullable)- Description
- Merchant's monthly average transaction
- Example
Example:
20000
- 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_DOCUMENT_SUBMISSIONAPPLICATION_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(Deprecated, use 'terminals' property instead)
- Example
Example:
[ "22823427", "73821217" ]
- Name
cardNotPresentTerminalIds- Type
array(required)- Description
- List of card-not-present terminal ids of registered merchant (Deprecated, use 'terminals' property instead)
- Example
Example:
[ "83942347" ]
- Name
terminals- Type
array(required)- Description
- List of terminal information of registered merchant
- Example
Example:
- Name
businessPhone- Type
string(required)- Description
- business phone number of the merchant
- Pattern
Pattern:
^\+(?:[0-9]){6,14}[0-9]$- Example
Example:
"+1417567890"
- Name
businessAddress- Type
unknown(required)- Description
- Business address of the merchant
- Example
Example:
- Name
mailingAddress- Type
unknown(required)- Description
- Mailing address of the merchant
- Example
Example:
- Name
bankDetail- Type
object(nullable)- Description
- Bank detail of the merchant (Only for approved `LIVE` merchant)
- Example
Example:
- Name
approvedParameters- Type
object(nullable)- Description
- Approved parameters for the merchant (Only for approved `LIVE` merchant)
- Example
Example:
- Name
primaryContactEmail- Type
string(required)- Description
- The primary contact email of the merchant.
- Example
Example:
"contact@prahsys.com"
- Name
primaryContactPhone- Type
string(nullable)- 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:
- Name
signingUrlExpiresAt- Type
string(nullable)- Description
- Expiration time for signing url. (5 mins after the url creation for public signing url or NULL if signing url is already expired and providing protected signing url)
- Example
Example:
"2023-01-01T00:05:00.000Z"
- Name
createdAt- Type
string(required)- Description
- Example
Example:
"2023-01-01T00:00:00.000Z"