Multi Payments

Fetch mass payments

Fetch the mass payments of a client, optionally filtered

get/mass-payments

Request

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

Query parameters

client_idstring required

The identifier of a client.

mass_payment_idstring uuid

Filter by mass payment ID

external_reference_idstring

Filter by the external reference of the mass payment

sell_currencystring

Filter by the sell currency of the mass payment

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.

Headers

Authorizationstring required

The access token.

Response

List of mass payments

mass_payment_idstring uuid

The UUID of the MassPayment

external_reference_idstring

External reference of the mass payment

mass_payment_status'Queued for processing' | 'Processing' | 'Processed' | 'Queued for creating' | 'Creating' | 'Created' | 'Cancelled' | 'Failed'

This is an enumeration of the status of a MassPayment

sell_currencystring

Sell currency

trades_creatednumber

Number of trades created

Changes

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