Genome Documentation
Verification of Payee API
Verification of Payee API
Overview
Genome provides customers with functionality (VoP) that allows them to verify the SEPA payments recipients’ details before their processing.
| Web Service | URL |
|---|---|
| Live Genome Payout API Service | https://api.genome.eu/api/mp/payee/verification |
Verification of Payee request format
- JSON-request
To use JSON type a request header should contain “Content-Type: application/json”, request content should be transmitted as a json-object
Parameters:
| Parameter name | Required | Format and rule | Description |
|---|---|---|---|
| merchant_account | Yes | string (6-32) | Merchant account |
| merchant_password | Yes | string (6-32) | Account password |
| payee_type | Yes | enum ('PERSONAL', 'LEGAL') | LEGAL if receiver is legal entity PERSONAL if receiver is physical person |
| payee_account_number | Yes | string (max-32) | Receiver SEPA BIC number |
| payee_name | Optional | string (max-140) | Receiver’s first and last names *cannot be used at the same time with: payee_company_code payee_company_bic payee_identification |
| payee_company_code | Optional | string (20) | Legal Entity Identifier alpha-numeric code based on the ISO 17442 "Financial services — Legal entity identifier (LEI)" |
| payee_company_bic | Optional | string | SEPA BIC number |
| payee_identification | Optional | string | Unique and unambiguous identification of an organisation. Used if the following parameters are absent: payee_name payee_company_code payee_company_bic |
| payee_scheme_name_code | Optional | enum ('BANK', 'CBID', 'CHID', 'CINC', 'COID', 'CUST', 'DUNS', 'EMPL', 'GS1G', 'SREN', 'SRET', 'TXID', 'BDID', 'BOID') | ISO with payee_identification based on ISO 20022 External Code Set ExternalOrganisationIdentification1Code |
| payee_scheme_name_proprietary | Optional | string | A scheme name is defined in a proprietary way. *cannot be used at the same time with payee_scheme_name_code |
| payee_issuer | Conditional | string | Issuer of the identification. Mandatory only if payee_scheme_name_proprietary is present |
Sample code of the AUTH request in "application/json" format:
{ "merchant_account": "Test_Test", "merchant_password": "12345qzqz", "payee_type": "PERSONAL", "payee_account_number": "DE52100400000371301300", "payee_bank_code": "TALMITM0", "payee_name": "Bayersiche Motoren Werke"}| Parameter name | Format and rule | Description |
|---|---|---|
| id | string | ID of verification check |
| scheme | string Possible values: vop | Scheme name |
| status | enum ('completed', 'error') | Status of the verification request |
| session_id | string (36) | Unique session Id of the request |
| timestamp | integer unix timestamp | Payout API response time |
| code | integer (1-4) | Response code of the request |
| message | string (6-255) | Response message of the request |
| matching_result | string Possible values: match, close match, no match, no applicable | match - payee Name or ID and IBAN matches, it is safe to make a payment close match - Close Match - payer should use the name provided in the payee_suggested_name parameter and IBAN which was used in the VoP request in the payment no match - No Match - it is recommended to not sent the payment to the payee which details did not match no applicable - Verification not possible - VoP request cannot be processed at the time, payer needs to initiate VoP request once more before sending the payment. |
| payee_suggested_name | string (max-140) | Possible in Close Match case The provided "payee" name is the account holder name |
| request | Contains payload with data from the request: "request": {"payee_type": "PERSONAL", "payee_account_number": "DE52100400000371301300", "payee_bank_code": "TALMITM0","payee_name": "Bayersiche Motoren Werke","payee_company_code": null, "payee_company_bic": null, "payee_identification": null, "payee_scheme_name_code": null, "payee_scheme_name_proprietary": null, "payee_issuer": null } |
Sample code of the AUTH response in "application/json" format:
{ "id": 402, "scheme": "vop", "status": "completed", "session_id": "weps-OHoBmWElpXgew4K/9/Vy", "timestamp": 1758271481, "code": 0, "message": "Request processed successfully", "matching_result": "match", "payee_suggested_name": null, "request": { "payee_type": "PERSONAL", "payee_account_number": "DE52100400000371301300", "payee_bank_code": "TALMITM0", "payee_name": "Bayersiche Motoren Werke", "payee_company_code": null, "payee_company_bic": null, "payee_identification": null, "payee_scheme_name_code": null, "payee_scheme_name_proprietary": null, "payee_issuer": null }}Status codes you can find here