Verification of Payee (VoP) for SEPA EUR Payments
You can find more details here
The Verification object holds the details and result of a Verification of Payee (VoP) check performed on a Payee's bank account details.
Payee Verification Object
| Attribute | Description | Format/Enum |
|---|---|---|
| id string | Unique identifier of the Verification. | e.g. pvn_vkoep8y1d57rmnba1g |
| payeeId string | The identifier of the Payee this verification belongs to. | e.g. pye_ej12vpn1md315rxko6 |
| assignedToId string | The identifier of the Payment this verification was used for. Null until assigned. | e.g. pmt_abc123xyz456 |
| status string | The current status of the verification in its lifecycle. | PENDING_CUSTOMER_REVIEW, ACCEPTED, REJECTED, ASSIGNED, EXPIRED, FAILED |
| type string | The type of verification performed. | VERIFICATION_OF_PAYEE |
| matchResult object | An object containing the detailed results of the verification. | |
| matchResult.matchLevel string | The result level of the name matching process. | MATCH, CLOSE_MATCH, NO_MATCH, ERROR |
| matchResult.description string | Might only be populated is cases of mismatch | |
| matchResult.accountHolder string | The account holder name on record at the payee's bank, if available. Populated only for CLOSE_MATCH status | e.g. "John M. Doe" |
| accepted boolean | Represents the user's explicit decision on how to handle a verification that resulted in a CLOSE_MATCH or NO_MATCH. | true: The user accepts the potential risk of the mismatch and confirms their intent to proceed with the payment. This will transition the verification status to ACCEPTED.false: The user declines to proceed due to the mismatch. The verification will be marked as REJECTED, and it cannot be used for a payment. |
