Skip to main content
POST
/
v1
/
owner_payouts
/
{id}
/
approve
/
preview
Preview an owner payout approval
curl --request POST \
  --url https://api.yorlet.com/v1/owner_payouts/{id}/approve/preview \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "metadata": {},
  "statement_descriptor": "<string>",
  "send_email": true
}
'
{
  "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>"
  },
  "net": 123,
  "number": "<string>",
  "owner": "<string>",
  "owner_balance_transaction": "<string>",
  "owner_non_resident_tax": {
    "deduction": 123,
    "details": {
      "country": "<string>",
      "certificate": "<string>",
      "certificate_date": 123
    },
    "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
  },
  "radar": {
    "no_fees": true
  },
  "statement_descriptor": "<string>",
  "transaction": "<string>",
  "unit": "<string>",
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Body

application/json
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 this payout.

Available options:
automatic,
manual
period
object

The period this payout covers.

statement_descriptor
string

The statement descriptor that will appear on the recipient bank statement.

send_email
boolean

Whether to send an email notification to the owner when the payout is approved.

Response

200 - application/json

Returns the previewed owner payout approval.

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

The payout amount, in the smallest currency unit.

approved_at
integer | null
required

The time at which the payout was approved.

canceled_at
integer | null
required

The time at which the payout was canceled.

client_secret
string | null
required

The client secret used to authorize the payout from the client side.

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.

destination
required

The external account the payout was sent to.

failed_at
integer | null
required

The time at which the payout failed.

failure_code
string | null
required

Error code explaining the reason for payout failure if available.

failure_message
string | null
required

Message to user further explaining the reason for payout failure if available.

failure_owner_balance_transaction
string | null
required

The owner balance transaction that records the payout failure.

hosted_payment_url
string | null
required

The URL of the hosted page for paying out this payout.

last_approval_error
object
required

The most recent approval error for the payout, if any.

last_outbound_payment_error
object
required

The most recent outbound payment error for the payout, if any.

method
enum<string> | null
required

The method used to issue this payout.

Available options:
automatic,
manual,
null
net
number
required

The net amount, in the smallest currency unit, after any fees or deductions.

number
string | null
required

A unique, identifying string that appears on emails sent for the payout.

owner
required

The owner the payout is for.

owner_balance_transaction
required

The owner balance transaction that describes the impact of this payout on the owner balance.

owner_non_resident_tax
object
required

Non-resident tax information applied to the owner's payout.

owner_tax_residency
string | null
required

Two-letter ISO code representing the owner's tax residency country.

paid_at
integer | null
required

The time at which the payout was paid.

payment_run
string | null
required

The ID of the payment run the payout was included in.

period
object
required

The period this payout covers.

radar
object
required

Radar-related information for this payout.

statement_descriptor
string | null
required

The statement descriptor that will appear on the recipient bank statement.

status
enum<string>
required

The current status of the payout.

Available options:
draft,
pending,
in_transit,
requires_payment,
paid,
failed,
canceled
transaction
string | null
required

The transaction used to settle the payout.

type
enum<string> | null
required

The type of owner the payout is for.

Available options:
landlord,
leaseholder,
supplier,
owner,
null
unit
string | null
required

The unit this payout is associated with, if any.

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.