v2
latestOpenAPI 3.1.12026-08-06856719.6 KBGet All Charges
Get all charges
get/v1/charges
Query parameters
per_pageinteger
cursorstring
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.
keywordsstring
Search for fields: amount ,charge_id ,customer_email, remark
status'succeeded' | 'failed' | 'refunded'
It's charge status
location_idsstring[]
The location ids
user_idsstring[]
The user's id, support both uuid and number id
statusesstring[]
It's charge status.
date_fromstring
Example:2024-10-05
The from of created order
date_tostring
Example:2024-10-05
The to of created order
amount_fromnumber
Example:100
The from of amount
amount_tonumber
Example:200
The to of amount
payment_request_idstring uuid
The payment request id
customer_idstring uuid
The customer id
payout_idstring uuid
The payout id
Headers
X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
Response
Successful payment