Learn how to send and respond to payee verification requests with Mambu Payments (formerly Numeral)
Attribute | Description |
---|---|
| Always |
| The ID of the payee verification request. |
| The status of the payee verification request. See Payee verification request lifecycle for more details. |
| Failure code in case of failed request. One of:
Failure codes and status details for more details. |
| Status details in case of failed request. See Failure codes and status details for more details. |
| The direction of the request. Can be |
| The payee verification scheme used. Only |
| An object containing key information about the request. |
| The type of identification used in the request. See Get supported identification types for a payee account for more information. |
| The identification of the payee. |
| The account number of the payee. |
| Additional information about the payee. |
| The BIC of the agent which sent the request. |
| The BIC of the agent at which the request is aimed, i.e. the agent of the payee. |
| The result of the verification. Can be |
| In case of |
| Details of the request processing in case |
| Payee identification after data cleaning (removing double spaces, honorific titles, etc.) |
| Payee identification retrieved in your account database (in Mambu Payments (formerly Numeral) or in your systems), using |
| If your account database is held in Mambu Payments (formerly Numeral) using internal accounts, the ID of the internal account matching |
| The score, from 0 to 100, of the matching algorithm configured for your entity when executed with |
| An object containing technical information about the request. |
| The unique ID of the request on the scheme. Different from |
| The timestamp of the creation of the request. |
| The timestamp of the answer to the request. |
| Additional data in JSON key:value format. See . |
| The UTC timestamp of the reception of the response to the request. Only available for outgoing requests. |
| The UTC timestamp of the creation of the VOP request. |
{
"object": "payee_verification_request",
"id": "c39d1eff-c5ed-4197-8f24-28a68bd0eee6",
"status": "completed",
"failure_code": "null",
"status_details": null,
"direction": "incoming",
"scheme": "vop",
"request": {
"payee_identification_type": "name",
"payee_identification": "Jean Dupont",
"payee_account_number": "FR5012739000308682265435N36",
"payee_additional_information": "Mr. Jean Dupont",
"requesting_agent_bank_code": "SOMEBICXXX",
"responding_agent_bank_code": "BANKITPPXXX"
},
"matching_result": "match",
"payee_suggested_name": null,
"matching_details": {
"cleaned_identification": "Jean Dupont",
"retrieved_identification": "Jean Dupont",
"internal_account_id": "e5cf0c31-c5fb-4e00-80fe-4338838d7493",
"matching_score": 100
},
"scheme_data": {
"scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
"request_timestamp": "2025-01-26T13:51:10Z",
"response_timestamp": "2025-01-26T13:51:15Z",
},
"metadata": {
"payment_reference": "123-ABC"
},
"created_at": "2025-02-12T01:34:24Z"
}
{
"object": "payee_verification_request",
"id": "2af40267-67b1-4140-9e67-2f65ff11655e",
"status": "completed",
"status_details": null,
"direction": "outgoing",
"scheme": "vop",
"request": {
"payee_identification_type": "name",
"payee_identification": "Jean Dupont",
"payee_account_number": "FR5012739000308682265435N36",
"payee_additional_information": "Mr. Jean Dupont",
"requesting_agent_bank_code": "SOMEBICXXX",
"responding_agent_bank_code": "BANKITPPXXX"
},
"matching_result": "match",
"payee_suggested_name": null,
"matching_details": null,
"scheme_data": {
"scheme_request_id": "76e64988-1d5e-4fd0-ad0a-142bb1f9b837",
"request_timestamp": "2025-01-26T13:51:10Z",
"response_timestamp": "2025-01-26T13:51:15Z",
},
"response_received_at": "2025-01-26T13:51:16Z",
"created_at": "2025-01-01T12:00:00Z"
}