Create one or more payments

curl --request POST \
  --url https://{environment}.ebury.io/payments \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "async": true,
  "is_pad": false,
  "payments": [
    {
      "account_id": "<string>",
      "amount": 123,
      "beneficiary_id": "<string>",
      "payment_date": "2023-12-25",
      "reference": "<string>",
      "email_beneficiary": false,
      "is_pad": false
    }
  ],
  "trade_id": "<string>"
}
'

import requests

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

payload = {
    "async": True,
    "is_pad": False,
    "payments": [
        {
            "account_id": "<string>",
            "amount": 123,
            "beneficiary_id": "<string>",
            "payment_date": "2023-12-25",
            "reference": "<string>",
            "email_beneficiary": False,
            "is_pad": False
        }
    ],
    "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({
    async: true,
    is_pad: false,
    payments: [
      {
        account_id: '<string>',
        amount: 123,
        beneficiary_id: '<string>',
        payment_date: '2023-12-25',
        reference: '<string>',
        email_beneficiary: false,
        is_pad: false
      }
    ],
    trade_id: '<string>'
  })
};

fetch('https://{environment}.ebury.io/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/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([
    'async' => true,
    'is_pad' => false,
    'payments' => [
        [
                'account_id' => '<string>',
                'amount' => 123,
                'beneficiary_id' => '<string>',
                'payment_date' => '2023-12-25',
                'reference' => '<string>',
                'email_beneficiary' => false,
                'is_pad' => false
        ]
    ],
    '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/payments"

	payload := strings.NewReader("{\n  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\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/payments")
  .header("Authorization", "<authorization>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\n  \"trade_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/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  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\n  \"trade_id\": \"<string>\"\n}"

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

[
  {
    "fee_amount": 123,
    "fee_currency": "<string>",
    "payment_id": "<string>",
    "payment_instruction": "<string>",
    "payment_receipt": "<string>",
    "reference": "<string>",
    "status": "Need more beneficiary information",
    "warning": "<string>"
  }
]

[
  {
    "fee_amount": 123,
    "fee_currency": "<string>",
    "payment_id": "<string>",
    "payment_instruction": "<string>",
    "payment_receipt": "<string>",
    "reference": "<string>",
    "status": "Need more beneficiary information",
    "warning": "<string>"
  }
]

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

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

{
  "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

payments

Create one or more payments

curl --request POST \
  --url https://{environment}.ebury.io/payments \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "async": true,
  "is_pad": false,
  "payments": [
    {
      "account_id": "<string>",
      "amount": 123,
      "beneficiary_id": "<string>",
      "payment_date": "2023-12-25",
      "reference": "<string>",
      "email_beneficiary": false,
      "is_pad": false
    }
  ],
  "trade_id": "<string>"
}
'

import requests

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

payload = {
    "async": True,
    "is_pad": False,
    "payments": [
        {
            "account_id": "<string>",
            "amount": 123,
            "beneficiary_id": "<string>",
            "payment_date": "2023-12-25",
            "reference": "<string>",
            "email_beneficiary": False,
            "is_pad": False
        }
    ],
    "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({
    async: true,
    is_pad: false,
    payments: [
      {
        account_id: '<string>',
        amount: 123,
        beneficiary_id: '<string>',
        payment_date: '2023-12-25',
        reference: '<string>',
        email_beneficiary: false,
        is_pad: false
      }
    ],
    trade_id: '<string>'
  })
};

fetch('https://{environment}.ebury.io/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/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([
    'async' => true,
    'is_pad' => false,
    'payments' => [
        [
                'account_id' => '<string>',
                'amount' => 123,
                'beneficiary_id' => '<string>',
                'payment_date' => '2023-12-25',
                'reference' => '<string>',
                'email_beneficiary' => false,
                'is_pad' => false
        ]
    ],
    '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/payments"

	payload := strings.NewReader("{\n  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\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/payments")
  .header("Authorization", "<authorization>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\n  \"trade_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/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  \"async\": true,\n  \"is_pad\": false,\n  \"payments\": [\n    {\n      \"account_id\": \"<string>\",\n      \"amount\": 123,\n      \"beneficiary_id\": \"<string>\",\n      \"payment_date\": \"2023-12-25\",\n      \"reference\": \"<string>\",\n      \"email_beneficiary\": false,\n      \"is_pad\": false\n    }\n  ],\n  \"trade_id\": \"<string>\"\n}"

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

[
  {
    "fee_amount": 123,
    "fee_currency": "<string>",
    "payment_id": "<string>",
    "payment_instruction": "<string>",
    "payment_receipt": "<string>",
    "reference": "<string>",
    "status": "Need more beneficiary information",
    "warning": "<string>"
  }
]

[
  {
    "fee_amount": 123,
    "fee_currency": "<string>",
    "payment_id": "<string>",
    "payment_instruction": "<string>",
    "payment_receipt": "<string>",
    "reference": "<string>",
    "status": "Need more beneficiary information",
    "warning": "<string>"
  }
]

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

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

{
  "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 one or more payments with a beneficiary_id (mandatory only for trade-based payment and not needed for independent payments), account_id and with or without an existing trade_id. Payment processing can be made asynchronous by setting the async flag in the request body. Please note, payments can be submitted without a trade_id and they are referred to as independent payments. For these payments, there won’t be any currency conversion as the payment will be funded from the corresponding account’s balance. Therefore, these payments are not preceded by a conversion (quote and trade).

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

vop_authorization_id

string

VoP authorization ID to confirm not full-match payment

Body

application/json

Request Payload

A list of payments with known beneficiary/bank account IDs.

async

boolean

Create the payment(s) asynchronously. Payments are created synchronously by default.

is_pad

boolean

default:false

deprecated

Whether to fund payments via Pre-Authorized Debit (direct debit). Only valid for CAD and AUD payments with available credit. Deprecated; set is_pad per payment instead. Not honoured on the SCA (2FA) path.

payments

object[]

A list of payments

Show child attributes

trade_id

string

Unique identifier of the trade the payment is allocated to

Response

Payment(s) created synchronously

fee_amount

number<float>

Fee amount

fee_currency

string

Fee currency

payment_id

string

The payment identifier

payment_instruction

string<uri>

URI to download payment instruction

payment_receipt

string<uri>

URI to download payment receipt

reference

string

Payment reference

status

enum<string>

The current status of the payment

Available options:

Need more beneficiary information,

Validating beneficiary information,

Waiting for payment date,

Payment complete,

Executing Payment,

Payment pending of authorization,

Payment rejected,

Payment cancelled

warning

string

A warning is only returned if the requested value date was not valid and the next available date has been returned.