--- updatedAt: 2026-03-02T12:45:02.000Z agentTools: projectIndex: https://docs.fiatrepublic.com/llms.txt --- # The Payee Object 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 ampersand` Regex: `^[ a-zA-Z0-9.'\-/&]+$`
currency _string_	Currency in which the Payee's bank account is held.	Three-letter [ISO 4217 code](https://en.wikipedia.org/wiki/ISO_4217) 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 *Required for Payees with address in CA and US	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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 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`, `EAGLE_NET_TRANSFER`, `BACS`, `SWIFT`,`DE`, `NPP`, `ACH`, `ACH_SAME_DAY`, `WIRE`, `INTERNATIONAL_WIRE`
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](https://en.wikipedia.org/wiki/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.	`ABA`, `SORT_CODE`, `WIRE`, `NCC`, `BSB`
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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 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](https://docs.fiatrepublic.com/docs/metadata) for more information.
status _string_	Status of the Payee.	`CREATED`,`PROCESSING`,`AWAITING_APPROVAL`, `REJECTED`, `ACTIVE` or `DELETED`