This page describes endpoints to get bulk payment data.

Bulk Payment Detail

This endpoint returns details (status and other data) of specific 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	Free text, maximum 255 characters	Name of the bulk payment.
dueDate	ISO 8601 datetime	Date when the payment will be or has been executed.
payerName	Free text, maximum 255 characters	Name of the profile in Everifin who has connected the source account of the bulk payment.
allPaymentsCount	integer number	Number of payments in bulk.
totalAmount	number (0.01 - 9999999999)	Sum of amounts of all payments in bulk.
currency	ISO alpha-3 currency code	Currency of the payments in bulk. All payments in bulk must be using same currency.
createdAt	ISO 8601 datetime	Timestamp of bulk payment creation.
updatedAt	ISO 8601 datetime	Timestamp of last bulk payment update.
payments	Array	Array of individual payment objects (described below).

Individual payment object structure

Field	Type	Description
amount	number (0.01 - 9999999999)	Amount of the payment.
currency	text, ISO alpha-3 currency code	Currency of the payment.
recipientIban	text, valid iban (max 50 chars)	IBAN account number where the money were sent to.
recipientName	text (max 140 chars)	Name of the payment recipient. This name will appear in your bank transaction as recipient of the money.
recipientBankBic	text, valid BIC	BIC of the recipient bank
variableSymbol	numeric text (max 10 chars)	Symbol for SK/CZ market. Cannot be combined with reference.
constantSymbol	numeric text (max 10 chars)	Symbol for SK/CZ market. Cannot be combined with reference.
specificSymbol	numeric text (max 4 chars)	Symbol for SK/CZ market. Cannot be combined with reference.
reference	text (max 35 chars)	Payment reference. Cannot be combined with symbols.
paymentMessage	text (max 140 chars)	Message to recipient. This message will be visible in bank transaction as description of the transfer.
externalId	Free text, maximum 255 characters	Value provided at the time of payment initiation. Can be used to match the payment with data in your systems.
recipientAddress	Object	Object holding information about recipient address. Fields: streetName - free text streetNumber - free text city - free text zip - free text countryCode - ISO alpha-3 code of the country
recipientBankAddress	Object	Object holding information about recipient bank address. Fields: streetName - free text streetNumber - free text city - free text zip - free text countryCode - ISO alpha-3 code of the country
priority	Enum	possible values: NORMAL HIGH INSTANT

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
            }
        ]
    }
}

Bulk Payment Data