Skip to main content
POST
/
v1
/
owner_payouts
Create an owner payout
curl --request POST \
  --url https://api.yorlet.com/v1/owner_payouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "owner": "<string>",
  "description": "<string>",
  "metadata": {},
  "method": "automatic",
  "statement_descriptor": "<string>",
  "send_email": true,
  "options": {
    "apply_unit_restriction": true
  },
  "unit": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "owner_payout",
  "amount": 123,
  "approved_at": 123,
  "canceled_at": 123,
  "client_secret": "<string>",
  "currency": "gbp",
  "description": "<string>",
  "destination": "<string>",
  "failed_at": 123,
  "failure_code": "<string>",
  "failure_message": "<string>",
  "failure_owner_balance_transaction": "<string>",
  "hosted_payment_url": "<string>",
  "last_approval_error": {
    "message": "<string>",
    "type": "<string>"
  },
  "last_outbound_payment_error": {
    "message": "<string>",
    "type": "<string>"
  },
  "method": "automatic",
  "net": 123,
  "number": "<string>",
  "owner": "<string>",
  "owner_balance_transaction": "<string>",
  "owner_non_resident_tax": {
    "deduction": 123,
    "details": {
      "certificate": "<string>",
      "certificate_date": 123,
      "country": "<string>",
      "status": "exempt"
    },
    "taxable_amount": 123
  },
  "owner_tax_residency": "<string>",
  "paid_at": 123,
  "payment_run": "<string>",
  "period": {
    "adjustment_amount": 123,
    "adjustment_explanations": [
      {
        "id": "<string>",
        "adjustment_amount": 123,
        "amount": 123,
        "daily_rate": 123,
        "days": 123,
        "description": "<string>",
        "original_amount": 123,
        "period_breakdown": [
          {
            "days": 123,
            "period_start": 123,
            "period_end": 123,
            "prorated_amount": 123
          }
        ],
        "period_end": 123,
        "period_start": 123,
        "total_days": 123
      }
    ],
    "end": 123,
    "start": 123
  },
  "statement_descriptor": "<string>",
  "status": "draft",
  "transaction": "<string>",
  "type": "landlord",
  "unit": "<string>",
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
owner
string
required
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.

method
enum<string>
Available options:
automatic,
manual
period
object
statement_descriptor
string
send_email
boolean
options
object
unit
string

Response

200 - application/json

Returns the created owner payout.

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:
owner_payout
amount
number
required
approved_at
integer | null
required

Must be a Unix timestamp in UTC time.

canceled_at
integer | null
required

Must be a Unix timestamp in UTC time.

client_secret
string | null
required
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
destination
required
failed_at
integer | null
required

Must be a Unix timestamp in UTC time.

failure_code
string | null
required
failure_message
string | null
required
failure_owner_balance_transaction
string | null
required
hosted_payment_url
string | null
required
last_approval_error
object
required
last_outbound_payment_error
object
required
method
enum<string> | null
required
Available options:
automatic,
manual,
null
net
number
required
number
string | null
required
owner
required
owner_balance_transaction
required
owner_non_resident_tax
object
required
owner_tax_residency
string | null
required
paid_at
integer | null
required

Must be a Unix timestamp in UTC time.

payment_run
string | null
required
period
object
required
statement_descriptor
string | null
required
status
enum<string>
required
Available options:
draft,
pending,
in_transit,
requires_payment,
paid,
failed,
canceled
transaction
string | null
required
type
enum<string> | null
required
Available options:
landlord,
leaseholder,
supplier,
owner,
null
unit
string | null
required
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.