Payers are external bank accounts from which payments have been received into Fiat Accounts. These are automatically created whenever a payment is received from a new Payer. The details available in the Payer object will depend on the underlying scheme and banking provider but will usually contain at least the name and bank details of the payer.
Payer Object
| Attribute | Description | Format/Enum |
|---|---|---|
| id string | Unique identifier of the Payer. | e.g. pyr_jl2vpn1mdd315rxko6 |
| owner.type string | Owner of the Payer. | MEMBER, END_USER |
| owner.id string | Unique identifier of the owner of the Payer. | e.g. eus_j82rl497g47g5ykvzn , mbr_emv4j231821oaz56yx |
| type string | Type of Payer. | PERSON or BUSINESS |
| name string | Full name of the Payer. | |
| bankDetails.iban string | IBAN of the Payer's bank account. | |
| bankDetails.bic string | BIC of the Payer's bank account. | |
| bankDetails.accountNumber string | Account Number of the Payer's bank account. | |
| bankDetails.routingCodes object | One or more routing codes associated with the Payer'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. | |
| bankDetails.bankCountry string | Country of the Payer's bank account | Two-letter ISO 3166-1 alpha-2 country code e.g. GB |
| additionalDetails object | Object containing additional details on the Payer which might be available from the sending bank. | |
| additionalDetails.address string | Unstructured address of the Payer, if available from the sending bank. | |
| additionalDetails.addressLine1 string | Address Lines 1 of the Payer, if available from the sending bank. | |
| additionalDetails.addressLine2 string | Address Line 2 of the Payer, if available from the sending bank. | |
| additionalDetails.addressCity string | City of the Payer, if available from the sending bank. | |
| additionalDetails.addressState string | State of the Payer, if available from the sending bank. | |
| additionalDetails.addressPostalCode string | Postal/Zip code of the Payer, if available from the sending bank. | |
| additionalDetails.addressCountry string | Country of the Payer, if available from the sending bank. | Two-letter ISO 3166-1 alpha-2 country code e.g. GB |
| 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. |