Skip to main content
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
    }
  },
  "reporting_type": "charge",
  "source_transaction": "<string>",
  "unit": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "transfer",
  "account": "<string>",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
amount
integer
required
Required range: x >= 1
​
currency
enum<string>
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

​
destination
string
required
​
apply_unit_fees
boolean
​
description
string
​
metadata
object

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.

​
owner_payment_data
object
​
reporting_type
enum<string>
Available options:
charge,
rent,
deposit,
other
​
source_transaction
string
​
unit
string

Response

200 - application/json

Returns the created transfer.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
transfer
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.