Skip to content

There is validation on the Create counterparty API.

Mandatory Fields by Counterparty Type

Mandatory fields by counterparty type and payment rail

Below is a breakdown of the mandatory fields by counterparty type and payment rail. ✅ denotes that a field is mandatory for a given counterparty type and rail.

🇺🇸 United States - FIAT_US

General

Field nameFedwire ACHSWIFT
customer_id
counterparty_type
(FIAT_US)

(FIAT_US)

(FIAT_US)
supported_rails
(FEDWIRE)

(ACH)

(SWIFT)
description   

Profile

Field nameFedwireACHSWIFT
profile_type
name
email   
telephone_number   
tax_reference_number   
date_of_birth   
unit_number   
address_line1 
address_line2   
address_line3   
city 
state
postal_code 
country_code
line_of_business   
relationship_to_customer

Account information

Field nameFedwireACHSWIFT
type 
asset_type_id   
account_number
routing_number 
swift_bic  
institution_name 
unit_number   
address_line1 
address_line2   
address_line3   
city 
state 
postal_code 
country_code 

🇺🇸 United States - FIAT_US_LINKED

General

Field nameACH
customer_id
counterparty_type
(FIAT_US_LINKED)
supported_rails
(ACH)
description 

Profile

Field nameACH
profile_type
name
email 
telephone_number 
tax_reference_number 
date_of_birth 
unit_number 
address_line1 
address_line2 
address_line3 
city 
state
postal_code 
country_code
line_of_business 
relationship_to_customer

Account information

Field nameACH
type 
asset_type_id 
account_number 
routing_number 
swift_bic 
institution_name 
unit_number 
address_line1 
address_line2 
address_line3 
city 
state 
postal_code 
country_code 

🇨🇦 Canada - FIAT_CA

General

Field nameSWIFTEFT
customer_id
counterparty_type
(FIAT_CA)

(FIAT_CA)
supported_rails
(SWIFT)

(EFT)
description  

Profile

Field nameSWIFTEFT
profile_type
name
email  
telephone_number  
tax_reference_number  
date_of_birth  
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code
line_of_business  
relationship_to_customer

Account Information

Field nameSWIFTEFT
type  
asset_type_id  
account_number
institution_number 
transit_number 
swift_bic 
institution_name
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code

🇪🇺 Europe - FIAT_EU

General

Field nameSWIFTSEPA CT
customer_id
counterparty_type
(FIAT_EU)

(FIAT_EU)
supported_rails
(SWIFT)

(SEPA_CT)
description  

Profile

Field nameSWIFTSEPA CT
profile_type
name
email  
telephone_number  
tax_reference_number  
date_of_birth  
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code
line_of_business  
relationship_to_customer

Account Information

Field nameSWIFTSEPA CT
type  
asset_type_id  
account_number  
iban
swift_bic
institution_name
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code

🇬🇧 Great Britain (UK) - FIAT_GB

General

Field nameSWIFTFPSCHAPS
customer_id
counterparty_type
(FIAT_GB)

(FIAT_GB)

(FIAT_GB)
supported_rails
(SWIFT)

(FPS)

(CHAPS)
description   

Profile

Field nameSWIFTFPSCHAPS
profile_type
name
email   
telephone_number   
tax_reference_number   
date_of_birth   
unit_number   
address_line1
address_line2   
address_line3   
city
state
postal_code
country_code
line_of_business   
relationship_to_customer

Account Information

Field nameSWIFTFPSCHAPS
type   
asset_type_id   
account_number 
iban  
sort_code 
swift_bic  
institution_name
unit_number   
address_line1  
address_line2   
address_line3   
city  
state  
postal_code  
country_code  

🇮🇳 India - FIAT_IN

General

Field nameSWIFTIMPS
customer_id
counterparty_type
(FIAT_IN)

(FIAT_IN)
supported_rails
(SWIFT)

(IMPS)
description  

Profile

Field nameSWIFTIMPS
profile_type
name
email 
telephone_number 
tax_reference_number  
date_of_birth  
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code
line_of_business  
relationship_to_customer

Account Information

Field nameSWIFTIMPS
type  
asset_type_id  
account_number
swift_bic 
ifsc 
institution_name
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code

🇲🇽 Mexico - FIAT_MX

General

Field nameSPEISWIFT
customer_id
counterparty_type
(FIAT_MX)

(FIAT_MX)
supported_rails
(SPEI)

(SWIFT)
description  

Profile

Field nameSPEISWIFT
profile_type
name
email  
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code
line_of_business  
relationship_to_customer

Account Information

Field nameSPEISWIFT
type  
asset_type_id  
clabe
swift_bic 
institution_name
unit_number  
address_line1 
address_line2  
address_line3  
city 
state
postal_code 
country_code

🇦🇪 United Arab Emirates - FIAT_AE

General

Field nameUAEFTSSWIFT
customer_id
counterparty_type
(FIAT_AE)

(FIAT_AE)
supported_rails
(UAEFTS)

(SWIFT)
description  

Profile

Field nameUAEFTSSWIFT
profile_type
name
email  
unit_number  
address_line1
address_line2  
address_line3  
city
state
postal_code
country_code
line_of_business  
relationship_to_customer

Account Information

Field nameUAEFTSSWIFT
type  
asset_type_id  
iban
swift_bic
institution_name 
unit_number  
address_line1 
address_line2  
address_line3  
city 
state 
postal_code 
country_code 

🌐 Crypto

General

Field nameCRYPTO
customer_id
counterparty_type
(CRYPTO)
supported_rails
(CRYPTO)
description 

Profile

