API Documentation
Offramps API
Offramps API
  • Guides
    • Getting Started
  • API Reference
    • Authentication
    • Agreements
      • Agreements#Show
    • Users
      • Users#Create
      • Users#Show
      • Users#Index
    • KYC Sessions
      • KYC#Create
    • Payment Details
      • PaymentDetails#Create
      • PaymentDetails#Index
      • PaymentDetails#Show
      • PaymentDetails#Validate
      • PaymentDetails#Deactivate
      • Rail Availability
      • Required Fields For Local Currency Payouts
      • Required Fields For Swift Currency Payouts
    • Quotes
      • How to make a payment
      • Quotes#Create
      • Quotes#Show
      • Quotes#Execute
      • Quote#Rate
    • Offramps
      • Offramps#Index
      • Offramps#Create
      • Offramps#Update
      • Offramps#Show
      • Limitations
    • Webhooks
      • KYC Webhook
      • Offramp Webhook
      • Payment Detail Webhook
      • Webhook Signatures
    • Errors
    • Conversions
      • Conversions#Create
  • Sandbox Only
    • Sandbox Special Moves
Powered by GitBook
On this page
  • Create a Payment Detail
  • Create a Payment Detail
  1. API Reference
  2. Payment Details

PaymentDetails#Create

PreviousPayment DetailsNextPaymentDetails#Index

Create a Payment Detail

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

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

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

bank_name*

String

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

sort_code

String

iban

String

swift_bic

String

document_number

String

account_type

String

rib_number

String

bsb_number

String

rails

String

ncc

String

branch_code

String

bank_code

String

date_of_birth*

String

The date of birth of the recipient. Required for individuals

ifsc

String

{
    "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]

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

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

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

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

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

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

checking or savings. See what currencies require it.

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

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

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 to understand what is supported.

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

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

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

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

Required Fields For Currencies
here
here
here
here
here
here
here
here
here
Rail Availability
here
here
here
here