Skip to main content
GET
/
v1
/
owner_payouts
List all owner payouts
curl --request GET \
  --url https://api.yorlet.com/v1/owner_payouts \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "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".

Response

200 - application/json

Returns the list of owner payouts.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required