Create a drawdown

curl --request POST \
  --url https://{environment}.ebury.io/drawdowns \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 1.01,
  "value_date": "<string>",
  "use_margin": false,
  "convert": false,
  "auto_confirm_value_date": false,
  "external_reference_id": "<string>"
}
'

import requests

url = "https://{environment}.ebury.io/drawdowns"

payload = {
    "amount": 1.01,
    "value_date": "<string>",
    "use_margin": False,
    "convert": False,
    "auto_confirm_value_date": False,
    "external_reference_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({
    amount: 1.01,
    value_date: '<string>',
    use_margin: false,
    convert: false,
    auto_confirm_value_date: false,
    external_reference_id: '<string>'
  })
};

fetch('https://{environment}.ebury.io/drawdowns', 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/drawdowns",
  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([
    'amount' => 1.01,
    'value_date' => '<string>',
    'use_margin' => false,
    'convert' => false,
    'auto_confirm_value_date' => false,
    'external_reference_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/drawdowns"

	payload := strings.NewReader("{\n  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_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/drawdowns")
  .header("Authorization", "<authorization>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/drawdowns")

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  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_id\": \"<string>\"\n}"

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

{
  "trade_id": "<string>",
  "amount_to_transfer": 123,
  "buy_amount": 123,
  "sell_amount": 123,
  "rate": "<string>",
  "reason_for_trade": "<string>",
  "external_reference_id": "<string>",
  "convert": true,
  "value_date": "<string>",
  "deposit_not_used": "<string>",
  "bank_account": {},
  "fee": {},
  "fee_bank_account": {}
}

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

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

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

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

POST

drawdowns

Create a drawdown

curl --request POST \
  --url https://{environment}.ebury.io/drawdowns \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 1.01,
  "value_date": "<string>",
  "use_margin": false,
  "convert": false,
  "auto_confirm_value_date": false,
  "external_reference_id": "<string>"
}
'

import requests

url = "https://{environment}.ebury.io/drawdowns"

payload = {
    "amount": 1.01,
    "value_date": "<string>",
    "use_margin": False,
    "convert": False,
    "auto_confirm_value_date": False,
    "external_reference_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({
    amount: 1.01,
    value_date: '<string>',
    use_margin: false,
    convert: false,
    auto_confirm_value_date: false,
    external_reference_id: '<string>'
  })
};

fetch('https://{environment}.ebury.io/drawdowns', 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/drawdowns",
  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([
    'amount' => 1.01,
    'value_date' => '<string>',
    'use_margin' => false,
    'convert' => false,
    'auto_confirm_value_date' => false,
    'external_reference_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/drawdowns"

	payload := strings.NewReader("{\n  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_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/drawdowns")
  .header("Authorization", "<authorization>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/drawdowns")

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  \"amount\": 1.01,\n  \"value_date\": \"<string>\",\n  \"use_margin\": false,\n  \"convert\": false,\n  \"auto_confirm_value_date\": false,\n  \"external_reference_id\": \"<string>\"\n}"

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

{
  "trade_id": "<string>",
  "amount_to_transfer": 123,
  "buy_amount": 123,
  "sell_amount": 123,
  "rate": "<string>",
  "reason_for_trade": "<string>",
  "external_reference_id": "<string>",
  "convert": true,
  "value_date": "<string>",
  "deposit_not_used": "<string>",
  "bank_account": {},
  "fee": {},
  "fee_bank_account": {}
}

{
  "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 drawdown from an existing window forward trade.

You need to have a valid forward trade_id to create a drawdown.

Authorizations

x-api-key

string

header

required

An API Key.

Headers

Authorization

string

required

The access token

X-Contact-ID

string

The ID of the contact

Query Parameters

client_id

string

required

The ID of the client

trade_id

string

required

The ID of the forward trade to draw down from

Body

application/json

Request Payload

amount

number<double>

required

The amount to draw down

Required range: x >= 0.01

direction

enum<string>

required

The direction of the amount

Available options:

buy,

sell

value_date

string

required

The T+2 value date for the drawdown in YYYY-MM-DD or YYYY/MM/DD format

Pattern: ^\d{4}[-/]\d{2}[-/]\d{2}$

reason_for_trade

enum<string>

required

Reason for trade

Available options:

charitable_aid,

payment_for_goods,

capital_investment,

payment_for_services,

repatriation_of_goods,

repatriation_of_services,

property_purchase,

mortage_repayment,

property_rental_or_maintenance,

salary_payroll,

travel_costs,

living_costs,

repayment_of_loan,

balance_hedging,

repatriation_from_investment,

portfolio_netting,

other

use_margin

boolean

default:false

required

Whether to use any available margin from the forward trade to fund the drawdown

convert

boolean

default:false

required

Intention behind the drawdown. When set to true, drawdown will be executed and funds will be transferred between two Ebury wallets. When false, drawdown will be executed only when it is linked to at least one payment

auto_confirm_value_date

boolean

default:false

When set to true, the next available value date will be used if the requested T+2 date is invalid. When false, the request will fail if the value date is not valid

external_reference_id

string

API external reference id for the drawdown. Maximum 128 characters. Alphanumeric, hyphens, and underscores only

Maximum string length: 128

Pattern: ^[a-zA-Z0-9_-]*$

Response

Drawdown created

trade_id

string

required

Drawdown trade identifier

amount_to_transfer

number<double>

The amount to be transferred

buy_amount

number<double>

The amount in the buy currency

sell_amount

number<double>

The amount in the sell currency

rate

string

The exchange rate applied

reason_for_trade

string

The reason for trade specified in the request

external_reference_id

string

Your external reference ID if provided

convert

boolean

Whether funds will be converted

value_date

string

The value date for the drawdown

deposit_not_used

string

Amount of deposit not used from the forward trade

bank_account

object

Bank account details for funding the drawdown

fee

object

Fee details for the drawdown, including payment and trade fees

fee_bank_account

object

Bank account details for the fee payment