Versions Compared

Version Old Version 1 New Version Current
Changes made by

Michal Gregor

Michal Gregor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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).
Using of URL like this for local development requires some locally running proxy rerouting to your app running on localhost.

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

...

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)

yesno

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 10 4 chars)

yes

Symbol for SK/CZ market. Cannot be combined with reference.

specificSymbol

numeric text

(max 4 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:

  • streetName - free text

  • streetNumber - free text

  • city - free text

  • zip - free text

  • countryCode - ISO alpha-3 code of the country

recipientBankAddress

Object

yes

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

yes

possible values:

  • NORMAL

  • HIGH

  • INSTANT

...

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