Transfers
Create a transfer
POST
/
v1
/
transfers
Create a transfer
curl --request POST \
--url https://api.yorlet.com/v1/transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2,
"currency": "gbp",
"destination": "<string>",
"apply_unit_fees": true,
"description": "<string>",
"metadata": {},
"owner_payment_data": {
"period": {
"end": 123,
"start": 123
}
},
"source_transaction": "<string>",
"unit": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/transfers"
payload = {
"amount": 2,
"currency": "gbp",
"destination": "<string>",
"apply_unit_fees": True,
"description": "<string>",
"metadata": {},
"owner_payment_data": { "period": {
"end": 123,
"start": 123
} },
"source_transaction": "<string>",
"unit": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2,
currency: 'gbp',
destination: '<string>',
apply_unit_fees: true,
description: '<string>',
metadata: {},
owner_payment_data: {period: {end: 123, start: 123}},
source_transaction: '<string>',
unit: '<string>'
})
};
fetch('https://api.yorlet.com/v1/transfers', 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.yorlet.com/v1/transfers",
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' => 2,
'currency' => 'gbp',
'destination' => '<string>',
'apply_unit_fees' => true,
'description' => '<string>',
'metadata' => [
],
'owner_payment_data' => [
'period' => [
'end' => 123,
'start' => 123
]
],
'source_transaction' => '<string>',
'unit' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.yorlet.com/v1/transfers"
payload := strings.NewReader("{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.yorlet.com/v1/transfers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "transfer",
"amount": 123,
"building": "<string>",
"currency": "gbp",
"description": "<string>",
"destination": "<string>",
"destination_owner_payment": "<string>",
"reporting_type": "<string>",
"source_invoice_item": "<string>",
"source_transaction": "<string>",
"transfer_group": "<string>",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"amount_reversed": 0,
"metadata": {},
"reversed": false
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
application/json
A positive integer representing the amount to transfer, in the smallest currency unit.
Required range:
x >= 1Three-letter ISO currency code, in lowercase. Must be a supported currency.
Available options:
gbp, usd, eur, sek Example:
"gbp"
The ID of the destination owner the funds are transferred to.
Whether to apply unit-specific fees to the transfer.
An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Additional data to apply to the resulting owner payment.
Show child attributes
Show child attributes
The reporting type used to categorize the transfer.
Available options:
charge, rent, deposit, other The ID of the source transaction the transfer is associated with.
The ID of the unit the transfer is associated with.
Response
200 - application/json
Returns the created transfer.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
transfer The amount transferred, in the smallest currency unit.
The ID of the building the transfer is associated with.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
Available options:
gbp, usd, eur, sek Example:
"gbp"
An arbitrary string attached to the object. Often useful for displaying to users.
The owner the funds are transferred to.
The owner payment created as a result of this transfer.
The reporting type used to categorize the transfer.
The source invoice item the transfer is associated with.
The ID of the source transaction the transfer is associated with.
A string that identifies this transfer as part of a group.
The ID of the unit the transfer is associated with.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The amount that has been reversed, in the smallest currency unit.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Whether the transfer has been fully reversed.
Was this page helpful?
Create a transfer
curl --request POST \
--url https://api.yorlet.com/v1/transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2,
"currency": "gbp",
"destination": "<string>",
"apply_unit_fees": true,
"description": "<string>",
"metadata": {},
"owner_payment_data": {
"period": {
"end": 123,
"start": 123
}
},
"source_transaction": "<string>",
"unit": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/transfers"
payload = {
"amount": 2,
"currency": "gbp",
"destination": "<string>",
"apply_unit_fees": True,
"description": "<string>",
"metadata": {},
"owner_payment_data": { "period": {
"end": 123,
"start": 123
} },
"source_transaction": "<string>",
"unit": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2,
currency: 'gbp',
destination: '<string>',
apply_unit_fees: true,
description: '<string>',
metadata: {},
owner_payment_data: {period: {end: 123, start: 123}},
source_transaction: '<string>',
unit: '<string>'
})
};
fetch('https://api.yorlet.com/v1/transfers', 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.yorlet.com/v1/transfers",
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' => 2,
'currency' => 'gbp',
'destination' => '<string>',
'apply_unit_fees' => true,
'description' => '<string>',
'metadata' => [
],
'owner_payment_data' => [
'period' => [
'end' => 123,
'start' => 123
]
],
'source_transaction' => '<string>',
'unit' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.yorlet.com/v1/transfers"
payload := strings.NewReader("{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.yorlet.com/v1/transfers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"currency\": \"gbp\",\n \"destination\": \"<string>\",\n \"apply_unit_fees\": true,\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner_payment_data\": {\n \"period\": {\n \"end\": 123,\n \"start\": 123\n }\n },\n \"source_transaction\": \"<string>\",\n \"unit\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "transfer",
"amount": 123,
"building": "<string>",
"currency": "gbp",
"description": "<string>",
"destination": "<string>",
"destination_owner_payment": "<string>",
"reporting_type": "<string>",
"source_invoice_item": "<string>",
"source_transaction": "<string>",
"transfer_group": "<string>",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"amount_reversed": 0,
"metadata": {},
"reversed": false
}