...
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. Current date of not provided |
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 |
...
| Code Block |
|---|
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
| Code Block |
|---|
200:
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": "12"
}
} |