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
  • Currency
  • AED
  • ARS
  • AUD
  • CAD
  • CHF
  • CNY
  • CLP
  • COP - rails "koywe" (recommended)
  • COP - rails "local"
  • EUR
  • GBP
  • HKD
  • IDR
  • INR
  • JPY
  • KRW
  • MXN
  • MYR
  • NZD
  • PHP
  • PLN
  • SGD
  • SOL
  • THB
  • USD
  1. API Reference
  2. Payment Details

Required Fields For Currencies

Last updated 3 months ago

Currency

NB: Any regex with a - value indicates that it is required to be present. But is not ran through a regex check.

AED

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

aed

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

ARS

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

ars

beneficiary_type

Must be either business or individual

bank_name

account_number

/^[0-9]{22}$/

account_type

Must be either checking or savings

document_number

/^[0-9]{8,12}$/

AUD

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

aud

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

bsb_number

/^\d{3}-?\d{3}$/

account_number

/^\d{6,25}$/

CAD

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

cad

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

bank_code

branch_code

account_number

/^\d{6,25}$/

CHF

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

chf

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

CNY

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

cny

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

CLP

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

clp

beneficiary_type

Must be either business or individual

bank_name

document_type

rut

document_number

-

phone

-

neighbourhood

-

date_of_birth

-

activity

-

nationality

Required for individuals only, must be one of the following values: [AG AR BS BB BZ BO BR CA CL CO CR CU DM DO EC SV GD GT GY HT HN JM MX NI PA PY PE PR KN LC VC SR TT US UY VE AI AW BM BQ KY GS GL GP FK MQ MS AN TC VG VI]

gender

Required for individuals only, must be one of the following values: o m f

COP - rails "koywe" (recommended)

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

cop

beneficiary_type

Must be either business or individual

bank_name

document_type

For individuals the accepted values are: ced_ciu and ced_ext For businesses the accepted values are: nit

document_number

-

phone

-

account_type

Must be one of the following values: checking savings

neighbourhood

-

date_of_birth

-

activity

-

nationality

Required for individuals only, must be one of the following values: [AG AR BS BB BZ BO BR CA CL CO CR CU DM DO EC SV GD GT GY HT HN JM MX NI PA PY PE PR KN LC VC SR TT US UY VE AI AW BM BQ KY GS GL GP FK MQ MS AN TC VG VI]

gender

Required for individuals only, must be one of the following values: o m f

rails

Must be koywe

COP - rails "local"

This rail will be deprecated, please use COP - rails "koywe" instead.

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

cop

beneficiary_type

Must be either business or individual

bank_name

document_type

Must be one of the following values: national_id ruc passport resident_id

document_number

/^\d{1,15}$/

phone

-

account_number

/^\d{6,25}$/

account_type

Must be one of the following values: checking savings

rails

Must be one of the following values: nil, local

EUR

Field
Regex
Notes

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

eur

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

Only required if rails is set to swift

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

GBP

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

gbp

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

HKD

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

hkd

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

bank_code

IDR

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

idr

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

bank_code

-

account_number

/^\d{6,25}$/

INR

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

inr

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

bank_code

-

account_number

/^\d{6,25}$/

ifsc

/^(?=.[0-9])(?=.[a-zA-Z])[a-zA-Z0-9]{11}$/

JPY

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

jpy

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

KRW

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

krw

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

bank_code

MXN

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

mxn

beneficiary_type

Must be either business or individual

bank_name

document_type

For individuals the accepted values are: curp. For businesses the accepted values are: rfc

document_number

-

phone

-

neighbourhood

-

date_of_birth

-

activity

-

nationality

Required for individuals only, must be one of the following values: [AG AR BS BB BZ BO BR CA CL CO CR CU DM DO EC SV GD GT GY HT HN JM MX NI PA PY PE PR KN LC VC SR TT US UY VE AI AW BM BQ KY GS GL GP FK MQ MS AN TC VG VI]

gender

Required for individuals only, must be one of the following values: o m f

MYR

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

myr

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

NZD

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

nzd

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

ncc

PHP

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

php

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

PLN

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

pln

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

SGD

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

sgd

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

SOL

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

pen

beneficiary_type

Must be either business or individual

bank_name

document_type

For individuals the accepted values are: dni. For businesses the accepted values are: ruc

document_number

-

phone

-

neighbourhood

-

date_of_birth

-

activity

-

nationality

Required for individuals only, must be one of the following values: [AG AR BS BB BZ BO BR CA CL CO CR CU DM DO EC SV GD GT GY HT HN JM MX NI PA PY PE PR KN LC VC SR TT US UY VE AI AW BM BQ KY GS GL GP FK MQ MS AN TC VG VI]

gender

Required for individuals only, must be one of the following values: o m f

THB

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

thb

beneficiary_type

Must be either business or individual

bank_name

-

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

account_number

/^\d{6,25}$/

USD

Field
Regex
Notes

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

usd

beneficiary_type

Must be either business or individual

bank_name

-

account_number

/^[\da-zA-Z]{6,25}$/

routing_number

/^\d{9}$/

swift_bic

/^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$/i

Only required if rails is set to swift

iban

/^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$/

Can be sent instead of account_number if account_number is not provided by the users bank. Common for swift.

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

See - Bank names must exactly match one of the banks provided in the response of the LatamBankNames endpoint

United Arab Emirates Dirham (AED)
Argentine Peso (ARS)
Australian Dollar (AUD)
Canadian Dollar (CAD)
Swiss Franc (CHF)
Chinese Yuan (CNY)
Chilean Peso (CLP)
Colombian Peso (COP)
Euro (EUR)
Hong Kong Dollar (HKD)
Indonesian Rupiah (IDR)
Indian Rupee (INR)
Japanese Yen (JPY)
Peruvian Sol (PEN)
South Korean Won (KRW)
Mexican Peso (MXN)
Malaysian Ringgit (MYR)
New Zealand Dollar (NZD)
Philippine Peso (PHP)
Polish Zloty (PLN)
Singapore Dollar (SGD)
Thai Baht (THB)
United States Dollar (USD)
PaymentDetails#LatamBankNames
PaymentDetails#LatamBankNames
PaymentDetails#LatamBankNames
PaymentDetails#LatamBankNames
PaymentDetails#LatamBankNames
PaymentDetails#LatamBankNames