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
  • Required Fields For All Currencies
  • Additional EUR Local Fields
  • Additional GBP Local Fields
  • Additional USD Local Fields
  1. API Reference
  2. Payment Details

Required Fields For Local Currency Payouts

PreviousRail AvailabilityNextRequired Fields For Swift Currency Payouts

Last updated 3 months ago

The following currencies are available for Local payouts. Please note our

Required Fields For All Currencies

Please ensure that you supply the following bank account information for every payment_detail you create.

Field
Regex

address_line1

-

city

-

postal_code

-

country

ISO 3166-1 alpha-2 format

account_name

-

currency

three_letter_currency_code

beneficiary_type

Must be either business or individual

bank_name

-

Additional EUR Local Fields

Field
Regex
Notes

swift_bic

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

This value is often commonly referred to as BIC. It does not mean that it will be processed via 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})?$/

Additional GBP Local Fields

Field
Regex

iban

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

Additional USD Local Fields

Field
Regex

account_number

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

routing_number

/^\d{9}$/

phone

Required Fields For All Currencies Section
Required Fields For All Currencies
Euro (EUR)
Great British Pound (GBP)
United States Dollar (USD)