Multi Payments

Fetch the payment instructions submitted for a mass payment

Fetch the payment instructions submitted for a mass payment

get/mass-payments/{mass_payment_id}/payments-received

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/mass-payments/{mass_payment_id}/payments-received
  • 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.

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 payment instructions

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

Changes

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