List Payouts

GET

/api/Payouts

curl --request GET \
  --url 'https://example.com/api/Payouts?Status=Pending' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of payouts for a merchant. Supports filtering by status (Pending, Processing, Settled, Failed) and date range.

Authorizations

• Bearer

Parameters

Query Parameters

MerchantId

string format: uuid

Status

string

Allowed values: Pending Processing Settled Failed

From

string format: date-time

To

string format: date-time

Page

integer format: int32

PageSize

integer format: int32

Responses

200

Paginated list of payouts.

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

merchantId

string format: uuid

batchId

string

nullable

date

string format: date-time

estimatedArrival

string format: date-time

nullable

transactionCount

integer format: int32

gross

number format: double

fees

number format: double

net

number format: double

currency

string

nullable

status

string

Allowed values: Pending Processing Settled Failed

createdAt

string format: date-time

updatedAt

string format: date-time

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "status": "Pending"
    }
  ]
}