API Reference
Overview
This page lists all endpoints that you can use with the API.
For easier understanding, they will be divided into main and auxiliary groups.
Main endpoints
These endpoints are a core part of the API and are recommended for use.
| Endpoint | Description |
|---|---|
GET/api/1/eurowallet/status | This endpoint returns a list of all your IBAN accounts in Nexpay, including their balance and status. |
POST/api/2/eurowallet/payments | This endpoint allows you to initiate an outgoing payment from your IBAN account in Nexpay. |
GET/api/1/eurowallet/payments/status | This endpoint returns the payment status. It is typically used immediately after creating a payment order to check it's current status. Alternatively, you can use webhooks. |
GET/api/1/nexpay/payments | This endpoint returns data for a specific payment, including payment network, amount, currency, reference, status, etc. |
GET/api/1/eurowallet/payments/history | This endpoint allows you to obtain a statement for the selected account for the selected period. In addition to the list of payments, information is provided on debit and credit turnovers as well as balance at the start and the end of the period. |
Auxiliary endpoints
These endpoints allow you to use auxiliary functions. The need to integrate them will depend on your specific business case.
Accounts management
| Endpoint | Description |
|---|---|
GET/api/1/eurowallet/deposit-details | This endpoint returns information about your IBAN accounts in Nexpay. You can use this data to create payment instructions for receiving incoming payments. |
POST/api/1/eurowallet/account | This endpoint allows you to open a new IBAN account. Please note that the number of accounts you can create yourself is limited. |
SWIFT transfer
| Endpoint | Description |
|---|---|
GET/api/2/eurowallet/payments/swift-currencies | This endpoint returns a list of currencies in which you can make outgoing payments via the SWIFT network. This endpoint is auxiliary to POST /api/2/eurowallet/payments and can be called before it. |
GET/api/2/eurowallet/payments/fx-rate | This endpoint returns the exchange rate if you decide to make an outgoing payment via the SWIFT network in a currency other than the euro. This endpoint is auxiliary to POST /api/2/eurowallet/payments and can be called before it. |
Recurring payments
| Endpoint | Description |
|---|---|
POST/api/2/eurowallet/recurring | This endpoint allows you to set up recurring payments. Please note that you must first create a beneficiary in the client portal. |
POST/api/2/eurowallet/cancel-recurring | This endpoint allows you to cancel the recurring payment setup for a selected beneficiary that has been created through the client portal. |
Scheduled payments
| Endpoint | Description |
|---|---|
POST/api/2/eurowallet/reschedule | This endpoint allows you to change the date and time of execution of a payment order that has been previously created. This function is available until the payment order has been executed. |
POST/api/2/eurowallet/cancel-scheduled | This endpoint allows you to cancel a scheduled execution of a payment order that has been previously created. This function is available until the payment order has been executed. |
Other
| Endpoint | Description |
|---|---|
GET/api/1/eurowallet/payments/commission | This endpoint calculates and returns the commission amount for an outgoing payment. This endpoint is auxiliary to POST /api/2/eurowallet/payments and can be called before it. |