Skip to main content
The values each enumerated field on a payout takes. Check it when you are branching on a field’s value or filtering a listing.

payout status

Where a payout is in its lifecycle. A listing filters on the eight values below, and any of them can come back on a row.
A ninth value, NEEDS_ACTION, can come back on a row. It is not a stage. Treat the set as open. Read a value you do not recognise as a payout still in progress, and keep polling it.

payout origin

What started the payout.

nature_of_payment

What the payout is for. It decides whether a supporting document is required. A wire from an austin_capital_trust account sends the bank the purpose in the last column. With other, or without nature_of_payment, the bank receives your memo as the purpose. The bank reads both in English. A memo in another language is translated before it is sent, and the payout’s sent_to_bank shows what the bank received.

payout payment_method

Which rail the payout went out on, taken from the recipient. It comes back in lower case.