Retrieve a card payout
Retrieves one payout within the authenticated merchant and mode scope.
Authorizations
Use the secret API key for the intended merchant and mode as the Bearer
token. Sandbox keys start with api_test_sk_. Send the key only from
your server environment.
Path Parameters
Payout identifier.
Unique opaque public identifier for a payout (po_ prefix + random alphanumeric suffix).
^po_[A-Za-z0-9]{24}$"po_Q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"
Response
Current recorded Payout. Inspect status and, for FAILED, failure_code and failure_message.
Public, PAN-free lifecycle representation of a card payout.
Unique opaque public identifier for a payout (po_ prefix + random alphanumeric suffix).
^po_[A-Za-z0-9]{24}$"po_Q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"
Payout amount in minor units.
x >= 12500
Canonical uppercase three-letter ISO 4217 currency code. Responses always return the original currency the payment was created in; a provider response never replaces it.
3^[A-Z]{3}$"EUR"
Merchant-visible payout state. PROCESSING means the provider
acknowledged the payout. SUCCEEDED and FAILED are terminal outcomes
confirmed from a validated provider result, not submission acknowledgement.
PENDING, PROCESSING, SUCCEEDED, FAILED "PROCESSING"
Canonical lower-case card-network brand, for example visa,
mastercard, or amex. The schema remains extensible; each operation
validates its supported brands separately.
"visa"
Last four digits of the destination card.
^[0-9]{4}$"1111"
Merchant-supplied recipient metadata stored with the payout.
Unix timestamp when the payout was created.
1719792000
Unix timestamp when the payout was last updated.
1719792060
Merchant-side reconciliation reference, if supplied.
1000000000 <= x <= 99999999991234567890
Stable Flowlix reason present only for a FAILED payout; never a raw provider code.
not_found, processor_error, processor_unavailable, generic_decline, do_not_honor, issuer_declined, insufficient_funds, invalid_number, invalid_expiry, expired_card, invalid_amount, invalid_currency, not_permitted, cardholder_limit, card_velocity_exceeded, lost_card, stolen_card, suspect_fraud, fraud_filter, three_d_secure_failed, three_d_secure_timeout, three_d_secure_not_supported, three_d_secure_error "do_not_honor"
Merchant-safe explanation present only for a FAILED payout.
1 - 255"The payout was declined by the issuer."