Payments

Create one or more payments

Create one or more payments with an existing trade_id, beneficiary ID and account ID. Payment processing can be made asynchronous by setting the async flag in the request body.

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

include_errorsboolean

If true, the response includes details on why payments failed. On success the 201 body becomes a NewPaymentsWithErrors object instead of an array, and on a 409 the error details contain the same object as a JSON string.

vop_authorization_idstring

VoP authorization ID to confirm not full-match payment

Headers

Authorizationstring required

The access token.

Request body

asyncboolean

Create the payment(s) asynchronously. Payments are created synchronously by default.

is_padboolean

Whether to fund payments via Pre-Authorized Debit (direct debit). Only valid for CAD and AUD payments with available credit. Deprecated; set is_pad per payment instead. Not honoured on the SCA (2FA) path.

trade_idstring

Unique identifier of the trade the payment is allocated to

Response

Payment(s) created synchronously. An array of created payments, or a NewPaymentsWithErrors object when include_errors is true

OR

Example response

{
  "payments_errors": {
    "0": [
      "INVALID_DATE"
    ],
    "2": [
      "DESTINATION_ACCOUNT",
      "DATE_NOT_MATCHING_TRADE_DATE"
    ]
  }
}

Changes

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