PaymentDetails#Create

Create a Payment Detail

NB: For a list of what fields are required per currency, see Required Fields For Currencies.

Example Request

curl https://{{base_url}}/users/USER_ID/payment_details
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json" \
-d '{
    "payment_detail": {
        "bank_name": "Chase",
        "account_name": "Gordon's Chase Business Account",
        "account_number": "253009233489",
        "routing_number": "026013356",
        "beneficiary_type": "business",
        "currency": "usd",
        "address_line1": "24 Theatre St.",
        "city": "Paramount",
        "state": "CA",
        "country": "US",
        "date_of_birth": "12/12/1985",
        "postal_code": "90723",
        "rails": "local"
    }
}'

Endpoint Information

Create a Payment Detail

POST https://{{base_url}}/users/:user_id/payment_details

Path Parameters

Name	Type	Description
user_id*	UUID	ID of the User which the Payment Detail belongs to.

Name

Type

Description

user_id*

UUID

ID of the User which the Payment Detail belongs to.

Request Body

Name Type Description

Name	Type	Description
account_name*	String	A name to identify the bank account, e.g. 'Chris's Revolut'.
account_number	String	The account number of the bank account. See here what currencies require it.
currency*	String	The currency that the bank account accepts. E.g. 'usd', 'eur'.
address_line1*	String	The first line of the address of the person or organisation that controls the bank account.
address_line2	String	The second line of the address of the person or organisation that controls the bank account.
city*	String	The city where the person or organisation that controls the bank account is located.
state	String	The state/district where the person or organisation that controls the bank account is located. Required if country is `US.`
postal_code*	String	The postal/zip code where the person or organisation that controls the bank account is located.
country*	String	The country where the person or organisation that controls the bank account is located. Given in ISO 3166-1 alpha-2 format.
beneficiary_type*	String	`individual` or `business`
routing_number	String	The ACH routing number of the bank account. See here what currencies require it.
bank_name*	String	The name of the bank associated with the account. e.g. 'Revolut'
sort_code	String	The sort code of the bank account. See here what currencies require it.
iban	String	The IBAN of the bank account. See here what currencies require it.
swift_bic	String	The swift/bic of the bank account. See here what currencies require it.
document_number	String	The recipient's CUIT (tax number). See here what currencies require it.
account_type	String	`checking` or `savings`. See here what currencies require it.
rib_number	String	The recipient's Relevé d'Identité Bancaire number. See here what currencies require it.
bsb_number	String	The recipient's BSB number. See here what currencies require it.
rails	String	If the account is on the SWIFT network, put the value of this attribute to`swift`. Otherwise if it is SEPA/ACH or other local rails you can set it to `local`. If you leave this attribute blank it will default to `local`. Please see SWIFT Support to understand what is supported.
ncc	String	The ncc of the bank account. See here what currencies require it.
branch_code	String	The branch_code of the bank account. See here what currencies require it.
bank_code	String	The bank_code of the account. See here what currencies require it.
date_of_birth*	String	The date of birth of the recipient. Required for `individuals`
company_number*	String	The unique identification number assigned to the recipient business by the government or a regulatory authority. Required for `businesses.`
ifsc	String	The ifsc of the bank account. See here what currencies require it.

account_name*

String

A name to identify the bank account, e.g. 'Chris's Revolut'.

account_number

String

The account number of the bank account. See here what currencies require it.

currency*

String

The currency that the bank account accepts. E.g. 'usd', 'eur'.

address_line1*

String

The first line of the address of the person or organisation that controls the bank account.

address_line2

String

The second line of the address of the person or organisation that controls the bank account.

city*

String

The city where the person or organisation that controls the bank account is located.

state

String

The state/district where the person or organisation that controls the bank account is located. Required if country is US.

postal_code*

String

The postal/zip code where the person or organisation that controls the bank account is located.

country*

String

The country where the person or organisation that controls the bank account is located. Given in ISO 3166-1 alpha-2 format.

beneficiary_type*

String

individual or business

routing_number

String

The ACH routing number of the bank account. See here what currencies require it.

bank_name*

String

The name of the bank associated with the account. e.g. 'Revolut'

sort_code

String

The sort code of the bank account. See here what currencies require it.

iban

String

The IBAN of the bank account. See here what currencies require it.

swift_bic

String

