Multi Payments

Confirm multi payment instructions

Confirm (commit) mass payment instructions, which can be hold because auto_commit was false, or because there were some errors.

post/mass-payments/{mass_payment_id}/confirm

Request

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

Path parameters

mass_payment_idstring required

The ID of the mass payment.

Query parameters

client_idstring required

The identifier of a client.

Headers

Authorizationstring required

The access token.

Response

Masspayment confirmation accepted, see response body for status

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.