Get All Charges

Get all charges

Headers

X-BUSINESS-API-KEY

string

required

Query Parameters

per_page

integer

default: 25

keywords

string

Search for fields: amount ,charge_id ,customer_email, remark

status

enum<string>

The statuses are in "succeeded" , "failed", "refunded"

Available options:

succeeded,

failed,

refunded

location_ids

string[]

The location ids

user_ids

string[]

The user ids

statuses

enum<string>[]

The statuses are in "succeeded", "succeeded_manually", "pending", "failed", "refunded", "cancelled", "partially_refunded", "void"

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

Show child attributes

data.id

string

required

data.currency

string

required

data.home_currency

string

required

data.exchange_rate

string | null

required

data.amount

number

required

data.fixed_fee

number

required

data.discount_fee

number

required

data.discount_fee_rate

number

required

data.remark

any

required

data.status

string

required

data.payment_method

object

required

Show child attributes

data.payment_method.name

string

required

data.payment_method.display_logo

object

required

Show child attributes

data.payment_method.display_logo.sm

string

required

data.payment_method.display_logo.md

string

required

data.payment_method.display_logo.lg

string

required

data.payment_method.display_logo.svg

string

required

data.payment_method.display_logo.svg_square

string

required

data.payment_method.display_logo.png_square

string

required

data.payment_method.display_logo.method

string

required

data.payment_method.display_logo.iconName

string

required

data.payment_method.display_logo.displayName

string

required

data.payment_method.method_logo

object

required

Show child attributes

data.payment_method.method_logo.sm

string

required

data.payment_method.method_logo.md

string

required

data.payment_method.method_logo.lg

string

required

data.payment_method.method_logo.svg

string

required

data.payment_method.method_logo.svg_square

string

required

data.payment_method.method_logo.png_square

string

required

data.payment_method.method_logo.method

string

required

data.payment_method.method_logo.iconName

string

required

data.payment_method.method_logo.displayName

string

required

data.payment_method.data

object

required

Show child attributes

data.payment_method.data.brand

string

required

data.payment_method.data.last4

string

required

data.payment_method.data.country_code

string

required

data.payment_method.data.country

string

required

data.customer_id

string | null

required

data.customer

object | null

required

Show child attributes

data.customer.name

string

required

data.customer.email

string

required

data.customer.phone_number

any

required

data.payment_request_id

any

required

data.webhook_status

boolean

required

data.order_reference_number

string

required

data.executor

object | null

required

Show child attributes

data.executor.id

string

required

data.executor.display_name

string

required

data.executor.email

string

required

data.location

object | null

required

Show child attributes

data.location.id

string

required

data.location.name

string

required

data.location.address

string

required

data.channel

string

required

data.admin_fee

boolean

required

data.closed_at

string

required

data.created_at

string

required

data.updated_at

string

required

links

object

required

Show child attributes

links.first

any

required

links.last

any

required

links.prev

any

required

links.next

string

required

meta

object

required

Show child attributes

meta.path

string

required

meta.per_page

number

required

meta.next_cursor

string

required

meta.prev_cursor

any

required