The swift/bic of the bank account. See here what currencies require it.

document_number

String

The recipient's CUIT (tax number). See here what currencies require it.

account_type

String

checking or savings. See here what currencies require it.

rib_number

String

The recipient's Relevé d'Identité Bancaire number. See here what currencies require it.

bsb_number

String

The recipient's BSB number. See here what currencies require it.

rails

String

If the account is on the SWIFT network, put the value of this attribute toswift. Otherwise if it is SEPA/ACH or other local rails you can set it to local. If you leave this attribute blank it will default to local. Please see SWIFT Support to understand what is supported.

ncc

String

The ncc of the bank account. See here what currencies require it.

branch_code

String

The branch_code of the bank account. See here what currencies require it.

bank_code

String

The bank_code of the account. See here what currencies require it.

date_of_birth*

String

The date of birth of the recipient. Required for individuals

company_number*

String

The unique identification number assigned to the recipient business by the government or a regulatory authority. Required for businesses.

ifsc

String

The ifsc of the bank account. See here what currencies require it.

{
    "payment_detail": {
        "id": "fa898aec-519c-46be-9b4c-e76ef4ff99d9",
        "user_id": "a25a4274-8f50-4579-b476-8f35b297d4ad",
        "bank_name": "Chase",
        "account_name": "Gordon's Chase Business Account",
        "iban": null",
        "swift_bic": null,
        "beneficiary_type": "business",
        "account_number": "253009233489",
        "routing_number": "026013356",
        "sort_code": null,
        "document_number": null,
        "account_type": null,
        "currency": "usd",
        "address_line1": "24 Theatre St.",
        "address_line2": null,
        "city": "Paramount",
        "state": "CA",
        "postal_code": "90723",
        "date_of_birth": "12/12/1985",
        "country": "US",
        "status": "approved",
        "rails": "local"
    }
}

Blacklisted countries

Currency	Blacklisted Countries
eur	[AF AG AI AL AO AS AW BA BB BD BF BI BJ BL BN BO BS BW BY BZ CC CD CF CG CI CK CM CU CV CX DJ DM DO EC EH ER ET FJ FM GA GD GH GI GM GN GQ GS GU GW GY HN HT IO IQ IR JM JO KG KH KI KM KN KP KY LA LB LR LS LY MG MH MI MK ML MM MN MP MR MS MU MV MW MZ NA NC NE NF NG NI NR NU PA PF PG PH PK PM PN PR PS PW RE RS RU RW SC SD SH SJ SL SN SO SS ST SY TC TD TF TG TJ TK TL TM TN TO TT TV TZ UG UM UZ VA VC VE VG VI VN VU WF WS XK YE YT ZA ZM ZW]
usd	[AF AL AO AI BB BY BA BF BI KY CF CG CI CU EC ER ET FJ GI GU GN GW GY HT IR IQ JM JO XK LA LB LR LY MK ML MZ MM NI KP PK PW PA PG PH RU WS SN RS SC SO ZA SS SD SY TZ TT TM UG AE UZ VU VE VG VI YE ZW]

Currency

Blacklisted Countries

eur

[AF AG AI AL AO AS AW BA BB BD BF BI BJ BL BN BO BS BW BY BZ CC CD CF CG CI CK CM CU CV CX DJ DM DO EC EH ER ET FJ FM GA GD GH GI GM GN GQ GS GU GW GY HN HT IO IQ IR JM JO KG KH KI KM KN KP KY LA LB LR LS LY MG MH MI MK ML MM MN MP MR MS MU MV MW MZ NA NC NE NF NG NI NR NU PA PF PG PH PK PM PN PR PS PW RE RS RU RW SC SD SH SJ SL SN SO SS ST SY TC TD TF TG TJ TK TL TM TN TO TT TV TZ UG UM UZ VA VC VE VG VI VN VU WF WS XK YE YT ZA ZM ZW]

usd

[AF AL AO AI BB BY BA BF BI KY CF CG CI CU EC ER ET FJ GI GU GN GW GY HT IR IQ JM JO XK LA LB LR LY MK ML MZ MM NI KP PK PW PA PG PH RU WS SN RS SC SO ZA SS SD SY TZ TT TM UG AE UZ VU VE VG VI YE ZW]

PreviousPayment Details NextPaymentDetails#Index

Last updated 2 months ago