Get Merchant
Get an existing merchant from Prahsys
GEThttps://api.prahsys.com/merchant/n1/merchant/{merchantId}
RESPONSE SCHEMA: application/json
success
boolean
message
string
id
string
The unique id of the merchant
minLength: 1
name
string
The name of the organization
minLength: 1
slug
string | null
The slug for the merchant. This can be used to easily redirect a user to the merchant's dashboard: https://dashboard.prahsys.com/{slug}
applicationId
number | null
The underwriting application number for payment processing
createdAt
string
readyForProcessing
boolean
If Merchant is ready for payment processing
signed
boolean
If Merchant has signed the agreement or not
type
string
The type of organization
example:
"LIVE"Possible values:
LIVESANDBOXenabledDirectPay
string | null
A merchant is allowed to accept payments using the raw card information within sourceOfFunds.
status
string
The status of the merchant current status.
Possible values:
ONBOARDING_TO_GATEWAYWAITLISTEDAPPROVED_SANDBOXAPPLICATION_PENDINGAPPLICATION_IN_REVIEWAPPLICATION_INFORMATION_REQUESTEDAPPLICATION_ABANDONEDAPPLICATION_APPROVEDAPPLICATION_DENIEDAPPLICATION_REQUIRES_DOCUMENTAPPLICATION_AWAITING_DIGITAL_SIGNATUREstatusUpdatedAt
string | null
Latest time status has updated at
primaryContactEmail
string
The primary contact email of the merchant.
primaryContactPhone
string
The primary contact phone of the merchant
pattern: ^\+(?:[0-9]){6,14}[0-9]$
primaryContactFirstName
string
The primary contact first name of the merchant.
primaryContactLastName
string
The primary contact last name of the merchant.
signingUrl
string | null
The signing URL for the merchant to sign the agreement in order to start the underwriting process. (If required for merchant)
example:
"https://dashboard.prahsys.com/example-merchant/application"Request
shell
https://api.prahsys.com/merchant/n1/merchant/{merchantId}Loading…Response
Get Merchant Response
JSON response for getting a merchant