Skip to main content
POST
/
v1
/
payment_runs
Create a payment run
curl --request POST \
  --url https://api.yorlet.com/v1/payment_runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "gbp",
  "description": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "payment_run",
  "amount": 123,
  "approved_at": 123,
  "completed_at": 123,
  "currency": "gbp",
  "description": "<string>",
  "payout_status": {
    "canceled": 123,
    "failed": 123,
    "paid": 123,
    "total": 123
  },
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
currency
enum<string>
required

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

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

"gbp"

​
type
enum<string>
required

The type of payment run to create.

Available options:
all,
landlord,
supplier
​
description
string

An arbitrary string attached to the object. Often useful for displaying to users.

​
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.

​
method
enum<string>

The method used to issue payouts in the payment run.

Available options:
manual,
automatic
​
region
enum<string>

The region of payouts to include in this payment run.

Available options:
all,
domestic,
international

Response

200 - application/json

Returns the created payment run.

​
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:
payment_run
​
amount
number
required

The total amount of all payouts in the payment run.

​
approved_at
integer | null
required

The time at which the payment run was approved.

​
completed_at
integer | null
required

The time at which the payment run completed.

​
currency
enum<string>
required

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

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

"gbp"

​
description
string | null
required

An arbitrary string attached to the object. Often useful for displaying to users.

​
method
enum<string> | null
required

The method used to issue payouts in the payment run.

Available options:
manual,
automatic,
null
​
payout_status
object
required

A breakdown of the payout statuses within this run.

​
region
enum<string> | null
required

The region of payouts included in this payment run.

Available options:
all,
domestic,
international,
null
​
status
enum<string>
required

The current status of the payment run.

Available options:
requires_approval,
processing,
complete,
canceled
​
type
enum<string>
required

The type of payment run to create.

Available options:
all,
landlord,
supplier
​
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.

​
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.