Create a mass beneficiary instruction

curl --request POST \
  --url https://{environment}.ebury.io/mass-beneficiaries \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "bank_country_code": "<string>",
    "bank_currency_code": "<string>",
    "country_code": "<string>",
    "email_notification": true,
    "name": "<string>",
    "account_number": "<string>",
    "bank_address_line_1": "<string>",
    "bank_identifier": "<string>",
    "bank_name": "<string>",
    "correspondent_account": "<string>",
    "correspondent_swift_code": "<string>",
    "iban": "<string>",
    "inn": "<string>",
    "kbk": "<string>",
    "kio": "<string>",
    "kpp": "<string>",
    "reason_for_trade": "<string>",
    "reference_information": "<string>",
    "russian_central_bank_account": "<string>",
    "swift_code": "<string>",
    "vo": "<string>",
    "address_line_1": "<string>",
    "apartment_office_number": "<string>",
    "beneficiary_reference": "<string>",
    "building_number": "<string>",
    "city": "<string>",
    "email_addresses": [
      "jsmith@example.com"
    ],
    "floor": "<string>",
    "post_code": "<string>",
    "state_region": "<string>",
    "street_name": "<string>"
  }
]
'

import requests

url = "https://{environment}.ebury.io/mass-beneficiaries"

payload = [
    {
        "bank_country_code": "<string>",
        "bank_currency_code": "<string>",
        "country_code": "<string>",
        "email_notification": True,
        "name": "<string>",
        "account_number": "<string>",
        "bank_address_line_1": "<string>",
        "bank_identifier": "<string>",
        "bank_name": "<string>",
        "correspondent_account": "<string>",
        "correspondent_swift_code": "<string>",
        "iban": "<string>",
        "inn": "<string>",
        "kbk": "<string>",
        "kio": "<string>",
        "kpp": "<string>",
        "reason_for_trade": "<string>",
        "reference_information": "<string>",
        "russian_central_bank_account": "<string>",
        "swift_code": "<string>",
        "vo": "<string>",
        "address_line_1": "<string>",
        "apartment_office_number": "<string>",
        "beneficiary_reference": "<string>",
        "building_number": "<string>",
        "city": "<string>",
        "email_addresses": ["jsmith@example.com"],
        "floor": "<string>",
        "post_code": "<string>",
        "state_region": "<string>",
        "street_name": "<string>"
    }
]
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      bank_country_code: '<string>',
      bank_currency_code: '<string>',
      country_code: '<string>',
      email_notification: true,
      name: '<string>',
      account_number: '<string>',
      bank_address_line_1: '<string>',
      bank_identifier: '<string>',
      bank_name: '<string>',
      correspondent_account: '<string>',
      correspondent_swift_code: '<string>',
      iban: '<string>',
      inn: '<string>',
      kbk: '<string>',
      kio: '<string>',
      kpp: '<string>',
      reason_for_trade: '<string>',
      reference_information: '<string>',
      russian_central_bank_account: '<string>',
      swift_code: '<string>',
      vo: '<string>',
      address_line_1: '<string>',
      apartment_office_number: '<string>',
      beneficiary_reference: '<string>',
      building_number: '<string>',
      city: '<string>',
      email_addresses: ['jsmith@example.com'],
      floor: '<string>',
      post_code: '<string>',
      state_region: '<string>',
      street_name: '<string>'
    }
  ])
};

