Payment Endpoints
- Juraj Malecka
- Michal Gregor
- Anton Kohutovič
Get payment
This operation can be used to get payment status. Usual approach is to call this endpoint after the payer is redirected back to the e-shop (regardless of using hooks or not). This endpoint can be called multiple times.
Request
GET {everifin_url}/api/v1/payments/:idResponse - successful payment
200:
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": {{:id}}
"instructionId": "ABCD11234",
"amount" : 1.05,
"currency": "EUR",
"recipientIban": "SK132465798132456",
"recipientName": "The best e-shop in the world",
"variableSymbol": "0000000001",
"constantSymbol": "0308",
"specificSymbol": "0000000003",
"reference": null,
"redirectUrl": "https://thebesteshopintheworld.com",
"paymentMessage": "Payment for The best eshop",
"status": "CONFIRMED"
}
}Response - failed payment
200:
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": {{:id}}
"instructionId": "ABCD11234",
"amount" : 1.05,
"currency": "EUR",
"recipientIban": "SK132465798132456",
"recipientName": "The best e-shop in the world",
"variableSymbol": "0000000001",
"constantSymbol": "0308",
"specificSymbol": "0000000003",
"reference": null,
"redirectUrl": "https://thebesteshopintheworld.com",
"paymentMessage": "Payment for The best eshop",
"status": "FAILED",
"reasonCode": "INSUFFICIENT_AMOUNT"
}
}Get payments
To get list of payments, you can use this operation. Getting multiple payments requires pagination and supports filtering and sorting.
Request
Filter
Field | Type | Description |
|---|---|---|
id | UUID | Id of the payment |
instructionId | text | Your id of the payment |
recipientIban | IBAN | Your bank account IBAN |
senderBankId | text | Sender`s (Payer`s) bank id |
amount | number range | Amount of the payment defined in a number range |
currency | text | Currency code of the payment |
variableSymbol | numeric text | Variable symbol of the payment |
specificSymbol | numeric text | Specific symbol of the payment |
constantSymbol | numeric text | Constant symbol of the payment |
reference | text | Payment reference |
paymentMessage | text | Payment message |
status | enum | Payment status |
createdDateFrom | timestamp | Payment’s createdAt date |
createdDateTo | timestamp | Payment’s createdAt date |
confirmedDateFrom | timestamp | Payment’s confirmedAt date |
confirmedDateTo | timestamp | Payment’s confirmedAt date |
finalizedDateFrom | timestamp | Payment’s finalizedAt date |
finalizedDateTo | timestamp | Payment’s finalizedAt date |
Sorting
Sorting by following fields is supported
id
instructionId
amount
currency
senderBankId
variableSymbol
specificSymbol
constantSymbol
reference
paymentMessage
status
recipientIban
createdAt
confirmedAt
finalizedAt
Response
Withdraw payment
You can withdraw (invalidate / cancel) a payment by calling Everifin Paygate endpoint with DELETE method. The payment cannot be invalidated for finalized payments (successful or failure) and also in case the user has already started a payment authorization on bank’s side.