Create a mass payment instruction
curl --request POST \
--url https://{environment}.ebury.io/mass-payments \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"auto_commit": true,
"payment_instructions": [
{
"account_number": "<string>",
"bank_address": "<string>",
"bank_code": "<string>",
"bank_country": "<string>",
"bank_name": "<string>",
"beneficiary_address": "<string>",
"beneficiary_name": "<string>",
"beneficiary_country": "<string>",
"iban": "<string>",
"payment_currency": "<string>",
"payment_amount": 1,
"reason_for_trade": "<string>",
"swift_code": "<string>",
"trade_type": "spot",
"value_date": "<string>",
"payment_reference": "<string>",
"beneficiary_reference": "<string>",
"purpose_of_payment": "<string>",
"reference": "<string>",
"inn": "<string>",
"vo": "<string>",
"kio": "<string>",
"russian_central_bank_account": "<string>"
}
],
"external_reference_id": "",
"sell_currency": "<string>",
"trade_id": "<string>"
}
'import requests
url = "https://{environment}.ebury.io/mass-payments"
payload = {
"auto_commit": True,
"payment_instructions": [
{
"account_number": "<string>",
"bank_address": "<string>",
"bank_code": "<string>",
"bank_country": "<string>",
"bank_name": "<string>",
"beneficiary_address": "<string>",
"beneficiary_name": "<string>",
"beneficiary_country": "<string>",
"iban": "<string>",
"payment_currency": "<string>",
"payment_amount": 1,
"reason_for_trade": "<string>",
"swift_code": "<string>",
"trade_type": "spot",
"value_date": "<string>",
"payment_reference": "<string>",
"beneficiary_reference": "<string>",
"purpose_of_payment": "<string>",
"reference": "<string>",
"inn": "<string>",
"vo": "<string>",
"kio": "<string>",
"russian_central_bank_account": "<string>"
}
],
"external_reference_id": "",
"sell_currency": "<string>",
"trade_id": "<string>"
}
headers = {
"Authorization": "<authorization>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
auto_commit: true,
payment_instructions: [
{
account_number: '<string>',
bank_address: '<string>',
bank_code: '<string>',
bank_country: '<string>',
bank_name: '<string>',
beneficiary_address: '<string>',
beneficiary_name: '<string>',
beneficiary_country: '<string>',
iban: '<string>',
payment_currency: '<string>',
payment_amount: 1,
reason_for_trade: '<string>',
swift_code: '<string>',
trade_type: 'spot',
value_date: '<string>',
payment_reference: '<string>',
beneficiary_reference: '<string>',
purpose_of_payment: '<string>',
reference: '<string>',
inn: '<string>',
vo: '<string>',
kio: '<string>',
russian_central_bank_account: '<string>'
}
],
external_reference_id: '',
sell_currency: '<string>',
trade_id: '<string>'
})
};
fetch('https://{environment}.ebury.io/mass-payments', 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-payments",
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([
'auto_commit' => true,
'payment_instructions' => [
[
'account_number' => '<string>',
'bank_address' => '<string>',
'bank_code' => '<string>',
'bank_country' => '<string>',
'bank_name' => '<string>',
'beneficiary_address' => '<string>',
'beneficiary_name' => '<string>',
'beneficiary_country' => '<string>',
'iban' => '<string>',
'payment_currency' => '<string>',
'payment_amount' => 1,
'reason_for_trade' => '<string>',
'swift_code' => '<string>',
'trade_type' => 'spot',
'value_date' => '<string>',
'payment_reference' => '<string>',
'beneficiary_reference' => '<string>',
'purpose_of_payment' => '<string>',
'reference' => '<string>',
'inn' => '<string>',
'vo' => '<string>',
'kio' => '<string>',
'russian_central_bank_account' => '<string>'
]
],
'external_reference_id' => '',
'sell_currency' => '<string>',
'trade_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-payments"
payload := strings.NewReader("{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("x-api-key", "<api-key>")
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-payments")
.header("Authorization", "<authorization>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.ebury.io/mass-payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mass_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference_id": "<string>",
"mass_payment_status": "Queued for processing"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}Executing Mass Payments
Create a mass payment instruction
POST
/
mass-payments
Create a mass payment instruction
curl --request POST \
--url https://{environment}.ebury.io/mass-payments \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"auto_commit": true,
"payment_instructions": [
{
"account_number": "<string>",
"bank_address": "<string>",
"bank_code": "<string>",
"bank_country": "<string>",
"bank_name": "<string>",
"beneficiary_address": "<string>",
"beneficiary_name": "<string>",
"beneficiary_country": "<string>",
"iban": "<string>",
"payment_currency": "<string>",
"payment_amount": 1,
"reason_for_trade": "<string>",
"swift_code": "<string>",
"trade_type": "spot",
"value_date": "<string>",
"payment_reference": "<string>",
"beneficiary_reference": "<string>",
"purpose_of_payment": "<string>",
"reference": "<string>",
"inn": "<string>",
"vo": "<string>",
"kio": "<string>",
"russian_central_bank_account": "<string>"
}
],
"external_reference_id": "",
"sell_currency": "<string>",
"trade_id": "<string>"
}
'import requests
url = "https://{environment}.ebury.io/mass-payments"
payload = {
"auto_commit": True,
"payment_instructions": [
{
"account_number": "<string>",
"bank_address": "<string>",
"bank_code": "<string>",
"bank_country": "<string>",
"bank_name": "<string>",
"beneficiary_address": "<string>",
"beneficiary_name": "<string>",
"beneficiary_country": "<string>",
"iban": "<string>",
"payment_currency": "<string>",
"payment_amount": 1,
"reason_for_trade": "<string>",
"swift_code": "<string>",
"trade_type": "spot",
"value_date": "<string>",
"payment_reference": "<string>",
"beneficiary_reference": "<string>",
"purpose_of_payment": "<string>",
"reference": "<string>",
"inn": "<string>",
"vo": "<string>",
"kio": "<string>",
"russian_central_bank_account": "<string>"
}
],
"external_reference_id": "",
"sell_currency": "<string>",
"trade_id": "<string>"
}
headers = {
"Authorization": "<authorization>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
auto_commit: true,
payment_instructions: [
{
account_number: '<string>',
bank_address: '<string>',
bank_code: '<string>',
bank_country: '<string>',
bank_name: '<string>',
beneficiary_address: '<string>',
beneficiary_name: '<string>',
beneficiary_country: '<string>',
iban: '<string>',
payment_currency: '<string>',
payment_amount: 1,
reason_for_trade: '<string>',
swift_code: '<string>',
trade_type: 'spot',
value_date: '<string>',
payment_reference: '<string>',
beneficiary_reference: '<string>',
purpose_of_payment: '<string>',
reference: '<string>',
inn: '<string>',
vo: '<string>',
kio: '<string>',
russian_central_bank_account: '<string>'
}
],
external_reference_id: '',
sell_currency: '<string>',
trade_id: '<string>'
})
};
fetch('https://{environment}.ebury.io/mass-payments', 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-payments",
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([
'auto_commit' => true,
'payment_instructions' => [
[
'account_number' => '<string>',
'bank_address' => '<string>',
'bank_code' => '<string>',
'bank_country' => '<string>',
'bank_name' => '<string>',
'beneficiary_address' => '<string>',
'beneficiary_name' => '<string>',
'beneficiary_country' => '<string>',
'iban' => '<string>',
'payment_currency' => '<string>',
'payment_amount' => 1,
'reason_for_trade' => '<string>',
'swift_code' => '<string>',
'trade_type' => 'spot',
'value_date' => '<string>',
'payment_reference' => '<string>',
'beneficiary_reference' => '<string>',
'purpose_of_payment' => '<string>',
'reference' => '<string>',
'inn' => '<string>',
'vo' => '<string>',
'kio' => '<string>',
'russian_central_bank_account' => '<string>'
]
],
'external_reference_id' => '',
'sell_currency' => '<string>',
'trade_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-payments"
payload := strings.NewReader("{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("x-api-key", "<api-key>")
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-payments")
.header("Authorization", "<authorization>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.ebury.io/mass-payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_commit\": true,\n \"payment_instructions\": [\n {\n \"account_number\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_country\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"beneficiary_address\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"beneficiary_country\": \"<string>\",\n \"iban\": \"<string>\",\n \"payment_currency\": \"<string>\",\n \"payment_amount\": 1,\n \"reason_for_trade\": \"<string>\",\n \"swift_code\": \"<string>\",\n \"trade_type\": \"spot\",\n \"value_date\": \"<string>\",\n \"payment_reference\": \"<string>\",\n \"beneficiary_reference\": \"<string>\",\n \"purpose_of_payment\": \"<string>\",\n \"reference\": \"<string>\",\n \"inn\": \"<string>\",\n \"vo\": \"<string>\",\n \"kio\": \"<string>\",\n \"russian_central_bank_account\": \"<string>\"\n }\n ],\n \"external_reference_id\": \"\",\n \"sell_currency\": \"<string>\",\n \"trade_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mass_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference_id": "<string>",
"mass_payment_status": "Queued for processing"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}Create a new mass payment instruction in async mode only. A mass payment instruction requires either a single sell currency or existing trade ID to be specified in order to create an instruction. Note that within a mass payment instruction it is not possible to use different sell currencies per payment.
Please note that if a trade ID is being passed in the request, the payments in a mass payment instruction must be of the same BUY currency.
Authorizations
An API Key.
Query Parameters
The ID of the client
VoP authorization ID to confirm not full-match payment
Body
application/json
Request Payload
If true, send successful instructions for payment. If false, hold until customer hits commit endpoint.
Array of multiple payment instruction given by the customer.
Show child attributes
Show child attributes
The external reference: unique ID supplied by customer which can be used later to filter.
If trade_id omitted, sell_currency must be supplied.
Trade ID to book payments against. If customer wants the trade to be auto booked then this parameter should not be supplied.
Response
Masspayment request accepted, see response body for status
The UUID of the MassPayment just created
The external reference for the MassPayment, if supplied
This is an enumeration of the status of a MassPayment
Available options:
Queued for processing, Processing, Processed, Queued for creating, Creating, Created, Cancelled, Failed