fetch('https://{environment}.ebury.io/mass-beneficiaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.ebury.io/mass-beneficiaries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'bank_country_code' => '<string>',
        'bank_currency_code' => '<string>',
        'country_code' => '<string>',
        'email_notification' => true,
        'name' => '<string>',
        'account_number' => '<string>',
        'bank_address_line_1' => '<string>',
        'bank_identifier' => '<string>',
        'bank_name' => '<string>',
        'correspondent_account' => '<string>',
        'correspondent_swift_code' => '<string>',
        'iban' => '<string>',
        'inn' => '<string>',
        'kbk' => '<string>',
        'kio' => '<string>',
        'kpp' => '<string>',
        'reason_for_trade' => '<string>',
        'reference_information' => '<string>',
        'russian_central_bank_account' => '<string>',
        'swift_code' => '<string>',
        'vo' => '<string>',
        'address_line_1' => '<string>',
        'apartment_office_number' => '<string>',
        'beneficiary_reference' => '<string>',
        'building_number' => '<string>',
        'city' => '<string>',
        'email_addresses' => [
                'jsmith@example.com'
        ],
        'floor' => '<string>',
        'post_code' => '<string>',
        'state_region' => '<string>',
        'street_name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{environment}.ebury.io/mass-beneficiaries"

	payload := strings.NewReader("[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{environment}.ebury.io/mass-beneficiaries")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/mass-beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "mass_beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": {
    "code": "<string>",
    "details": "<string>",
    "message": "<string>"
  },
  "links": {
    "errors_href": "<string>",
    "created_href": "<string>"
  },
  "summary": {
    "received": 123,
    "created": 123,
    "errored": 123
  },
  "status": "pending"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "NOT_VALID_CONTENT_TYPE",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

POST

mass-beneficiaries

Create a mass beneficiary instruction

curl --request POST \
  --url https://{environment}.ebury.io/mass-beneficiaries \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "bank_country_code": "<string>",
    "bank_currency_code": "<string>",
    "country_code": "<string>",
    "email_notification": true,
    "name": "<string>",
    "account_number": "<string>",
    "bank_address_line_1": "<string>",
    "bank_identifier": "<string>",
    "bank_name": "<string>",
    "correspondent_account": "<string>",
    "correspondent_swift_code": "<string>",
    "iban": "<string>",
    "inn": "<string>",
    "kbk": "<string>",
    "kio": "<string>",
    "kpp": "<string>",
    "reason_for_trade": "<string>",
    "reference_information": "<string>",
    "russian_central_bank_account": "<string>",
    "swift_code": "<string>",
    "vo": "<string>",
    "address_line_1": "<string>",
    "apartment_office_number": "<string>",
    "beneficiary_reference": "<string>",
    "building_number": "<string>",
    "city": "<string>",
    "email_addresses": [
      "jsmith@example.com"
    ],
    "floor": "<string>",
    "post_code": "<string>",
    "state_region": "<string>",
    "street_name": "<string>"
  }
]
'

import requests

url = "https://{environment}.ebury.io/mass-beneficiaries"

payload = [
    {
        "bank_country_code": "<string>",
        "bank_currency_code": "<string>",
        "country_code": "<string>",
        "email_notification": True,
        "name": "<string>",
        "account_number": "<string>",
        "bank_address_line_1": "<string>",
        "bank_identifier": "<string>",
        "bank_name": "<string>",
        "correspondent_account": "<string>",
        "correspondent_swift_code": "<string>",
        "iban": "<string>",
        "inn": "<string>",
        "kbk": "<string>",
        "kio": "<string>",
        "kpp": "<string>",
        "reason_for_trade": "<string>",
        "reference_information": "<string>",
        "russian_central_bank_account": "<string>",
        "swift_code": "<string>",
        "vo": "<string>",
        "address_line_1": "<string>",
        "apartment_office_number": "<string>",
        "beneficiary_reference": "<string>",
        "building_number": "<string>",
        "city": "<string>",
        "email_addresses": ["jsmith@example.com"],
        "floor": "<string>",
        "post_code": "<string>",
        "state_region": "<string>",
        "street_name": "<string>"
    }
]
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      bank_country_code: '<string>',
      bank_currency_code: '<string>',
      country_code: '<string>',
      email_notification: true,
      name: '<string>',
      account_number: '<string>',
      bank_address_line_1: '<string>',
      bank_identifier: '<string>',
      bank_name: '<string>',
      correspondent_account: '<string>',
      correspondent_swift_code: '<string>',
      iban: '<string>',
      inn: '<string>',
      kbk: '<string>',
      kio: '<string>',
      kpp: '<string>',
      reason_for_trade: '<string>',
      reference_information: '<string>',
      russian_central_bank_account: '<string>',
      swift_code: '<string>',
      vo: '<string>',
      address_line_1: '<string>',
      apartment_office_number: '<string>',
      beneficiary_reference: '<string>',
      building_number: '<string>',
      city: '<string>',
      email_addresses: ['jsmith@example.com'],
      floor: '<string>',
      post_code: '<string>',
      state_region: '<string>',
      street_name: '<string>'
    }
  ])
};

