Skip to main content
GET
List card payouts

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.

Query Parameters

​
search
string

Literal case-insensitive search over Payout IDs, merchant references, and recipient names. Exactly four digits also match the card's last four digits. With exactly one currency filter, a decimal amount also matches that exact major-unit amount: search=49.99&currency=EUR matches an amount of 4999 minor units. A decimal comma is accepted. Without one currency, numeric search uses only the text/card fields. % and _ are literal characters. Structured filters still apply.

Required string length: 2 - 255
​
limit
integer
default:10

Maximum number of payouts to return. Accepts values between 1 and 100.

Required range: 1 <= x <= 100
​
starting_after
string

Cursor for forward pagination. Provide the id of the last Payout in the previous page. Mutually exclusive with ending_before.

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

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

"po_Q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
ending_before
string

Cursor for backward pagination. Provide the id of the first Payout in the current page. Mutually exclusive with starting_after.

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

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

"po_Q7Mk2Np8Vr4Xt6Yz9Ab3Cd5E"

​
status
enum<string>[]

Repeat to filter by multiple aggregate payout statuses.

Maximum array length: 100

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
​
currency
string[]

Repeat to filter by multiple uppercase ISO 4217 currency codes.

Maximum array length: 100

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}$
​
card_brand
string[]

Repeat to filter by multiple canonical lower-case card brands.

Maximum array length: 100

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

​
card_last4
string

Exact last four digits of the destination card.

Pattern: ^[0-9]{4}$
​
created_gte
integer<int64>

Return payouts created on or after this Unix timestamp in seconds.

Required range: x >= 0
​
created_lt
integer<int64>

Return payouts created before this Unix timestamp in seconds.

Required range: x >= 0
​
amount_gte
integer<int64>

Return payouts with amount greater than or equal to this minor-unit amount.

Required range: x >= 0
​
amount_lte
integer<int64>

Return payouts with amount less than or equal to this minor-unit amount.

Required range: x >= 0

Response

Matching payouts, ordered newest first.

​
data
object[]
required

One page of payouts ordered newest first.

​
has_more
boolean
required

True when more payouts exist beyond this page in the requested direction.

Example:

true

​
total_count
integer<int64>
required

Exact number of payouts matching the merchant, mode, and filters before cursor pagination.

Required range: x >= 0
Example:

125