VOP Verification of Payee Responder Service
POST /api/vop/v1/payee-verificationsThe API allows to Verify the payee Name or ID details.
Request Parameters
Header
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | The Requesting PSP’s reference number of the VOP Request |
| X-RequestTimestamp | ISODateTime | Mandatory | Time Stamp of the VOP Request. |
Request Body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| party | Party Type | Mandatory | Provide information about the identification of the Payee |
| partyAccount | Account Type | Mandatory | Provide information about the Account of the Payee |
| partyAgent | Agent Type | Mandatory | Identification of the RespondingPSP |
| unstructuredRemittanceInformation | Array of Max140 | Optional | Additional information about ATC001 sent by the Requester Usage Rule : only one entry may be used |
| requestingAgent | Agent Type | Mandatory | Identification of the Requesting PSP |
Response Parameters:
Header
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | The Requesting PSP’s reference number of the VOP Request |
| X-ResponseTimestamp | ISODateTime | Mandatory | Time Stamp of the VOP Response |
Response body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| partyNameMatch | Party Name Match Code | Conditional | Matching result can be Match (MTCH), No Match (NMTC), Close Match (CMTC) with the Name of the Payment Counterparty, Verification Not Possible (NOAP) |
| partyIdMatch | Party Identification Match Code | Conditional | Matching result can be Match (MTCH), No Match (NMTC) , Verification Not Possible (NOAP) |
| matchedName | Max140Text | Conditional | Name of the Payment Counterparty as reported by Responding PSP in the relevant character set. It is up to the Requesting PSP to decide how to display it to the PSU. This information must be provided if and only if mandatory for “Close Match” (CMTC) result for the partyNameMatch |
Party Name Match Code
| Code | Description |
|---|---|
| MTCH | Match |
| NMTC | No Match |
| CMTC | Close Match The provided “payee” name closely resemble the account holder name |
| NOAP | Verification Check Not Possible / Validation Check is not applicable |
Party Identification Match Code
- In the case of a request based on ID there will not be a “Close Match”.
| Code | Description |
|---|---|
| MTCH | Match |
| NMTC | No Match |
| NOAP | Identification code not supported/known by the Responding / Verification Check Not Possible/ Validation Check is not applicable |
Response codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 415 | Unsupported Media Type |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
Example 1: VOP Request for a Name + IBAN
Request:
POST /api/vop/v1/payee-verifications
Host: api.example.com
Content-Type: application/json
Accept: application/json
User-Agent: MyApp/1.0
Content-Length: 312
Date: Mon,
27 Dec 2024 15: 19: 21 GMT
X-Request-ID: 123e4567-e89b-12d3-a456-426614174000
X-Request-Timestamp: 2024-12-27T15: 19: 21.123Z
{
"party": {
"name": "Marko Litner"
},
"partyAccount": {
"iban": "AT632060484574769537"
},
"partyAgent": {
"financialInstitutionId": {
"bicfi": "BFICAT00 "
}
},
"requestingAgent": {
"financialInstitutionId": {
"bicfi": "BFICAT00"
}
}
}Response:
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-ID: 123e4567-e89b-12d3-a456-426614174000
X-Response-Timestamp: 2024-12-27T15: 19: 22.678Z
Content-Length: 72
{
"partyNameMatch": "CMTC",
"matchedName": "Marko Leitner"
}Example 2: Example of a VOP Request for an ID + IBAN
Request:
POST /api/v1/payee-verification
Host: api.example.com
Content-Type: application/json
Accept: application/json
User-Agent: MyApp/1.0
Date: Mon,
27 Dec 2024 15: 19: 21 GMT
Content-Length: 492
X-Request-ID: 123e4567-e89b-12d3-a456-426614174000
X-Request-Timestamp: 2024-12-27T15: 19: 21.123Z
{
"party": {
"identification": {
"organisationId": {
"lei": "KIKR00ZODTTCJD42HU61"
}
},
"partyAccount": {
"iban": "PT29003506519994659248615"
},
"partyAgent": {
"financialInstitutionId": {
"bicfi": "BFCIPT00 "
}
},
"requestingAgent": {
"financialInstitutionId": {
"bicfi": "BFCIPT12"
}
}
}
}Response:
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-ID: 123e4567-e89b-12d3-a456-426614174000
X-Response-Timestamp: 2024-08-12T15: 19: 22.678Z
Content-Length: 37
{
"partyIdMatch": "MTCH"
}