Multi Payments

Create a mass payment instruction

Submit mass payment request in async mode. Requires either a sell currency or existing trade ID to create the instruction

post/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.

vop_authorization_idstring

VoP authorization ID to confirm not full-match payment

Headers

Authorizationstring required

The access token.

Request body

external_reference_idstring

The external reference: unique ID supplied by customer which can be used later to filter.

auto_commitboolean required

If true, send successful instructions for payment. If false, hold until customer hits commit endpoint.

sell_currencystring

If trade_id omitted, sell_currency must be supplied.

trade_idstring

Trade ID to book payments against. If customer wants the trade to be auto booked then this parameter should not be supplied.

Response

Masspayment request accepted, see response body for status

mass_payment_idstring uuid

The UUID of the MassPayment just created

external_reference_idstring

The external reference for the MassPayment, if supplied

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

Changes

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