Approve a payout

Type of the object. Always payout.

Id of a payout: payout_ followed by its key.

Your own key for the payout. null when not set.

What the payout is for. Shown to the recipient. Can span several lines. Without invoice, it is also the reference of the bank transfer, on one line. Banks can cut it short.

Amount in currency. Minimum 0.10.

Currency of amount and of the invoices. Open enum: treat an unknown value as a fallback case. Known values: USD, EUR, CHF, GBP.

Who is paid, discriminated on type. type is open on read; on write it is email or counterparty.

Lifecycle status. Open enum: treat an unknown value as a fallback case. Known values: created, approved, requested, completed, failed, expired.

A locked payout refuses PATCH and dashboard edits, except of tags. It can still be deleted.

The payout cannot be claimed or paid before this UTC day. null while availableInDays is set.

The recipient is paid this many days after the claim. A claim for the full amount sets availableOn to that UTC day and this field to null. null for a payout without this delay.

The days of the work the payout pays for, both inclusive. null when not set.

When a created or approved payout expires if it is not claimed or paid. Talentir moves it to expired within a day after this time. Every change to the payout moves the time later, and it is never before availableOn. null in other statuses, and when the team turned expiry off.

Your labels for the payout. Filter the list with ?tag=.

How the money is sent: the rail and the settlement currency. null until requested.

true: Talentir issues an invoice for the payout (VAT, e-invoice, Merchant of Record, DAC7). false: a plain payment without invoice, receipt or VAT.

URL of the invoice or receipt for your team. null while there is none.

URL of the recipient's invoice. null while there is none.

Who issued the recipient invoice: self_billing (Talentir, in the recipient's name), recipient_upload (the recipient), or payment_request (the recipient, for the payment request that the payout pays). Open enum. null while there is none.

Why the transfer failed, while status is failed. account_closed: the account no longer exists. account_invalid: the account details are wrong. name_mismatch: the account holder name does not match the counterparty. other: any other reason; failureReason explains it. Open enum. null in other statuses.

Why the transfer failed, in English, while status is failed and the reason is known. Never the payment provider's own text. For a developer, never shown to the recipient.

When the payout was last approved. null while status is created, and for a payout approved before May 2026.

Whether Talentir may notify the recipient. enabled: Talentir emails the claim link (and sends an SMS when the payout has a phone number) when send-claim-link or an andThen that sends it runs, a reminder follows, and a team member can send it from the dashboard. Nothing goes out before that. disabled: Talentir sends the recipient nothing and the dashboard cannot send the claim link; your own system shows or sends a link minted with POST /sessions.

The last time Talentir emailed the claim link. null when the sender sends its own link, or when the email could not be sent.

When the transfer was requested: the claim, or the pay call.

Set while a returned payout waits for the recipient's retry to deliver. null otherwise, also after the retry completes.

When the payout became completed. null before that.

When the payout was created.

When the payout was last updated.