fetch('https://{environment}.ebury.io/mass-beneficiaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.ebury.io/mass-beneficiaries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'bank_country_code' => '<string>',
        'bank_currency_code' => '<string>',
        'country_code' => '<string>',
        'email_notification' => true,
        'name' => '<string>',
        'account_number' => '<string>',
        'bank_address_line_1' => '<string>',
        'bank_identifier' => '<string>',
        'bank_name' => '<string>',
        'correspondent_account' => '<string>',
        'correspondent_swift_code' => '<string>',
        'iban' => '<string>',
        'inn' => '<string>',
        'kbk' => '<string>',
        'kio' => '<string>',
        'kpp' => '<string>',
        'reason_for_trade' => '<string>',
        'reference_information' => '<string>',
        'russian_central_bank_account' => '<string>',
        'swift_code' => '<string>',
        'vo' => '<string>',
        'address_line_1' => '<string>',
        'apartment_office_number' => '<string>',
        'beneficiary_reference' => '<string>',
        'building_number' => '<string>',
        'city' => '<string>',
        'email_addresses' => [
                'jsmith@example.com'
        ],
        'floor' => '<string>',
        'post_code' => '<string>',
        'state_region' => '<string>',
        'street_name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{environment}.ebury.io/mass-beneficiaries"

	payload := strings.NewReader("[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{environment}.ebury.io/mass-beneficiaries")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/mass-beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"bank_country_code\": \"<string>\",\n    \"bank_currency_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"email_notification\": true,\n    \"name\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"bank_address_line_1\": \"<string>\",\n    \"bank_identifier\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"correspondent_account\": \"<string>\",\n    \"correspondent_swift_code\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"inn\": \"<string>\",\n    \"kbk\": \"<string>\",\n    \"kio\": \"<string>\",\n    \"kpp\": \"<string>\",\n    \"reason_for_trade\": \"<string>\",\n    \"reference_information\": \"<string>\",\n    \"russian_central_bank_account\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"vo\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"apartment_office_number\": \"<string>\",\n    \"beneficiary_reference\": \"<string>\",\n    \"building_number\": \"<string>\",\n    \"city\": \"<string>\",\n    \"email_addresses\": [\n      \"jsmith@example.com\"\n    ],\n    \"floor\": \"<string>\",\n    \"post_code\": \"<string>\",\n    \"state_region\": \"<string>\",\n    \"street_name\": \"<string>\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "mass_beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": {
    "code": "<string>",
    "details": "<string>",
    "message": "<string>"
  },
  "links": {
    "errors_href": "<string>",
    "created_href": "<string>"
  },
  "summary": {
    "received": 123,
    "created": 123,
    "errored": 123
  },
  "status": "pending"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "NOT_VALID_CONTENT_TYPE",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

Headers

Authorization

string

required

The access token.

Query Parameters

client_id

string

required

The identifier of a client.

Body

application/json

The list of beneficiaries to create.

bank_country_code

string

required

The ISO 3166-1 alpha-2 code of the bank's country.

Pattern: [A-Z]{2}

bank_currency_code

string

required

The ISO 4217 code of the bank account's currency.

Pattern: [A-Z]{3}

country_code

string

required

The ISO 3166-1 alpha-2 code of the beneficiary's country.

Pattern: [A-Z]{2}

email_notification

boolean

required

Whether the beneficiary should receive email notification of payments.

name

string

required

The name of the beneficiary.

account_number

string

The account number of the bank account.

bank_address_line_1

string

The first address line of the bank.

bank_identifier

string

The identifier of the bank.

bank_name

string

Name of the bank account holder.

correspondent_account

string

The account for the correspondant account of the bank.

correspondent_swift_code

string

The SWIFT code for the correspondant account of the bank.

iban

string