Field nameCRYPTO
profile_type
name
email 
unit_number 
address_line1 
address_line2 
address_line3 
city 
state 
postal_code 
country_code
line_of_business 
relationship_to_customer

Wallet information

Note

Mandatory if wallet_type = INSTITUTION

Field nameCRYPTO
wallet_type 
asset_type_id
blockchain_address
institution_name *
unit_number 
address_line1 *
address_line2 
address_line3 
city *
state *
postal_code *
country_code *

🌎 BASIC

External Account/Wallet

Used for payments where the source is an external account/wallet. Cannot be used for withdrawals/outbound payments.

General

Field nameRequired
customer_id
counterparty_type
(BASIC)
supported_rails 
description 

Profile

Field nameRequired
profile_type
name
email 
telephone_number 
tax_reference_number 
date_of_birth 
unit_number 
address_line1 
address_line2 
address_line3 
city 
state
postal_code 
country_code
line_of_business 
relationship_to_customer

🌎 Account Number Jurisdictions

Jurisdictions

🌎 FIAT_ACCNO, 🇭🇰 FIAT_HK (Hong Kong), 🇸🇬 FIAT_SG (Singapore), 🇨🇳 FIAT_CN (China), 🇵🇦 FIAT_PA, (Panama), 🇲🇾 FIAT_MY (Malaysia), 🇯🇵 FIAT_JP (Japan), 🇧🇸 FIAT_BS (Bahamas)

General

Field nameSWIFT
customer_id
counterparty_type
supported_rails
(SWIFT)
description 

Profile

Field nameSWIFT
profile_type
name
email 
telephone_number 
tax_reference_number 
date_of_birth 
unit_number 
address_line1
address_line2 
address_line3 
city
state
postal_code
country_code
line_of_business 
relationship_to_customer

Account Information

Field nameSWIFT
type 
asset_type_id 
account_number
swift_bic
institution_name
unit_number 
address_line1
address_line2 
address_line3 
city
state
postal_code
country_code

🌎 IBAN Jurisdictions

Jurisdictions

🌍 FIAT_IBAN, 🇲🇽 FIAT_AE (United Arab Emirates), 🇨🇭 FIAT_CH (Switzerland), 🇧🇷 FIAT_BR (Brazil), 🇸🇦 FIAT_SA (Saudi Arabia), 🇪🇬 FIAT_EG (Egypt), 🇬🇹 FIAT_GT (Guatamala), 🇶🇦 FIAT_QA (Qatar), 🇧🇭 FIAT_BH (Bahrain), 🇨🇷 FIAT_CR (Costa Rica), 🇹🇷 FIAT_TR (Turkey), 🇬🇱 FIAT_GL (Greenland), 🇵🇱 FIAT_PL (Poland)

General

Field nameSWIFT
customer_id
counterparty_type
supported_rails
(SWIFT)
description 

Profile

Field nameSWIFT
profile_type
name
email 
telephone_number 
tax_reference_number 
date_of_birth 
unit_number 
address_line1
address_line2 
address_line3 
city
state
postal_code
country_code
line_of_business 
relationship_to_customer

Account Information

Field nameSWIFT
type 
asset_type_id 
iban
swift_bic
institution_name
unit_number 
address_line1
address_line2 
address_line3 
city
state
postal_code
country_code

🏦 Intermediary Institution Information (Swift)

Intermediary Institution Information

If you wish a counterparty with the Swift rail to receive funds via an intermediary institution you must include the intermediary_information block. This block is optional, however if you do provide intermediary information the mandatory fields for that block is as follows.

Field nameSWIFT
institution_type
swift_bic
institution_name
unit_number 
address_line1 
address_line2 
address_line3 
city 
state 
postal_code 
country_code 

Validation Rules

All fields

  • No leading or trailing spaces - values with preceding or trailing spaces will be trimmed to remove spaces.
  • No language quirks - values containing letters with language accents (e.g. à) will result in an error.
  • Limited special character support - only certain special characters are valid. Values with unsupported special characters (e.g. =) will result in an error.
Valid special characters

Valid special characters - .,’&-()@[space]#/:+

Field specific

General

Field nameValidation rules
customer_id 
counterparty_typeValid enum
supported_rails 
description 

Profile

Field nameValidation rules
profile_typeValid enum
name 
emailValid email
telephone_numberE.164 format -> +[country code][subscriber phone number]
tax_reference_number 
date_of_birth 
unit_number 
address_line1Length <= 35
address_line2Length <= 35
address_line3 
cityLength <= 21
stateIF US -> ISO_3166-2:US
postal_codeIF US -> Length = 5 OR Length = 5-4
country_codeISO 3166-2
line_of_businessValid enum
relationship_to_customerValid enum

Account Information

Field nameValidation rules
typeValid enum
asset_type_idValid enum
account_number 
clabe 
iban 
routing_numberNumbers only; Length = 9
institution_number 
transit_number 
swift_bicLength = 8 OR Length = 11; ISO 9362
institution_nameLength <= 35
unit_number 
address_line1Length <= 35
address_line2Length <= 35
address_line3 
cityLength <= 21
stateIF US -> ISO_3166-2:US
postal_codeIF US -> Length = 5 OR Length = 5-4
country_codeISO 3166-2

Wallet information

Field nameValidation rules
wallet_typeValid enum
asset_type_idValid enum
blockchain_address 
institution_nameLength <= 35
unit_number 
address_line1Length <= 35
address_line2Length <= 35
address_line3 
cityLength <= 21
stateIF US -> ISO_3166-2:US
postal_codeIF US -> Length = 5 OR Length = 5-4
country_codeISO 3166-2