Payment Instructions Model

This is a representation of a payment instruction model. When the Payment Instruction model is used as input, fields marked as REQUIRED are mandatory.

Refer to GET /metadata/beneficiary endpoint to identify valid beneficiary field combinations for a given country/currency combination.

Fields

string

The ID of the beneficiary’s bank account. When this is provided, beneficiary details like account number, beneficiary name should not be.

string

The ID of the beneficiary. When this is provided, beneficiary details like account number, beneficiary name should not be.

string

Account number. When this is provided, beneficiary_id, account_id should not be.

string

The bank address of the beneficiary. When this is provided, beneficiary_id, account_id should not be.

string

The bank code of the beneficiary (UK sort code, US ABA/FedWire, etc.). When this is provided, beneficiary_id, account_id should not be.

string

The bank country of the beneficiary in ISO 3166-1 format (two character alpha code). When this is provided, beneficiary_id, account_id should not be.

string

Name of the bank account holder. When this is provided, beneficiary_id, account_id should not be.

string

The beneficiary address. When this is provided, beneficiary_id, account_id should not be. (deprecated)*

string

The street name of the beneficiary.*

string

The building number of the beneficiary.*

string

The floor of the beneficiary.*

string

The apartment/office number of the beneficiary.*

string

required

The city of the beneficiary.*

string

The state/region of the beneficiary.*

string

The postcode of the beneficiary.*

string

required

The beneficiary country in ISO 3166-1 format (two character alpha code). When this is provided, beneficiary_id, account_id should not be.

string

The beneficiary name. When this is provided, beneficiary_id, account_id should not be.

string

Permanent reference to add to a beneficiary for all future payments. When this is provided, beneficiary_id, account_id should not be.

string

required

Acceptable values:

buy
sell

Direction field determines whether the payment_amount reflects the amount of currency to buy or amount of currency to sell. Example provided in notes.

string

Unique reference submitted by the client to identify the payment.

string

When this is provided, beneficiary_id, account_id should not be.

string

Unique Taxpayer Personal Identification Number for legal entities registered in Russia.

string

Tax ID for foreign legal entities in Russia.

string

required

Buy currency code ISO 4217

number

required

Buy amount

string

required

Payment reference

string

The purpose of payment is mandatory when the beneficiary account has specific currency types. See the section PurposeOfPayment for the currencies and their acceptable values.

string

required

Reason for trade. See ReasonForTradeValues for acceptable values.

string

20-digit code for Russian banks.

string

When this is provided, beneficiary_id, account_id should not be.

string

required

Type of trade. Acceptable values:

spot

string

required

Date of the payment (YYYY-MM-DD)

string

Code of currency transaction established by the Central Bank of Russia to describe the purpose of the payment.

* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.

Response

HTTP/1.1 200 OK
Content-Type: application/json
x-total-count: 1

[
   {
      "account_number":"string",
      "bank_address":"string",
      "bank_code":"string",
      "bank_country":"string",
      "bank_name":"string",
      "beneficiary_address":"string",
      "beneficiary_street_name":"string",
      "beneficiary_building_number":"string",
      "beneficiary_floor":"string",
      "beneficiary_apartment_office_number":"string",
      "beneficiary_city":"string",
      "beneficiary_state_region":"string",
      "beneficiary_post_code":"string",
      "beneficiary_name":"string",
      "beneficiary_country":"string",
      "beneficiary_reference":"string",
      "direction":"string",
      "external_reference_id":"string",
      "iban":"string",
      "inn":"string",
      "kio":"string",
      "payment_currency":"string",
      "payment_amount":"number",
      "payment_reference":"string",
      "purpose_of_payment":"Purpose of Payment",
      "reason_for_trade":"string",
      "russian_central_bank_account":"string",
      "swift_code":"string",
      "trade_type":"string",
      "value_date":"string",
      "vo":"string"
   }
]

Notes

Example: At the time of submission of mass-payment (POST /mass-payment) sell_currency field is set as GBP or trade_id provided contains sell_currency as GBP. In the payment instruction payment_currency is set as EUR, payment_amount is set as 100 and direction is set as sell.

{
    "auto_commit": "false",
    "sell_currency": "GBP",
    "external_reference_id": "",
    "payment_instructions": [
        {
            "account_number": "",
            "bank_address": "",
            "bank_code": "",
            "bank_country": "IT",
            "bank_name": "",
            "beneficiary_address": "",
            "beneficiary_street_name": "string",
            "beneficiary_building_number": "string",
            "beneficiary_floor": "string",
            "beneficiary_apartment_office_number": "string",
            "beneficiary_city": "string",
            "beneficiary_state_region": "string",
            "beneficiary_post_code": "string",
            "beneficiary_name": "Beneficiary Name",
            "beneficiary_country": "IT",
            "direction": "sell",
            "external_reference_id": "",
            "iban": "IT28E0300203280787878415564",
            "payment_currency": "EUR",
            "payment_amount": 100,
            "reason_for_trade": "ben1",
            "reference": "reference",
            "swift_code": "UNCRITMMXXX",
            "value_date": null,
            "trade_type": "spot"
        }
    ]
}

In this case the client is giving an instruction to calculate EUR amount equivalent to 100 GBP. The payment_amount will be calculated based on the exchange rate of converting 100 GBP to EUR.

[
    {
        "account_number": "",
        "amount": 116.21,
        "authorisation_workflow": "4-eyes",
        "authorised_by": null,
        "authorised_date": null,
        "bank_identifier": "",
        "beneficiary_name": "Beneficiary Name",
        "cancelled_by": null,
        "cancelled_date": null,
        "contact_id": "EBPCON36429",
        "created_date": "2021-08-20",
        "external_reference_id": "",
        "fee_amount": 12.85,
        "fee_currency": "EUR",
        "iban": "IT03V0300203280998885565948",
        "invoice_required": false,
        "payment_currency": "EUR",
        "payment_date": "2021-08-24",
        "payment_id": "PI2305652",
        "payment_instruction": "/documents?type=pi&id=PI2305652&client_id=EBPCLI00003",
        "payment_receipt": "/documents?type=pr&id=PI2305652&client_id=EBPCLI00003",
        "reference": "reference",
        "rejected_by": null,
        "rejected_date": null,
        "status": "Validating beneficiary information",
        "swift_code": "UNCRITMMXXX",
        "trade_id": "EBPOTR2162767"
    }
]

​Notes

Notes