...
payment initiation
payment processing - works like a state machine, i.e your system needs to react based on content of the response (“status” and “step” fields). The order of steps in the flow is bank-specific.
These are in more detail described in respective sections below.
Payment initiation
The payment process starts with creating the payment resource.
Endpoint details: Create Single Payment
Request
POST {{everifin_api_url}}/v1/payments/single
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
...
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.
...
paymentDate
...
ISO 8601 datetime
...
yes
...
Date when the payment should be executed. Current date of not provided
...
recipientIban
...
text, valid iban
(max 50 chars)
...
no
...
IBAN account number where the money should be sent to.
...
recipientName
...
text
(max 140 chars)
...
yes
...
Your name in case you don’t want to use the registered name.
This name will appear in payer’s bank transaction as recipient of the money.
...
recipientBankBic
...
text, valid BIC
...
yes
...
BIC of the integrator's bank account
...
senderIban
...
text, valid iban
(max 50 chars)
...
yes
...
IBAN of sender’s (your) bank account. if known at the time of order creation
...
variableSymbol
...
numeric text
(max 10 chars)
...
yes
...
Symbol for SK/CZ market. Cannot be combined with reference.
...
constantSymbol
...
numeric text
(max 10 chars)
...
yes
...
Symbol for SK/CZ market. Cannot be combined with reference.
...
specificSymbol
...
numeric text
(max 4 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.
...
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.
...
paymentMessage
...
text
(max 140 chars)
...
yes
...
Message to for recipient. This message will be visible in his 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.
...
counterpartyAddress
...
Free text, maximum 255 characters
...
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
...
priority
...
Enum
...
yes
...
possible values:
NORMAL
HIGH
INSTANT
Example call
| Code Block |
|---|
POST {{everifin_api_url}}/api/v1/payments/single
{
"amount": 1.00,
"currency": "EUR",
"paymentDate": null,
"recipientIban": "{{counterparty_iban}}",
"recipientName": "Customer name",
"recipientBankBic": null,
"variableSymbol": null,
"specificSymbol": null,
"constantSymbol": null,
"reference": null,
"paymentMessage": null,
"redirectUrl": "https://web.example",
"externalId": "ABC123",
"counterpartyAddress": {
"streetName": "Testova",
"streetNumber": "10",
"city": "Testovo",
"zip": "123456",
"countryCode": "SVK"
},
"senderIban": "{{your_iban}}",
"priority": null
} |
Response
...
Field
...
Type
...
Optional
...
Description
...
id
...
number
...
no
...
Payment ID
Example response
...
Payment data can be obtained using one of the following endpoints:
payment detail
list of payments
Further details of payment processing are described in respective sub-sections.