Skip to main content
A payout is one movement of money out to a recipient. It carries what left the account, what arrived, the identifiers each rail hands back for tracing it, and the trail of states it passed through. Amounts are decimal strings, not numbers. Most of the tracing identifiers are null until the rail assigns them, and some never apply. A bank payout has no transaction hash, and a crypto payout has no wire reference.

Example

What the payout is

The money

from_amount and to_amount are strings — "1000.00", not 1000.00. Parse them as decimals rather than floats, and expect them to differ. The gap is the fees and the conversion.

Tracing it with the rail

Which of these arrive depends on the rail, and each is null until the rail hands it back.

What you attached

What the bank received

On an austin_capital_trust account the bank reads the memo in English and within the rail’s limit, so it can receive a different text from the one you wrote. sent_to_bank is that text. It is null until the payout is sent, and on other accounts.

Who was on each end

Both carry a name joined from the names on record, a company_name, the country on the address as an ISO 3166-1 code, the bank_name, and a bank_account the bank has already masked. name is null on a party with no personal name on file, as the example above shows.

What happened

Each entry carries an event_id, the status it moved to, a created_at, and a message. The message is a sentence for people about that step, absent when the step has none. On a failure or a hold the message names the reason when it is one you can fix, such as a recipient missing its intermediary bank’s routing number. Branch on status, not on the message. Each one is a value status takes, but KYT_PENDING and NEEDS_ACTION never appear here.

Proof it arrived

The array is [] until a proof is published. That happens only after the payout is COMPLETED, and can take days. Each entry carries a reference, a type, details and a created_at, all null when the delivering bank gave none, and its documents. Each document carries a file_name, a content_type, a size_bytes and a url. The url is a download link valid for ten minutes, so read the payout again for a fresh one rather than storing it.