Search or retrieve payments
Authorizations
An API Key.
Query Parameters
The ID of the client
The ID of the Payment(could be more than one, comma separated)
Filter by related mass payment's uuid.
Filter by related mass payment's external reference.
Filter by payment currencies
Filter by amount. Requires 'amount_range' to be provided.
Filter by amount range. Requires 'amount' to be provided.
over, below, equal The desired page number for pagination. By default is 1.
The number of items per page for pagination. By default is 50.
Sort direction for results.
asc, desc Field used to sort results.
order_date, value_date Filter payments by reference.
Filter payments by trade_id.
Filter by beneficiary ID.
Filter payments by from_payment_date.
Filter payments by to_payment_date.
Filter payments by from_created_date.
Filter payments by to_created_date.
Filter payments by status (and NEyes Plus status (if available)).
pending, pending_to_authorise, authorised, cancelled, rejected, complete, pending_your_approval, pending_others_approval Response
Client payments
Unique identifier of the contact who booked the payment
Unique identifier for the payment
Unique identifier of the trade the payment is allocated to
Payment amount
Neyes-Plus workflow related fields
The authorisation workflow of the payment
simple, 4-eyes, 6-eyes, 8-eyes, 10-eyes The user who authorised the payment
The date when payment was authorised
Name of the beneficiary
id of the beneficiary
a beneficiary id formatted
Flag indicating if the beneficiary is active
Flag indicating if the beneficiary is authorised
Flag indicating if the beneficiary is blocked
Flag indicating if the beneficiary is completed
Flag indicating if the beneficiary is verified
The user who cancelled the payment
The date when payment was cancelled
Charges associated with the payment
Payment instruction created date
Fee amount
Fee currency
Whether or not the payment requires an invoice
name of who make the order
The formatted, human-readable display identifier (e.g., 'EBPMP001067'). Often used for invoices and customer support.
The internal database sequential numeric identifier.
A universally unique identifier (UUID) used for secure API lookups and to prevent ID enumeration.
Currency the payment was made in
Target payment date
URI to download payment instruction
URI to download payment receipt
Payment reference
The user who rejected the payment
The date when payment was rejected
The current status of the payment
Need more beneficiary information, Validating beneficiary information, Waiting for payment date, Payment complete, Executing Payment, Payment pending of authorization, Payment rejected, Payment cancelled The unique internal identifier for the payment. Note: This field is also used as the UETR (Unique End-to-end Transaction Reference) for SWIFT gpi tracking purposes when is_uuid_used_for_tracking is true.
Indicates if the uuid can be used as a valid UETR for SWIFT tracking. It returns true only if the following conditions are met: * The payment schema is SCHEMA_SWIFT. * The transaction is recent (less than 124 days old). * The payment is not marked as invalid or canceled. * The date is subsequent to the CAN_TRACK_SWIFT_PAYMENT_SINCE setting.