Skip to main content
POST
/
customer
/
transfer
Create Client Transfer
curl --request POST \
  --url https://api.example.com/customer/transfer \
  --header 'Content-Type: application/json' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
  --header 'X-API-TIMESTAMP: <x-api-timestamp>' \
  --data '
{
  "sending_account_id": "<string>",
  "counterparty_account_id": "<string>",
  "amount": 123,
  "note": "<string>"
}
'
import requests

url = "https://api.example.com/customer/transfer"

payload = {
"sending_account_id": "<string>",
"counterparty_account_id": "<string>",
"amount": 123,
"note": "<string>"
}
headers = {
"X-API-SIGNATURE": "<x-api-signature>",
"X-API-TIMESTAMP": "<x-api-timestamp>",
"X-API-NONCE": "<x-api-nonce>",
"X-API-SUBSCRIPTION-KEY": "<x-api-subscription-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'X-API-SIGNATURE': '<x-api-signature>',
'X-API-TIMESTAMP': '<x-api-timestamp>',
'X-API-NONCE': '<x-api-nonce>',
'X-API-SUBSCRIPTION-KEY': '<x-api-subscription-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sending_account_id: '<string>',
counterparty_account_id: '<string>',
amount: 123,
note: '<string>'
})
};

fetch('https://api.example.com/customer/transfer', 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://api.example.com/customer/transfer",
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([
'sending_account_id' => '<string>',
'counterparty_account_id' => '<string>',
'amount' => 123,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-NONCE: <x-api-nonce>",
"X-API-SIGNATURE: <x-api-signature>",
"X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>",
"X-API-TIMESTAMP: <x-api-timestamp>"
],
]);

$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://api.example.com/customer/transfer"

payload := strings.NewReader("{\n \"sending_account_id\": \"<string>\",\n \"counterparty_account_id\": \"<string>\",\n \"amount\": 123,\n \"note\": \"<string>\"\n}")

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

req.Header.Add("X-API-SIGNATURE", "<x-api-signature>")
req.Header.Add("X-API-TIMESTAMP", "<x-api-timestamp>")
req.Header.Add("X-API-NONCE", "<x-api-nonce>")
req.Header.Add("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-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://api.example.com/customer/transfer")
.header("X-API-SIGNATURE", "<x-api-signature>")
.header("X-API-TIMESTAMP", "<x-api-timestamp>")
.header("X-API-NONCE", "<x-api-nonce>")
.header("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
.header("Content-Type", "application/json")
.body("{\n \"sending_account_id\": \"<string>\",\n \"counterparty_account_id\": \"<string>\",\n \"amount\": 123,\n \"note\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/customer/transfer")

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

request = Net::HTTP::Post.new(url)
request["X-API-SIGNATURE"] = '<x-api-signature>'
request["X-API-TIMESTAMP"] = '<x-api-timestamp>'
request["X-API-NONCE"] = '<x-api-nonce>'
request["X-API-SUBSCRIPTION-KEY"] = '<x-api-subscription-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sending_account_id\": \"<string>\",\n \"counterparty_account_id\": \"<string>\",\n \"amount\": 123,\n \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "data": {
    "transaction_id": "123123123123",
    "sending_account_id": "1234abcd",
    "counterparty_account_id": "987654321",
    "amount": 100,
    "note": "Payment for invoice #1234"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

x-idempotency-key
string | null
source
string | null
X-API-SIGNATURE
string
required

Signature header

X-API-TIMESTAMP
integer
required

Timestamp header

X-API-NONCE
string
required

Nonce header

X-API-SUBSCRIPTION-KEY
string
required

Account ID header

Body

application/json

Schema to deserialize the transaction transfer request.

sending_account_id
string
required

Account id

Example:

"1234abcd"

counterparty_account_id
string
required

Counterparty account number

Example:

"987654321"

amount
number
required

Amount

Required range: x <= 100000000
Example:

100

note
string
required

Note

Example:

"Payment for invoice #1234"

Response

Successful Response

message
string
required
data
ClientCreateTransferResponse · object | null

Schema to serialize the transaction transfer response.