status field.
Sub-status
subStatus adds detail when there is some. It is null when the status says everything.
Payout lifecycle
- You create the payout. It is
pending. - Payve debits your wallet and sends the payout. It is
processing. - The bank or operator confirms. It becomes
successful, orfailedwith the money back in your wallet.
processing while that happens and becomes failed only when no route is left.
How to learn the outcome
- Webhooks, for speed. Payve posts an event when a transaction finishes. See Webhooks.
- A
GETon the object, for certainty.GET /v1/payouts/{id}returns the current status and a timeline inevents.
Filter by status
GET /v1/payouts?status=failed returns every payout whose status is failed, whatever its sub-status. The same filter works on pay-ins and conversions.
Other objects
These have their own vocabularies:Webhook payloads report the transaction’s detailed internal state in
data.status, which can be a
value such as credited or reversed. Branch on the event type, not on data.status. See
Webhook event object.
