v1
latestOpenAPI 3.0.02026-07-26168846732.2 KBPayouts
Payouts - List
get/payouts/list
Query parameters
customer_idstring required
The identifier for customer
starting_afterstring required
A cursor for use in pagination, fetch the next list after some object
ending_beforestring required
A cursor for use in pagination, fetch the previous list before some object
limitstring required
limit on the number of objects to return
createdstring required
The time at which payout is created
time_rangestring required
The time range for which objects are needed. TimeRange has two fields start_time and end_time from which objects can be filtered as per required scenarios (created_at, time less than, greater than etc).
Response
Payouts listed
Example response
{
"data": [
{
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_id": "merchant_1668273825",
"merchant_order_reference_id": "merchant_order_ref_123",
"amount": 1000,
"connector": "wise",
"payout_method_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe"
}
},
"source_bank_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe"
}
},
"billing": {
"address": {
"city": "New York",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
}
},
"auto_fulfill": true,
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1",
"customer_document_details": {
"document_number": "12345678911"
}
},
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"return_url": "https://hyperswitch.io",
"business_label": "food",
"description": "It's my first payout request",
"merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
"error_message": "Failed while verifying the card",
"error_code": "E0001",
"created": "2022-09-10T10:11:12Z",
"connector_transaction_id": "S3FC9G9M2MVFDXT5",
"attempts": [
{
"amount": 6583,
"unified_code": "UE_000",
"unified_message": "Invalid card details"
}
],
"email": "johntest@test.com",
"name": "John Test",
"phone": "9123456789",
"phone_country_code": "+1",
"unified_code": "UE_000",
"unified_message": "Invalid card details"
}
]
}