Send VOP requests

To send a VOP request, send the information about the payee you want to verify:

POST /payee_verification_request

{
  "scheme": "vop",
  "payee_identification_type": "name",
  "payee_identification": "Jean Dupont",
  "payee_account_number": "FR5012739000308682265435N36"
}

POST /payee_verification_request

{
  "scheme": "vop",
  "payee_identification_type": "eu_vat",
  "payee_identification": "FR56355877394",
  "payee_account_number": "FR5012739000308682265435N36"
}

Upon receiving your API request, Numeral will:

Lookup the PSP holding the payee's account (the responding PSP)
Send the request to the responding PSP
Return the result as a response to your API request

{
  "object": "payee_verification_request",
  "id": "c52abc4b-9e88-4c19-8972-cfe428341ef2",
  "status": "completed",
  "direction": "outgoing",
  "scheme": "vop",
  "request": {
    "payee_type": null,
    "payee_identification_type": "name",
    "payee_identification": "Jean Dupont",
    "payee_account": "FR5012739000308682265435N36",
    "additional_information": null,
    "requesting_agent": "BANKFRPPXXX",
    "responding_agent": "BANKITPPXXX"
  },
  "matching_result": "match",
  "payee_suggested_name": null,
  "matching_details": null,
  "scheme_data": {
    "scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
    "request_timestamp": "2025-01-26T13:51:10Z",
    "response_timestamp": "2025-01-26T13:51:15Z",
  },
  "created_at": "2025-01-01T12:00:00Z"
}

{
  "object": "payee_verification_request",
  "id": "c39d1eff-c5ed-4197-8f24-28a68bd0eee6",
  "status": "completed",
  "direction": "outgoing",
  "scheme": "vop",
  "request": {
    "payee_type": null,
    "payee_identification_type": "name",
    "payee_identification": "Jean Dupont",
    "payee_account": "FR5012739000308682265435N36",
    "additional_information": null,
    "requesting_agent": "BANKFRPPXXX",
    "responding_agent": "BANKITPPXXX"
  },
  "matching_result": "close_match",
  "payee_suggested_name": "Jean Dupond",
  "matching_details": null,
  "scheme_data": {
    "scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
    "request_timestamp": "2025-01-26T13:51:10Z",
    "response_timestamp": "2025-01-26T13:51:15Z",
  },
  "created_at": "2025-01-01T12:00:00Z"
}

{
  "object": "payee_verification_request",
  "id": "d6560dcb-e0c9-414d-bd65-6cf54a5338f5",
  "status": "completed",
  "direction": "outgoing",
  "scheme": "vop",
  "request": {
    "payee_type": null,
    "payee_identification_type": "name",
    "payee_identification": "Jean Dupont",
    "payee_account": "FR5012739000308682265435N36",
    "additional_information": null,
    "requesting_agent": "BANKFRPPXXX",
    "responding_agent": "BANKITPPXXX"
  },
  "matching_result": "no_match",
  "payee_suggested_name": null,
  "matching_details": null,
  "scheme_data": {
    "scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
    "request_timestamp": "2025-01-26T13:51:10Z",
    "response_timestamp": "2025-01-26T13:51:15Z",
  },
  "created_at": "2025-01-01T12:00:00Z"
}

{
  "object": "payee_verification_request",
  "id": "8c209eda-a473-46df-b83c-b14238337bad",
  "status": "completed",
  "direction": "outgoing",
  "scheme": "vop",
  "request": {
    "payee_type": null,
    "payee_identification_type": "name",
    "payee_identification": "Jean Dupont",
    "payee_account": "FR5012739000308682265435N36",
    "additional_information": null,
    "requesting_agent": "BANKFRPPXXX",
    "responding_agent": "BANKITPPXXX"
  },
  "matching_result": "impossible_match",
  "payee_suggested_name": null,
  "matching_details": null,
  "scheme_data": {
    "scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
    "request_timestamp": "2025-01-26T13:51:10Z",
    "response_timestamp": "2025-01-26T13:51:15Z",
  },
  "created_at": "2025-01-01T12:00:00Z"
}

ℹ️
VOP can be tested in sandbox using test data.