Get All Charges

Headers

X-BUSINESS-API-KEY

string

required

Query Parameters

per_page

integer

default:

cursor

string

The cursor parameter accepts a next_cursor value obtained from the previous response's meta object (meta.next_cursor). Use this parameter to fetch the next page of results when implementing pagination.

keywords

string

Search for fields: amount ,charge_id ,customer_email, remark

status

enum<string>

It's charge status

Available options:

succeeded,

failed,

refunded

location_ids

string[]

The location ids

user_ids

string[]

The user's id, support both uuid and number id

statuses

enum<string>[]

It's charge status.

Available options:

success,

succeeded_manually,

pending,

failed,

refunded,

cancelled,

partially_refunded,

void

date_from

string

The from of created order

date_to

string

The to of created order

amount_from

number

The from of amount

amount_to

number

The to of amount

payment_request_id

string

The payment request id

customer_id

string

The customer id

Response

200 - application/json

data

object[]

required

data.admin_fee

boolean

required

data.amount

number

required

data.channel

string

required

data.closed_at

string

required

data.created_at

string

required

data.currency

string

required

data.customer

object | null

required

data.customer_id

string | null

required

data.discount_fee

number

required

data.discount_fee_rate

number

required

data.exchange_rate

string | null

required

data.executor

object | null

required

data.fixed_fee

number

required

data.home_currency

string

required

data.id

string

required

data.location

object | null

required

data.order_reference_number

string

required

data.payment_method

object

required

data.payment_request_id

any

required

data.remark

any

required

data.status

string

required

data.updated_at

string

required

data.webhook_status

boolean

required

links

object

required

Guides

API References

Headers

Query Parameters

Response