Bulk Payment Initiation
- Michal Gregor
Bulk payments are used to initiate and authorize multiple individual payments at once (one bank SCA for multiple payments present in bulk).
The bulk payment process starts with creating the bulk payment resource.
Endpoint details (postman documentation): Create Bulk Payment
Request
POST {{everifin_api_url}}/v1/payments/bulk
HTTP headers
Initiation of a order must contain following headers.
Header | Type | Description |
|---|---|---|
Authorization | Bearer token | Authorization token to access API. |
Body
Field | Type | Optional | Description |
|---|---|---|---|
name | Free text, maximum 255 characters | no | Name of the bulk payment. |
dueDate | ISO 8601 datetime | yes | Date when the payment should be executed. |
senderIban | text, valid iban (max 50 chars) | no | IBAN of sender’s (your) bank account. |
redirectUrl | text (max 5000 chars) | no | Redirect URL back to your system. It must be string satisfying URL rules. E.g. hostname must contain at least one dot (for local development URL like this can be used: http://yourapp.local/xyz). |
externalId | Free text, maximum 255 characters | yes | Can be used to match the payment with data in your systems. |
payments | Array | no | Array of payment objects. Structure of the payment object is described below |
Payment object in bulk payment
Field | Type | Optional | Description |
|---|---|---|---|
amount | number (0.01 - 9999999999) | no | Amount of the payment. |
currency | text, valid currency (min/max 3 chars) | no | Currency of the payment. Must be a valid currency code, e.g. EUR, CZK, PLN. |
recipientIban | text, valid iban (max 50 chars) | no | IBAN account number where the money should be sent to. |
recipientName | text (max 140 chars) | no | Name of the payment recipient. This name will appear in your bank transaction as recipient of the money. |
recipientBankBic | text, valid BIC | yes | BIC of the recipient bank |
variableSymbol | numeric text (max 10 chars) | yes | Symbol for SK/CZ market. Cannot be combined with reference. |
constantSymbol | numeric text (max 4 chars) | yes | Symbol for SK/CZ market. Cannot be combined with reference. |
specificSymbol | numeric text (max 10 chars) | yes | Symbol for SK/CZ market. Cannot be combined with reference. |
reference | text (max 35 chars) | yes | Payment reference. Cannot be combined with symbols. |
paymentMessage | text (max 140 chars) | yes | Message to recipient. This message will be visible in bank transaction as description of the transfer. |
externalId | Free text, maximum 255 characters | yes | Can be used to match the payment with data in your systems. |
recipientAddress | Object | yes | Object holding information about recipient address. Fields:
|
recipientBankAddress | Object | yes | Object holding information about recipient bank address. Fields:
|
priority | Enum | yes | possible values:
|
Example request
POST {{everifin_api_url}}/api/v1/payments/bulk
{
"name": "bulk-payment",
"dueDate": "",
"senderIban": "{{account_iban}}",
"redirectUrl": "https://web.example",
"externalId": "ABC123",
"payments": [
{
"amount": 1.44,
"currency": "EUR",
"recipientIban": "{{recipient_iban}}",
"recipientName": "Test recipient 1",
"variableSymbol": "111",
"specificSymbol": "111",
"constantSymbol": "111",
"paymentMessage": "Everifin PSD2 Test Bulk 1/2"
},
{
"amount": 1.43,
"currency": "EUR",
"recipientIban": "{{recipient_iban}}",
"recipientName": "Test recipient 2",
"variableSymbol": "222",
"specificSymbol": "222",
"constantSymbol": "222",
"paymentMessage": "Everifin PSD2 Test Bulk 2/2"
}
]
}Response
ield | Type | Optional | Description |
|---|---|---|---|
id | number | no | Payment ID |
Example response
200:
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": "12"
}
}