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.
	String

Request Body

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 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. There is also a wire option. Please see Rail Availability 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
ifsc	String	The ifsc of the bank account. See here what currencies require it.

200: OK

{
    "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,
        "ifsc": null,
        "rib_number": 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"
    }
}

Our EUR (SEPA) provider does not support payments to the following countries: [AE AF AS AO AI AG AW BS BD BB BZ BJ BO BW IO BN BF BI KH CM CV KY CF TD CX CC KM CG CD CK CU DJ DM DO EC GQ ER ET FJ PF TF GA GI GM GH GD GU GN GW GY HT HN IR IQ JM KI KP KG LA LB LS LR LY MG MW MV MI MH MR MU YT FM MN MS MZ MM NA NR NC NI NE NG NU NF MP PK PW PS PA PN PR RE RW BL SH KN PM VC WS ST SC SL SO GS SS SD SJ SY TJ TL TG TK TO TN TM TC TV UG UM VU VA VE VN VG VI WF EH YE ZM ZW]