Payees are external bank accounts to which payments can made from Fiat Accounts. Different types of payments can be made to the same Payee depending on the bank details provided for the Payee at the time of creation.
Payee Object
| Attribute | Description | Format/Enum |
|---|---|---|
| id string | Unique identifier of the Payee. | e.g. pye_ejl2vpn1md315rxko6 |
| owner.type string | Owner of the Payee. | MEMBER, END_USER |
| owner.id string | Unique identifier of the owner of the Payee. | e.g. eus_j82rl497g47g5ykvzn , mbr_emv4j231821oaz56yx |
| type string | Type of Payee. | PERSON or BUSINESS |
| name string | Full name of the Payee. | Payee name can only have alphanumerics plus full stop, hyphen, slash or ampersandRegex: ^[ a-zA-Z0-9.'\-/&]+$ |
| currency string | Currency in which the Payee's bank account is held. | Three-letter ISO 4217 code e.g. GBP, EUR , USD |
| address.line1 string | First line of Payee's home address. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| address.line2 string | Second line of the Payee's home address. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| address.city string | City | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,]*$ |
| address.state string | Region or state | Space and hyphen are allowed between the characters. Max length 35 Regex: ^[a-zA-Z0-9 .'\-/,)(+]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(+]*$ |
| address.postalCode string | Postal/Zip code | The format and presence of this field may vary depending on the country. Space and hyphen are allowed between the characters. Please trim spaces at the end Validation regex: - for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9][a-zA-Z]{2}$- for Estonia: ^\d{5}$- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$- others: ^[a-zA-Z\d][a-zA-Z\s\d\-]{1,8}[a-zA-Z\d]$ |
| address.country string | Payee's address country. | The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
| paymentSchemes array of strings | Payment schemes that can be used to make a Payment to the Payee. | FPS, CHAPS, SCT |
| bankDetails.accountHolderName string | Name of the account holder. | have only alphanumerics [a-zA-Z0-9], hyphens, full stops, apostrophes, slash and ampersands |
| bankDetails.bankName string | Name of the beneficiary's bank. | Name of the beneficiary's bank. |
| bankDetails.iban string | IBAN of the Payee's bank account. Depending on the currency and country, account will typically have at least an IBAN or an accountNumber. | An international bank account number for secure cross-border transactions.International Bank Account Number |
| bankDetails.bic string | BIC of the Payee's bank account. | A unique alphanumeric code that is a bank identification code used globally. |
| bankDetails.accountNumber string | Account Number of the Payee's bank account. Depending on the currency and country, account will typically have at least an IBAN or an accountNumber. | International Bank Account Number. |
| bankDetails.routingCodes object | One or more routing codes associated with the Payee's bank account. Typically used in conjunction with the account number. | For USD, the ABA code of the Sending Bank's US Correspondent is required. Please contact the sending bank if this ABA code isn't immediately available. |
| bankDetails.routingCodes.type string | Type of the routing code. | e.g. ABA |
| bankDetails.routingCodes.value string | Value of the routing code. | e.g. 022000020 |
| bankDetails.bankAddressLine1 string | Address line 1 of the beneficiary's bank. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| bankDetails.bankAddressCity string | City of the beneficiary's bank. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,]*$ |
| bankDetails.bankAddressPostalCode string | Postal code of the beneficiary's bank. | The format and presence of this field may vary depending on the country. Space and hyphen are allowed between the characters. Please trim spaces at the end Validation regex: - for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9][a-zA-Z]{2}$- for Estonia: ^\d{5}$- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$- others: ^[a-zA-Z\d][a-zA-Z\s\d\-]{1,8}[a-zA-Z\d]$ |
| bankDetails.bankCountry string | Payee's Bank address country. | The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
| bankDetails.bankAddressCountry string | Payee's Bank address country. | The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
| bankDetails.intermediaryBicSwift string | SWIFT BIC of the intermediary bank. | |
| bankDetails.intermediaryBankName string | Name of the intermediary bank. | |
| bankDetails.intermediaryBankAddressLine1 string | Address line 1 of the intermediary bank. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| bankDetails.intermediaryBankAddressCity string | City of the intermediary bank. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,]*$ |
| bankDetails.intermediaryBankAddressPostalCode string | Postal code of the intermediary bank. | The format and presence of this field may vary depending on the country. Space and hyphen are allowed between the characters. Please trim spaces at the end Validation regex: - for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9][a-zA-Z]{2}$- for Estonia: ^\d{5}$- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$- others: ^[a-zA-Z\d][a-zA-Z\s\d\-]{1,8}[a-zA-Z\d]$ |
| bankDetails.intermediaryBankAddressCountry string | Country of the intermediary bank. | The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
| additionalDetails object | Object containing additional details on the Payee which will depend on bank and payment scheme requirements. | |
| additionalDetails.dob date | Date of birth of the Payee. | YYYY-MM-DD format e.g. 1975-04-05 |
| createdAt integer | Epoch timestamp at which the object was created. | e.g. 1637593856104 |
| updatedAt integer | Epoch timestamp at which the object was last updated. | e.g. 1637593856104 |
| metadata array of strings | Additional data in JSON key:value format | See Metadata for more information. |
| status string | Status of the Payee. | CREATED,PROCESSING,AWAITING_APPROVAL, REJECTED, ACTIVE or DELETED |