The IBAN of the bank account.

inn

string

The INN of the bank account.

kbk

string

The KBK of the bank account.

kio

string

The KIO of the bank account.

kpp

string

The KPP of the bank account.

purpose_of_payment

enum<string>

Text explaining the purpose of payment. Required by the Central Bank for all payments sent to China (CHN) in the Chinese Renminbi (CNY) currency or United Arab Emirates in any currency (GDE to RDA) [Coming soon].

Available options:

/CGODDR/,

/CGODDR/PART/,

/CGODDR/RETN/,

/CSTRDR/,

/CSTRDR/PART/,

/CSTRDR/RETN/,

/COCADR/,

/COCADR/RTN/,

/CCTFDR/,

/CCTFDR/PART/,

/CCTFDR/RETN/,

/CCDNDR/,

/CCDNDR/RTN/,

GDE,

GDI,

GMS,

STS,

ATS,

OTS,

STR,

SCO,

INS,

FIS,

IPC,

TCS,

ITS,

IFS,

RDS,

PMS,

TTS,

PRS,

GOS,

SAL,

IGD,

IID,

PIP,

PRR,

DOE,

ISH,

ISL,

ISS,

IOL,

IOD,

GRI,

CHC,

EDU,

ALW,

AES,

LAS,

OVT,

TKT,

SAA,

COP,

COM,

EOS,

BON,

PEN,

UTL,

DCP,

LND,

LIP,

IPO,

POR,

RNT,

LNC,

EMI,

DIV,

ACM,

CCP,

POS,

MCR,

CIN,

TOF,

IGT,

OAT,

SVI,

SVO,

SVP,

MWI,

MWO,

MWP,

PRP,

PRW,

IRP,

IRW,

CEA,

PPA,

DSF,

DLF,

FSA,

FIA,

DSA,

DLA,

FDA,

AFA,

SLA,

LLA,

LEA,

RFS,

TCR,

CEL,

PPL,

LDS,

LDL,

FSL,

FIL,

DSL,

DLL,

FDL,

AFL,

SLL,

LLL,

LEL,

RLS,

TCP,

TAX,

REL,

RDL,

REA,

RDA

reason_for_trade

string

The reason for trade of the bank account.

reference_information

string

The reference information of the bank account.

russian_central_bank_account

string

The Russian central account number of the bank account.

swift_code

string

The SWIFT code of the bank account.

string

The VO of the bank account.

address_line_1

string

The first address line of the beneficiary.

apartment_office_number

string

The apartment/office number of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 70

beneficiary_reference

string

The reference for the beneficiary.

Maximum string length: 255

Pattern: ^[\sa-zA-Z0-9\d,\.:'\+\?'\-/]*$

building_number

string

The building number of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 16

city

string

The city of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 35

email_addresses

string<email>[]

The list of beneficiary's email addresses.

floor

string

The floor of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 70

post_code

string

The post code of the beneficiary.

state_region

string

The state/region of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 35

street_name

string

The street name of the beneficiary. Does not apply to Ebury Mass Payments customers.

Maximum string length: 70

Response

Mass beneficiary request accepted, see response body for status

This model is a representation of a mass beneficiary.

mass_beneficiary_id

string<uuid>

required

Unique UUID of the mass beneficiary.

error

object | null

required

The generic error message for the mass beneficiary request, if any.

Show child attributes

links

object

required

Links to the resources related to the errored and successfully created beneficiaries of a mass beneficiary. The mass_beneficiary_id does not need to be stored, as these resources may be accessed with the provided links.

Show child attributes

summary

object

required

Categorized counters for the mass beneficiary.

Show child attributes

status

enum<string>

required

The status of a mass beneficiary instruction:

pending: The mass beneficiary is pending to be processed.
creating: The mass beneficiary is being processed.
created: The mass beneficiary has been successfully processed.
failed: The mass beneficiary has failed during processing.
unknown: The mass beneficiary has an unknown status.

Available options:

pending,

creating,

created,

failed,

unknown

Overview

Endpoints

Data models

Create a mass beneficiary instruction

Headers

Query Parameters

Body

Response