Skip to main content
GET
Fetch the payment instructions submitted for a mass payment
Obtain all the payment instructions submitted with Submit a Mass Payment Instruction for a given mass_payment_id. You may also filter instructions by payment_currency.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

Path Parameters

mass_payment_id
string
required

The mass payment ID

Query Parameters

client_id
string
required

The ID of the client

page
integer<int32>

The desired page number for pagination. By default is 1.

page_size
integer<int32>

The number of items per page for pagination. By default is 50.

Response

List of payment instructions

account_number
string | null
required

Destination account number

bank_address
string | null
required

Destination bank address

bank_code
string | null
required

Destination bank code

bank_country
string
required

Destination bank country

Minimum string length: 1
bank_name
string | null
required

Destination bank name

beneficiary_address
string | null
required

Address of beneficiary

beneficiary_name
string | null
required

Name of beneficiary

beneficiary_country
string | null
required

Country of beneficiary

direction
enum<string>
required

Type of payment, 'buy' or 'sell'

Available options:
buy,
sell
iban
string | null
required

IBAN of the destination account

payment_currency
string
required

Destination currency

Minimum string length: 1
payment_amount
number<float>
required

Amount to be paid

Required range: x >= 0
reason_for_trade
string | null
required

Reason for trade

swift_code
string | null
required

SWIFT code of destination bank

trade_type
enum<string>
required

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

Available options:
spot
value_date
string | null
required

Date when the transaction will be performed

payment_reference
string | null

Reference of payment

beneficiary_reference
string | null

Reference of beneficiary

purpose_of_payment
string | null

Text describing the purpose of the payment

reference
string | null

Payment reference

inn
string | null

The INN of the bank account

Pattern: ^[0-9]{10}([0-9]{2})?$
vo
string | null

The VO of the bank account

kio
string | null

The KIO of the bank account

russian_central_bank_account
string | null

Russian central bank account