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

AttributeDescriptionFormat/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
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
address.line2
string		Second line of the Payee's home address.Space and hyphen are allowed between the characters.
Max length 50
address.city
string		CitySpace and hyphen are allowed between the characters.
Max length 50
address.state
string		Region or stateSpace and hyphen are allowed between the characters.
Max length 35
address.postalCode
string		Postal/Zip codeThe 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
e.g. 67999, 30-555, SW1A 1AA
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.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.
bankDetails.routingCodes
object		One or more routing codes associated with the Payee's bank account. Typically used in conjunction with the account number.
bankDetails.routingCodes.type
string		Type of the routing code.SORT_CODE
bankDetails.routingCodes.value
string		Value of the routing code.
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 formatSee Metadata for more information.
status
string		Status of the Payee.CREATED,PROCESSING,REJECTED, ACTIVE or DELETED