A counterparty account is the bank account of a counterparty. It includes the account details required to send payments to or collect payments from this counterparty. Counterparty accounts can be used for payment orders, direct debit mandates, and account verifications.
Attribute | Description |
---|---|
id string | The counterparty account ID. |
object string | Always counterparty_account . |
name string | The counterparty account name. |
counterparty_id string | The ID of the related counterparty. |
holder_name string | The name of the company or individual holding the account. |
holder_address string | The account holder address. See address object. |
account_number string | The account number or IBAN. If an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder. |
bank_code string | The BIC / Swift code or sort code, depending on the country and bank. Only upper case letters allowed. |
status string | The status of the counterparty account. See Counterparty account lifecycle for a comprehensive list of counterparty account statuses. |
status_details string | The reason for denying the counterparty account. |
account_verification object | The account verification results. See Account verification. |
metadata object | Additional data in JSON key:value format. See Metadata. |
custom_fields object | Custom fields in JSON key:value format. See Custom fields. |
disabled_at datetime | The counterparty account disabling UTC timestamp. |
created_at datetime | The counterparty account creation UTC timestamp. |
Below is an example of a counterparty account:
{
"id": "b38f5318-a389-4278-9cbe-d16116750982",
"object": "counterparty_account",
"name": "PartnerCo EUR account",
"counterparty_id": "c3fd9ee4-2aab-11ed-a261-0242ac120002",
"holder_name": "PartnerCo",
"holder_address": {
"line_1": "1, rue de la Bourse",
"line_2": "",
"postal_code": "59000",
"city": "Lille",
"region_state": "",
"country": "FR"
},
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"status": "pending_approval",
"status_details": "",
"account_verification": {
"result": "verified",
"active_account": {
"result": "valid",
"details": {
"reason": "",
"message":""
}
},
"valid_account_number": {
"result": "valid",
"details": {
"reason": "",
"message":""
}
},
"matching_account_number_and_bank_code": {
"result": "valid",
"details": {
"reason": "",
"message":" ",
"expected_value":""
}
},
"matching_account_holder": {
"result": "valid",
"details": {
"reason": "",
"message":"",
"expected_value":""
}
},
"created_at": "2024-01-03T11:53:19.734182Z",
},
"metadata": {},
"custom_fields": {},
"disabled_at": null,
"created_at": "2024-01-03T09:53:19.734182Z"
}