...
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
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
...
instructionId
...
text, unique
(max 64 chars)
...
yes
...
Your unique identification string.
...
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
...
Your IBAN account number to collect the payment (not payer`s IBAN). This IBAN must be whitelisted in Everifin Paygate, otherwise the payment will be denied.
...
recipientBankBic
...
text, valid BIC
...
yes
...
BIC of the integrator's bank account
...
senderBankId
...
text, valid bank identifier in Everifin
...
yes
...
ID of the bank selected for the payment
...
senderIban
...
text, valid iban
(max 50 chars)
...
yes
...
IBAN of sender's 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.
...
customerEmail
...
valid email
...
yes
...
Email of the customer
...
redirectUrl
...
text
(max 5000 chars)
...
no
...
Redirect URL back to your system. This redirect URL has to be whitelisted in Everifin Paygate.
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.
Custom query parameters are accepted.
...
paymentMessage
...
text
(max 140 chars)
...
yes
...
Message to your customer. This message will be visible in his bank transaction as description of the transfer.
...
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.
...
userLocale
...
language code
...
yes
...
If you want to force Everifin Paygate UI language for your customer, use this property. List of supported languages: 'en', 'sk', 'cs' (it is being extended continuously) . If not defined, browser language will be applied.
...
refundLimitPercentage
...
Valid positive number (Integer or floating up to 2 decimals) or zero
...
yes
...
Specifies the refund limit of an order. If value equals 100, refund can be created up to the amount of an order. If set to 0, the refund limit is not applied, i.e. any amount can be refunded.
...
externalId
...
Free text, maximum 255 characters
...
yes
...
Can be used to match the order with data in client's systems. Might be different from instructionId, because the instructionId could be unique for each payment within an order.
Example call
...
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.