Sign in

v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
Payer
V2/Payer

Create payment details

Create payment details for a user

post/v2/payer/{clientUserId}/payment-details

Path parameters

clientUserIdstring required
Example:user-123

The client user ID

Headers

x-api-keystring required

API key for authentication

Request body

bankNamestring required

Name of the bank

accountNamestring required

Name of the account holder

accountNumberstring

Bank account number

routingNumberstring

Bank routing number (US)

beneficiaryType'individual' | 'business' required

Type of beneficiary

currencystring required

Three-letter currency code (ISO 4217)

addressLine1string required

Primary address line

addressLine2string

Secondary address line

citystring required

City name

statestring

State or province code

countrystring required

Two-letter country code (ISO 3166-1 alpha-2)

dateOfBirthstring required

Date of birth in YYYY-MM-DD format

postalCodestring required

Postal or ZIP code

rails'local' | 'swift' | 'wire'

Payment rail type

sortCodestring

UK bank sort code

ibanstring

International Bank Account Number

swiftBicstring

SWIFT/BIC code

documentNumberstring

Government-issued ID number

documentTypestring

Type of government-issued ID (e.g., passport, driver's license)

accountType'checking' | 'savings'

Type of bank account

ribNumberstring

French RIB number

bsbNumberstring

Australian BSB number

nccstring

New Zealand NCC number

branchCodestring

Bank branch code

bankCodestring

Bank code

ifscstring

Indian Financial System Code

Response

Payment details created successfully

Example response

{
  "payment_detail": {
    "id": "pd_123456",
    "clientUserId": "user-123",
    "bankName": "Chase",
    "accountName": "Gordon's Chase Business Account",
    "currency": "usd",
    "beneficiaryType": "business"
  }
}