Get All Charges

Get all charges

GET /v1/charges

Try it

Get All Charges

cURL

curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/charges \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "currency": "<string>",
      "home_currency": "<string>",
      "exchange_rate": "<string>",
      "amount": 123,
      "fixed_fee": 123,
      "discount_fee": 123,
      "discount_fee_rate": 123,
      "remark": "<unknown>",
      "status": "<string>",
      "payment_method": {
        "name": "<string>",
        "display_logo": {
          "sm": "<string>",
          "md": "<string>",
          "lg": "<string>",
          "svg": "<string>",
          "svg_square": "<string>",
          "png_square": "<string>",
          "method": "<string>",
          "iconName": "<string>",
          "displayName": "<string>"
        },
        "method_logo": {
          "sm": "<string>",
          "md": "<string>",
          "lg": "<string>",
          "svg": "<string>",
          "svg_square": "<string>",
          "png_square": "<string>",
          "method": "<string>",
          "iconName": "<string>",
          "displayName": "<string>"
        },
        "data": {
          "brand": "<string>",
          "last4": "<string>",
          "country_code": "<string>",
          "country": "<string>"
        }
      },
      "customer_id": "<string>",
      "customer": {
        "name": "<string>",
        "email": "<string>",
        "phone_number": "<unknown>"
      },
      "payment_request_id": "<unknown>",
      "webhook_status": true,
      "order_reference_number": "<string>",
      "executor": {
        "id": "<string>",
        "display_name": "<string>",
        "email": "<string>"
      },
      "location": {
        "id": "<string>",
        "name": "<string>",
        "address": "<string>"
      },
      "channel": "<string>",
      "admin_fee": true,
      "closed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "links": {
    "first": "<unknown>",
    "last": "<unknown>",
    "prev": "<unknown>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<unknown>"
  }
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

per_page · integer<int32> · default: 25

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<uuid>[]

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

Example:

"2024-10-05"

date_to · string

The to of created order

Example:

"2024-10-05"

amount_from · number

The from of amount

Example:

100

amount_to · number

The to of amount

Example:

200

payment_request_id · string<uuid>

The payment request id

customer_id · string<uuid>

The customer id

Response

200 - application/json

Successful payment

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 · 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 · required

Show child attributes

data.executor. id · string · required

data.executor. display_name · string · required

data.executor. email · string · required

data. location · object · 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