This page describes endpoints to get payment data.
Single Payment Detail
This endpoint returns details (status and other data) of specific payment.
Postman documentation: Get Single Payment
Request
GET {{everifin_api_url}}/v1/payments/single/{{payment_id}}
HTTP headers
Initiation of a order must contain following headers.
Header | Type | Description |
|---|---|---|
Authorization | Bearer token | Authorization token to access API. |
Response
Response contains payment object with following fields
Field | Type | Description |
|---|---|---|
id | integer number, unique | Payment ID |
amount | number | Payment amount |
currency | ISO alpha-3 currency code | Currency of the payment |
feeType | enum | Type of the fee (if applicable). Possible values:
|
fee | number | Fee related to this payment. |
feeCurrency | ISO alpha-3 code | Fee currency |
paymentMessage | string | Message to recipient of the payment. |
reference | text (max 35 chars) | Payment reference. Cannot be combined with symbols. |
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. |
recipientIban | text, valid iban (max 50 chars) | IBAN account number where the money should be 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 |
status | enum | Status of the payment. Possible values are listed here: Payment statuses |
recipientAddress | Object | Object holding information about recipient address. Fields:
|
recipientBankAddress | Object | Object holding information about recipient bank address. Fields:
|
senderIban | text, valid iban (max 50 chars) | IBAN of sender’s (your) bank account. |
senderBankBic | text, valid BIC | BIC of the recipient bank. |
externalId | Free text, maximum 255 characters | Value provided in request to initiate the payment. Can be used to match the payment with data in your systems. |
priority | enum | Value provided in request to initiate the payment. Possible values:
|
Example Response
| Code Block |
|---|
{
"meta": {
"status": "SUCCESS"
},
"data": {
"id": "12",
"amount": 1.7,
"currency": "EUR",
"feeType": "UNKNOWN",
"fee": null,
"feeCurrency": null,
"paymentMessage": null,
"reference": null,
"variableSymbol": null,
"specificSymbol": null,
"constantSymbol": null,
"recipientIban": "SK5409000000005037706253",
"recipientName": "Customer name",
"recipientBankBic": null,
"status": "FINISHED",
"recipientAddress": null,
"recipientBankAddress": null,
"externalId": null,
"senderIban": "SK7002000000004565867451",
"senderBankBic": "subaskbx"
}
} |
List of Single Payments
This endpoint returns details (status and other data) of specific payment.
Postman documentation: List of Single Payments
Request
GET {{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. |
Filter Parameters
The list of possible filter query parameters can be found in postman documentation (link above).
Response
Response contains paged list of payment objects. The fields of the individual objects are described in previous section.