This page describes endpoints to get bulk payment data.
Bulk Payment Detail
This endpoint returns details (status and other data) of specific bulk payment.
Postman documentation: Get Bulk Payment
Request
GET {{everifin_api_url}}/v1/payments/bulk/{{bulk_payment_id}}
HTTP headers
Initiation of the bulk payment must contain following headers.
Header | Type | Description |
|---|---|---|
Authorization | Bearer token | Authorization token to access API. |
Response
Response contains bulk payment object with following fields
Field | Type | Description |
|---|---|---|
id | number, unique | Bulk payment ID |
senderIban | text, valid iban (max 50 chars) | IBAN of sender’s (your) bank account. |
status | enum | Status of the payment. Possible values are listed here: https://everifin.atlassian.net/wiki/spaces/EFMBAPI/pages/2677276707/Bulk+Payment+Processing#Bulk-Payment-Statuses |
name | ||
dueDate | ||
payerName | ||
allPaymentsCount | ||
authorizationPaymentsCount | ||
authorizedPaymentsCount | ||
totalAmount | ||
currency | ||
createdAt | ||
updatedAt | ||
payments | Array | Array of individual payment objects |
Example response
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": 5,
"senderIban": "SK7002000000004565867451",
"status": "FINISHED",
"name": "bulk-payment",
"dueDate": "2023-12-07T12:22:30.659Z",
"payerName": "John Doe",
"allPaymentsCount": 2,
"authorizationPaymentsCount": 2,
"authorizedPaymentsCount": 2,
"totalAmount": 2.87,
"currency": "EUR",
"createdAt": "2023-12-07T12:22:30.748+00:00",
"updatedAt": "2023-12-07T12:23:42.113+00:00",
"payments": [
{
"id": "13",
"amount": 1.44,
"currency": "EUR",
"reference": null,
"variableSymbol": "111",
"specificSymbol": "111",
"constantSymbol": "111",
"recipientIban": "SK5409000000005037706253",
"recipientName": "Test counterparty",
"status": "FINISHED",
"recipientAddress": null,
"recipientBankAddress": null
},
{
"id": "14",
"amount": 1.43,
"currency": "EUR",
"reference": null,
"variableSymbol": "222",
"specificSymbol": "222",
"constantSymbol": "222",
"recipientIban": "SK2575000000004030141240",
"recipientName": "Test counterparty 2",
"status": "FINISHED",
"recipientAddress": null,
"recipientBankAddress": null
}
]
}
}