Skip to main content
GET
cURL

Prefunded Payout History

Prefunded payouts are available only to organizations with a prefunded wallet. Check your balance with Fetch Balance.

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Query Parameters

payout_status
string

Filter payouts by status (e.g., SUCCESS, FAILED, PROCESSING)

Example:

"SUCCESS"

customer_id
string<uuid>

Filter payouts by customer ID

Example:

"dfd8db74-2fbb-46d1-9a93-b90f156e13b4"

start_date
string<date>

Filter payouts created on or after this date (YYYY-MM-DD). Must be used together with end_date.

Example:

"2025-01-01"

end_date
string<date>

Filter payouts created on or before this date (YYYY-MM-DD). Must be used together with start_date.

Example:

"2025-01-31"

order_by
string
default:-created_at

Sort field; prefix with - for descending

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:20

Results per page (10–100)

Required range: 10 <= x <= 100

Response

Payout history fetched successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object