POST/vopgateway/v1/bulk
Bulk Request API Specification
This chapter contains information on the header, request, and response body required to make a successful bulk request with the EPC compliant API for Banks. You can read about the error status and codes here.
Document History
Version | Date | Description |
---|---|---|
1.0 | 15 Jan 2025 | Original Digital Version. Aligned with PDF V1.0 |
1.1 | 14 Feb 2025 | Updated format of lei number & Bicfi format as per the EPC |
1.2 | 20 Feb 2025 | Updated Language in request header from ISO639 to ISO639-1, Updated unstructuredRemittanceInformation from String to Array of Strings . |
2.0 | 20 Mar 2025 | Format changes, aligned with VoP single check API. Refer to the detailed changes here. |
2.1 | 16 Apr 2025 | Updated request structure to align the fields to their expected level and added the following new headers: X-End-User, X-Software-Supplier and X-Channel |
2.2 | 15 May 2025 | Added usage rules to unstructuredRemittanceInformation and organisation.others. Added format to unstructuredRemittanceInformation. Corrected the X-Request-Id example with valid RFC4122 value. |
2.3 | 16 Jun 2025 | Updated description of EMPL from "employee" to "employer" under schemeNameCode. |
Request
Request Body
Two combinations are supported as VOP requests (A) Name + IBAN and (B) Identifier Code + IBAN. In case of Natural Person, only combination (A) is possible. The body of the request is a file in NDJSON format, applying the following data model for each record in the file. The client should stream the NDJSON file.
uetr
StringMandatoryparty
ObjectMandatorypartyAccount
ObjectMandatoryunstructuredRemittanceInformation
Array of StringsOptionalpartyAgent
ObjectConditionalrequestingAgent
ObjectMandatory
Request
POST
/vopgateway/v1/bulk{"uetr":"13b8472f-d796-436a-ba76-0be4ec234206","party":{"name":"Henri Groenen"},"partyAccount":{"iban":"NL11RABO1234567890"},"unstructuredRemittanceInformation":["1234512345"],"partyAgent":{"financialInstitutionId":{"bicfi":"ABCDBEBBXXX"}},"requestingAgent":{"financialInstitutionId":{"bicfi":"ABCDBEBBXXX"}}}
Response
The response is the taskId of the bulk request.
- Successful response (HTTP 200 - described below)
- Error response (HTTPXXX - described in Errors)
Response Body
taskId
StringMandatory
Response
{
"taskId": "12930484-129284501-ecernb"
}
List of Enumeration Values
schemeNameCode
The following table contain a list of enumeration values:
Enumeration value | Description | Format | Example |
---|---|---|---|
BANK | Bank Party Identification request. A unique and unambiguous assignment made by a specific bank or financial institution to identify a relationship between the bank and its client. | Format: [CountryCode][BankCode][BranchCode] | Example: 'US123BANK001' |
CBID | Central Bank Identification Number request. A unique identification number assigned by a central bank to identify an organization. | Format: (CB)[0-9]{9,12} | Example: 'CB123456789' |
CHID | Clearing Identification Number request. A unique identification number assigned by a clearing house to identify an organization. | Format: [A-Z]{2,4}[0-9]{4,6} | Example: 'CHCLRG1234' |
CINC | Certificate of Incorporation Number request. A unique identification number assigned by a designated authority to a certificate of incorporation, used to identify an organization. | Format: (INC)[0-9]{7,10} | Example: 'INC1234567' |
COID | Country Identification Code request. An identification code assigned by the country authority to identify an organization (e.g., corporate registration number). | Format: [A-Z]{2}[0-9]{8,10} | Example: 'US123456789' |
CUST | Customer Number request. A number assigned by an issuer to identify a customer or by a party to identify a creditor or debtor relationship. | Format: (CUST)[0-9]{6,8} | Example: 'CUST789456' |
DUNS | Data Universal Numbering System request. A unique identification number provided by Dun & Bradstreet to identify an organization. | Format: [0-9]{9} | Example: '123456789' |
EMPL | Employer Identification Number request. Number assigned by a registration authority to an employer. | Format: (EMP)[0-9]{6,8} | Example: 'EMP123456' |
GS1G | GS1 GLN (Global Location Number) Identifier request. A non-significant reference number used to identify legal, functional, or physical entities according to GS1 numbering scheme rules. | Format: [0-9]{13,14} | Example: 'GLN1234567890123' |
SREN | The unique French business identification number assigned by INSEE, the French National Institute for Statistics and Economic Studies. | Format: [0-9]{9} | Example: '123456789' |
SRET | Number providing information about the business location in France. The registration number contains an extra 5 digits (added to the end of the SIREN number to form the full SIRET number). | Format: [0-9]{14} | Example: '12345678900001' |
TXID | Tax Identification Number request. | Format: (TX)[0-9]{8,12} | Example: 'TX123456789' |
BDID | Business Domain Identifier request. An identifier representing the business domain in which the organization operates. | Format: (BUSDOM)[0-9]{5,10} | Example: 'BUSDOM12345' |
BOID | Business Other Identification request. Other identification for the organization. | Format: Not specified | Example: Not Applicable |