Add Merchant Bank Account

post

https://api.preczn.com/v1/merchants/{merchantId}/bankaccounts

Path Params

merchantId

string

required

Body Params

accountName

string

^[a-zA-Z0-9\s]*$

Name of bank associated with the bank account.

accountType

string

enum

Bank account type. One of personalChecking, personalSavings, corporateChecking, or corporateSavings.

Allowed:

nameOnAccount

string

^[a-zA-Z0-9\s]*$

Name of the person or corporation that is on the account. Must match what is displayed on checks.

routing

string

Bank routing number, validated against the sibling country field. USA: exactly 9 digits with a valid ABA checksum. CAN: exactly 8 digits. When country is omitted, only the 8-or-9-digit length check applies. Empty values are not validated. Responses return a masked value: **** followed by the last 4 digits.

account

string

length ≤ 17

^[+-]?([0-9]*[.])?[0-9]+$

Bank account number. Digits only, up to 17 characters; no spaces, hyphens, or decimal points. Responses return a masked value: **** followed by the last 4 digits.

primaryAccount

boolean

enum

Defaults to true

Flag that distinguishes this bank account as the primary account. Only the value true is accepted; sending false is rejected, so an account is demoted by designating a different account as primary instead. At least one account must be designated as the primary account, and there should be only one primary account — that uniqueness is not enforced by request validation.

Allowed:

country

string

enum

length ≥ 1

^[A-Z]{3}$

ISO 3166-1 alpha-3 Country Code.

Allowed:

hasDisbursementHistory

boolean

enum

Defaults to true

This field indicates whether the bank account has a history of receiving disbursements or payouts from payment processors. It can be utilized during the onboarding process for certain connections to enhance the underwriting procedure.

Allowed:

Headers

idempotency-key

string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Bank Account Created for Merchant.

401Invalid API key.

403Resource Forbidden.

404Merchant not found.

500Unable to service request due to server-side error. Please reattempt request.