curl --request POST \
--url https://api.yorlet.com/v1/owner_payouts/{id}/cancel \
--header 'Authorization: <api-key>'{
"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": {}
}curl --request POST \
--url https://api.yorlet.com/v1/owner_payouts/{id}/cancel \
--header 'Authorization: <api-key>'{
"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": {}
}API Key authentication. Use "Bearer YOUR_API_KEY".
The id identifier.
Returns the cancelled owner payout.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
owner_payout Must be a Unix timestamp in UTC time.
Must be a Unix timestamp in UTC time.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
Must be a Unix timestamp in UTC time.
Show child attributes
Show child attributes
automatic, manual, null Show child attributes
Must be a Unix timestamp in UTC time.
Show child attributes
draft, pending, in_transit, requires_payment, paid, failed, canceled landlord, leaseholder, supplier, owner, null The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
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.
Show child attributes
Was this page helpful?