Skip to main content
GET
Retrieve a card payout

Authorizations

Authorization
string
header
required

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_id
string
required

Payout identifier. Unique opaque public identifier for a payout (po_ prefix + random alphanumeric suffix).

Pattern: ^po_[A-Za-z0-9]{24}$
Example:

"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.

id
string
required

Unique opaque public identifier for a payout (po_ prefix + random alphanumeric suffix).

Pattern: ^po_[A-Za-z0-9]{24}$
Example:

"po_Q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

amount
integer<int64>
required

Payout amount in minor units.

Required range: x >= 1
Example:

2500

currency
string
required

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.

Required string length: 3
Pattern: ^[A-Z]{3}$
Example:

"EUR"

status
enum<string>
required

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.

Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED
Example:

"PROCESSING"

card_brand
string
required

Canonical lower-case card-network brand, for example visa, mastercard, or amex. The schema remains extensible; each operation validates its supported brands separately.

Example:

"visa"

card_last4
string
required

Last four digits of the destination card.

Pattern: ^[0-9]{4}$
Example:

"1111"

recipient
object
required

Merchant-supplied recipient metadata stored with the payout.

created_at
integer<int64>
required

Unix timestamp when the payout was created.

Example:

1719792000

updated_at
integer<int64>
required

Unix timestamp when the payout was last updated.

Example:

1719792060

merchant_reference
integer<int64> | null

Merchant-side reconciliation reference, if supplied.

Required range: 1000000000 <= x <= 9999999999
Example:

1234567890

failure_code
enum<string> | null

Stable Flowlix reason present only for a FAILED payout; never a raw provider code.

Available options:
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
Example:

"do_not_honor"

failure_message
string | null

Merchant-safe explanation present only for a FAILED payout.

Required string length: 1 - 255
Example:

"The payout was declined by the issuer."