Main Endpoints

Get payment details

This endpoint allows you to retrieve details of a particular payment
GET/api/1/nexpay/payments

Request

clientPaymentId
integer required
The payment identifier generated by Nexpay
Alternatively, you can use externalPaymentId
externalPaymentId
string required
The custom internal identifier shared between you and your end-customer
Alternatively, you can use clientPaymentId

Response

Mandatory parameters

Each response contains the following mandatory data:

paymentId
string required
Internal payment identifier
It is returned in response to the  POST/api/2/eurowallet/payments
networkType
string required
Payment rails through which the payment should be made
Possible values: SEPA, SWIFT
If the parameter is not provided, the SEPA network is chosen by default
date
string required
Payment processing date
Format: yyyy-MM-dd
beneficiaryName
string required
Recipient’s/sender’s name
account
string required
Recipient’s/sender’s bank account number
details
string required
Payment reference (transaction details)
amount
string required
Payment amount
runningBalance
string required
Account balance at the time of payment processing
direction
string required
Payment direction
Possible values: incoming - deposit, outgoing - withdrawal
status
string required
Payment status
Possible values: PENDING, COMPLETED, REJECTED
otherAddressLine
string required
Recipient’s/sender’s full address which is returned as a single line
otherAddressStreet
string required
Recipient’s/sender’s street address
otherAddressTown
string required
Recipient’s/sender’s city addres
otherAddressPostCode
string required
Recipient’s/sender’s postal code address
otherAddressCountry
string required
Recipient’s/sender’s country address
Format: ISO 3166-1 alpha-2 two-letter country code, e.g. LT

::

Conditional parameters

These parameters are only returned for incoming non-Euro payments that have been sent through the SWIFT network (networkType = SWIFT)

originalAmount
string required
Original payment amount
originalCurrency
string required
Original payment currency

Optional parameters

The parameters listed below are optional:

feePaymentId
string optional
Identifier of a linked commission charge transaction
externalPaymentId
string optional
Custom internal identifier shared between you and your end-customer, helping you track and reference payments across systems
batchReference
string optional
The identifier of the batch file of which this payment was a part

Examples

GET url: /api/1/nexpay/payments
GET data: clientPaymentId=49

or

GET url: /api/1/nexpay/payments
GET data: externalPaymentId=123102a35db34864b

Errors

CodeMessage
20000paymentId or externalPaymentId parameters were not provided
20010Both paymentId and externalPaymentId parameters were provided

Get payment status

This endpoint allows you to retrieve payment status

Get account statement

This endpoint allows you to retrieve the list of completed payments (account statement)