Payouts - List

Authorizations

api-key

string

headerrequired

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query Parameters

customer_id

string

required

The identifier for customer

starting_after

string

required

A cursor for use in pagination, fetch the next list after some object

ending_before

string

required

A cursor for use in pagination, fetch the previous list before some object

limit

string

required

limit on the number of objects to return

created

string

required

The time at which payout is created

time_range

string

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

200 - application/json

size

integer

required

The number of payouts included in the list

Required range: x > 0

data

object[]

required

The list of payouts response objects

Show child attributes

total_count

integer | null

The total number of available payouts for given constraints