Multi Payments

Create a multi payment instruction

Create a new multi payment instruction. Requires either a sell currency or existing trade ID to create the instruction

post/multipayments

Request

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

Query parameters

client_idstring required

The ID of the client

trade_idstring

Trade ID to book payments against. Omit if trade should be executed to fund payments

sell_currencystring

If trade_id omitted, a sell currency must be supplied

accept_partialboolean

Accept a partially successful instruction. If true, send successful instructions for payment. If false, reject the entire instruction

accept_immediatelyboolean required

Set to true. Accept quote immediately, do not require confirmation

vop_authorization_idstring

VoP authorization ID to confirm not full-match payment

Headers

Authorizationstring required

The access token

X-Contact-IDstring

The ID of the contact

Request body

account_idstring

The ID of an existing beneficiary bank account. Required together with beneficiary_id when bank details are not supplied

beneficiary_idstring

The ID of an existing beneficiary. Required together with account_id when bank details are not supplied

account_numberstring nullable

Destination account number

bank_addressstring nullable

Destination bank address

bank_codestring nullable

Destination bank code

bank_countrystring

Destination bank country

bank_namestring nullable

Destination bank name

beneficiary_addressstring nullable

Address of beneficiary

beneficiary_namestring nullable

Name of beneficiary

beneficiary_countrystring nullable

Country of beneficiary

direction'buy' | 'sell' required

Type of payment, 'buy' or 'sell'

ibanstring nullable

IBAN of the destination account

payment_currencystring required

Destination currency

payment_amountnumber float required

Amount to be paid

reason_for_tradestring nullable required

Reason for trade

payment_referencestring nullable

Reference of payment

swift_codestring nullable

SWIFT code of destination bank

trade_type'spot' required

Type of trade. 'spot' is the only supported value at the moment

value_datestring nullable required

Date when the transaction will be performed

beneficiary_referencestring nullable

Reference of beneficiary

purpose_of_paymentstring nullable

Text describing the purpose of the payment

referencestring nullable

Payment reference. Deprecated, use payment_reference

innstring nullable

The INN of the bank account

vostring nullable

The VO of the bank account

kiostring nullable

The KIO of the bank account

russian_central_bank_accountstring nullable

Russian central bank account

external_reference_idstring nullable

External reference for this payment instruction. Maximum 128 characters

beneficiary_street_namestring nullable

Street name of the beneficiary address

beneficiary_building_numberstring nullable

Building number of the beneficiary address

beneficiary_floorstring nullable

Floor of the beneficiary address

beneficiary_apartment_office_numberstring nullable

Apartment or office number of the beneficiary address

beneficiary_citystring nullable

City of the beneficiary address

beneficiary_state_regionstring nullable

State or region of the beneficiary address

beneficiary_post_codestring nullable

Post code of the beneficiary address

Example request

[
  {
    "account_number": 9999999999,
    "bank_address": "1 Test Street",
    "bank_code": 999999,
    "bank_country": "N",
    "bank_name": "Test Bank 1",
    "beneficiary_address": "2 Test Street",
    "beneficiary_country": "NZ",
    "beneficiary_name": "Functional Test New Zealand",
    "beneficiary_reference": "Beneficiary bank",
    "direction": "buy",
    "iban": null,
    "inn": null,
    "kio": null,
    "payment_amount": 110.01,
    "payment_currency": "NZD",
    "payment_reference": "MULTIPAYMENTSTEST",
    "purpose_of_payment": null,
    "reason_for_trade": "Execute payments",
    "russian_central_bank_account": null,
    "swift_code": "TESTNZ99",
    "trade_type": "spot",
    "value_date": "2016-04-18T00:00:00.000Z",
    "vo": null
  },
  {
    "account_number": null,
    "bank_address": "1 Test Street",
    "bank_code": null,
    "bank_country": "ES,",
    "bank_name": "Test Bank 2",
    "beneficiary_address": "2 Test Street",
    "beneficiary_country": "GB",
    "beneficiary_name": "Test beneficiary",
    "beneficiary_reference": null,
    "direction": "buy",
    "iban": "ES6710067038260971665568",
    "inn": null,
    "kio": null,
    "payment_amount": 32.02,
    "payment_currency": "EUR",
    "payment_reference": "MULTIPAYMENTSTEST",
    "purpose_of_payment": null,
    "reason_for_trade": "Execute payments",
    "russian_central_bank_account": null,
    "swift_code": "TESTES99",
    "trade_type": "spot",
    "value_date": "2016-04-18T00:00:00.000Z",
    "vo": null
  }
]

Response

Multi payment created, see response body for status

MultiPaymentResponse required(unresolved $ref)

Changes

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