Update Merchant

Update an existing merchant from Prahsys

PATCH/n1/merchant/{merchantId}

MEDIA TYPE: application/json
name
string

DBA of the merchant

minLength: 1
industry
string
businessPhone
string
pattern: ^\+(?:[0-9]){6,14}[0-9]$
website
string

Website of the merchant

format: uri
primaryContactId
string

Id of the merchant's user.

minLength: 1

status
string

Status of the merchant (Only for SANDBOX merchant)

Enum

Possible values:

ONBOARDING_TO_GATEWAYWAITLISTEDAPPROVED_SANDBOXAPPLICATION_PENDINGAPPLICATION_IN_REVIEWAPPLICATION_INFORMATION_REQUESTEDAPPLICATION_ABANDONEDAPPLICATION_APPROVEDAPPLICATION_DENIEDAPPLICATION_REQUIRES_DOCUMENT_SUBMISSIONAPPLICATION_AWAITING_DIGITAL_SIGNATURE
readyForProcessing
boolean

Ready for processing status of the merchant (Only for SANDBOX merchant)

RESPONSE SCHEMA: application/json
success
boolean
message
string

id
string

The unique id of the merchant

minLength: 1
taxId
string | null

Masked Tax id of the merchant

name
string

The name of the organization

minLength: 1
legalName
string | null

The legal name of the merchant

slug
string

The slug for the merchant. This can be used to easily redirect a user to the merchant's dashboard: https://dashboard.prahsys.com/{slug}

website
string | null

The website of the merchant

applicationId
number | null

The underwriting application number for payment processing

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"
Enum

Possible values:

LIVESANDBOX
enabledDirectPay
string | null

A merchant is allowed to accept payments using the raw card information within sourceOfFunds.

enabledTokenByPaymentId
string | null

A merchant is allowed to tokenize by payment id.

monthlyAVT
number | null

Merchant's monthly average transaction

status
string

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
statusUpdatedAt
string | null

Latest time status has updated at

businessPhone
string

business phone number of the merchant

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

Business address of the merchant

example: {"street1":"Street Addr","street2":null,"city":"Seattle","state":"WA","postalCode":"98102"}
mailingAddress
unknown

Mailing address of the merchant

example: {"street1":"Street Addr","street2":null,"city":"Seattle","state":"WA","postalCode":"98102"}
bankDetailrequired
object | null

Bank detail of the merchant (Only for approved LIVE merchant)

required
approvedParametersrequired
object | null

Approved parameters for the merchant (Only for approved LIVE merchant)

required
primaryContactEmail
string

The primary contact email of the merchant.

primaryContactPhone
string | null

The primary contact phone of the merchant

nullablepattern: ^\+(?:[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"
signingUrlExpiresAt
string | null

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)

createdAt
string

Request

shell
https://api.prahsys.com/merchant/n1/merchant/{merchantId}
Loading…

Response

Update Merchant Response
JSON response for updating a merchant