Payments

Search or retrieve payments

Search or retrieve all payments for a given client ID

get/payments

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/payments
  • Auth: API key in header x-api-key

Query parameters

client_idstring required

The identifier of a client.

payment_idsstring

The ID of the Payment(could be more than one, comma separated)

mass_payment_idstring uuid

Filter by related mass payment's uuid.

mass_payment_external_reference_idstring

Filter by related mass payment's external reference.

payment_currencystring

Filter by payment currencies (comma separated)

external_reference_idstring

Filter by the external reference of the payment.

multipayment_idstring

Filter by related multipayment ID.

amountnumber float

Filter by amount. Requires 'amount_range' to be provided.

amount_range'over' | 'below' | 'equal'

Filter by amount range. Requires 'amount' to be provided.

pageinteger

The desired page number for pagination. By default is 1.

page_sizeinteger

The number of items per page for pagination. By default is 50.

order'asc' | 'desc'

Sort direction for results.

order_by'order_date' | 'value_date'

Field used to sort results.

referencestring

Filter payments by reference.

trade_idstring

Filter payments by trade_id.

beneficiary_idstring

Filter by beneficiary ID.

from_payment_datestring date

Filter payments by from_payment_date.

to_payment_datestring date

Filter payments by to_payment_date.

from_created_datestring date

Filter payments by from_created_date.

to_created_datestring date

Filter payments by to_created_date.

pending_onlyboolean

If true, only return payments which are not yet executed. Cannot be combined with status or include_all.

include_allboolean

If true, return all payments regardless of their status. Cannot be combined with status or pending_only.

status'pending' | 'pending_to_authorise' | 'authorised' | 'cancelled' | 'rejected' | 'complete' | 'pending_your_approval' | 'pending_others_approval'

Filter payments by status (and NEyes Plus status (if available)). Cannot be combined with pending_only or include_all.

Headers

Authorizationstring required

The access token.

Response

Client payments

account_numberstring
amountnumber float

Payment amount

authorisation_workflow'simple' | '4-eyes' | '6-eyes' | '8-eyes' | '10-eyes'

The authorisation workflow of the payment

authorised_bystring

The user who authorised the payment

authorised_datestring date

The date when payment was authorised

bank_identifierstring
beneficiary_namestring

Name of the beneficiary

beneficiary_idstring

id of the beneficiary

beneficiary_aml_idstring

a beneficiary id formatted

beneficiary_activeboolean

Flag indicating if the beneficiary is active

beneficiary_authorisedboolean

Flag indicating if the beneficiary is authorised

beneficiary_blockedboolean

Flag indicating if the beneficiary is blocked

beneficiary_completedboolean

Flag indicating if the beneficiary is completed

beneficiary_verifiedboolean

Flag indicating if the beneficiary is verified

cancelled_bystring

The user who cancelled the payment

cancelled_datestring date

The date when payment was cancelled

chargesstring

Charges associated with the payment

contact_idstring required

Unique identifier of the contact who booked the payment

created_datestring date

Payment instruction created date

fee_amountnumber float

Fee amount

fee_currencystring

Fee currency

ibanstring
invoice_requiredboolean

Whether or not the payment requires an invoice

ordered_by_namestring

name of who make the order

multipaymentstring

The formatted, human-readable display identifier (e.g., 'EBPMP001067'). Often used for invoices and customer support.

multipayment_idstring

The internal database sequential numeric identifier.

multipayment_unique_idstring uuid

A universally unique identifier (UUID) used for secure API lookups and to prevent ID enumeration.

payment_currencystring

Currency the payment was made in

payment_datestring date

Target payment date

payment_idstring required

Unique identifier for the payment

payment_instructionstring uri

URI to download payment instruction

payment_receiptstring uri

URI to download payment receipt

referencestring

Payment reference

rejected_bystring

The user who rejected the payment

rejected_datestring date

The date when payment was rejected

status'Need more beneficiary information' | 'Validating beneficiary information' | 'Waiting for payment date' | 'Payment complete' | 'Executing Payment' | 'Payment pending of authorization' | 'Payment rejected' | 'Payment cancelled'

The current status of the payment

swift_codestring
trade_idstring required

Unique identifier of the trade the payment is allocated to

uuidstring uuid

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.

is_uuid_used_for_trackingboolean

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.

external_reference_idstring

Unique reference submitted by the client to identify the payment

mass_payment_idstring uuid nullable

Unique identifier for the mass payment, if the payment was created from one

can_be_cancelledboolean

Indicates if the payment is currently in a state that allows cancellation

cancelledboolean

Indicates if the payment has been cancelled

executedboolean

Indicates if the payment has been successfully executed

verifiedboolean

Indicates if the payment details have been verified

fully_fundedboolean

Indicates if the account has sufficient funds to cover the payment

over_paidboolean

Indicates if the payment amount exceeds the trade or balance allocation

returnedboolean

Indicates if the payment was returned by the receiving bank

holdboolean

Indicates if the payment is on hold

AML_statusinteger

Numerical status code representing the AML check result

AML_overdueboolean

Indicates if the AML verification process has exceeded the expected timeframe

parent_client_idstring

The ID of the parent client. Only returned when set

external_uetrstring

External UETR of the payment. Only returned when set

external_ibanstring

External IBAN of the payment. Only returned when set

payment_external_referencestring

External reference of the payment. Only returned when set

Example response

[
  {
    "amount": 32,
    "approvals_workflow": {
      "authorisations": [
        {
          "date": "2025-09-01T14:04:24.532",
          "status": 3,
          "contact_id": "TAICON99999",
          "level": 100,
          "contact_name": "Contact"
        }
      ],
      "contact_authorisation_actions": {
        "allowed": [
          "authorise",
          "reject"
        ],
        "executed": [
          "authorise"
        ]
      },
      "n_eyes_plus_status": "Awaiting approval",
      "minimum_remaining_authorisations": 1
    },
    "authorisation_workflow": "4-eyes",
    "authorised_by": "TAICON99999",
    "authorised_date": "2016-04-28T00:00:00.000Z",
    "beneficiary_name": "Test beneficiary",
    "beneficiary_id": 16764,
    "beneficiary_aml_id": "EBPBEN16764",
    "beneficiary_active": false,
    "beneficiary_authorised": false,
    "beneficiary_blocked": false,
    "beneficiary_completed": false,
    "beneficiary_verified": false,
    "cancelled_by": "TAICON99999",
    "cancelled_date": "2016-04-28T00:00:00.000Z",
    "charges": "/SHA",
    "contact_id": "TAICON99999",
    "created_date": "2016-04-28T00:00:00.000Z",
    "iban": "GB99TEST999999999999",
    "ordered_by_name": "Test Trade User",
    "multipayment": "EBPMP000001",
    "multipayment_id": "0001,",
    "multipayment_unique_id": "3c6288e4-1449-4525-83e4-f22e5efcf1bc",
    "payment_currency": "GBP",
    "payment_date": "2016-04-28T00:00:00.000Z",
    "payment_id": "PI186294",
    "payment_instruction": "/documents?client_id=TAICLI99999&type=pi&id=PI186294",
    "reference": "My payment reference",
    "rejected_by": "TAICON99999",
    "rejected_date": "2016-04-28T00:00:00.000Z",
    "status": "Validating beneficiary information",
    "uuid": "e064e4aa-df4b-4004-a62c-d8974387c2dd",
    "is_uuid_used_for_tracking": true,
    "swift_code": "TESTES99",
    "trade_id": "EBPOTR372760"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.