Get Charge Details

Get charge details

GET /v1/charges/{charge_id}

Try it

Get Charge Details

cURL

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

200

{
  "id": "9cecc92d-9d93-49d6-bd3f-2bb74dcbb283",
  "currency": "sgd",
  "home_currency": "sgd",
  "exchange_rate": null,
  "amount": 100,
  "amount_without_fees": 95.85,
  "refunded_amount": 0,
  "fixed_fee": 0.5,
  "discount_fee": 3.65,
  "discount_fee_rate": 3.65,
  "remark": "NEWUI from 2024-08-31 To 2024-08-31",
  "status": "succeeded",
  "payment_method": {
    "code": "stripe_sg",
    "display_logo": {
      "sm": "https://api.sandbox.hit-pay.com/icons/methods/sm/visa.png",
      "md": "https://api.sandbox.hit-pay.com/icons/methods/md/visa.png",
      "lg": "https://api.sandbox.hit-pay.com/icons/methods/lg/visa.png",
      "svg": "https://api.sandbox.hit-pay.com/icons/methods/svg/visa.svg",
      "svg_square": "https://api.sandbox.hit-pay.com/icons/methods/svg_square/visa.svg",
      "png_square": "https://api.sandbox.hit-pay.com/icons/methods/png_square/visa.png",
      "method": "visa",
      "iconName": "visa",
      "displayName": "Visa"
    },
    "provider_reference": "ch_3Pv6duAMHowMCIhZ2P9NCA6j",
    "type": "charge",
    "name": "card",
    "method_logo": {
      "sm": "https://api.sandbox.hit-pay.com/icons/methods/sm/card.png",
      "md": "https://api.sandbox.hit-pay.com/icons/methods/md/card.png",
      "lg": "https://api.sandbox.hit-pay.com/icons/methods/lg/card.png",
      "svg": "https://api.sandbox.hit-pay.com/icons/methods/svg/card.svg",
      "svg_square": "https://api.sandbox.hit-pay.com/icons/methods/svg_square/card.svg",
      "png_square": "https://api.sandbox.hit-pay.com/icons/methods/png_square/card.png",
      "method": "card",
      "iconName": "card",
      "displayName": "Cards"
    },
    "data": {
      "brand": "Visa",
      "last4": "4242",
      "country_code": "US",
      "country": "United States of America"
    }
  },
  "customer_id": "9a659602-eafd-4731-972d-424aef24fb2f",
  "customer": {
    "name": "KimC",
    "email": "[e-mail]",
    "phone_number": "993348342"
  },
  "payment_request_id": null,
  "webhook_status": false,
  "order_reference_number": null,
  "target_id": "9c0fd92e-1cc8-478f-8b2e-71ee8a218ec5",
  "target_type": "business_recurring_plan",
  "executor": null,
  "location": null,
  "channel": "api_recurring_dashboard",
  "admin_fee": false,
  "refunds": [],
  "webhook_logs": [],
  "terminal_id": null,
  "closed_at": "2024-09-04T08:00:16+08:00",
  "created_at": "2024-09-04T08:00:17+08:00",
  "updated_at": "2024-09-04T08:01:19+08:00"
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

charge_id · string · required

The charge id

Response

200 - application/json

Successful payment

id · string

Example:

"9cecc92d-9d93-49d6-bd3f-2bb74dcbb283"

currency · string

Example:

"sgd"

home_currency · string

Example:

"sgd"

exchange_rate · string | null

Example:

null

amount · number

Example:

100

amount_without_fees · number

Example:

95.85

refunded_amount · number

Example:

0

fixed_fee · number

Example:

0.5

discount_fee · number

Example:

3.65

discount_fee_rate · number

Example:

3.65

remark · string

Example:

"NEWUI from 2024-08-31 To 2024-08-31"

status · string

Example:

"succeeded"

payment_method · object

Show child attributes

payment_method. code · string

Example:

"stripe_sg"

payment_method. display_logo · object

Show child attributes

payment_method.display_logo. sm · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/sm/visa.png"

payment_method.display_logo. md · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/md/visa.png"

payment_method.display_logo. lg · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/lg/visa.png"

payment_method.display_logo. svg · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/svg/visa.svg"

payment_method.display_logo. svg_square · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/svg_square/visa.svg"

payment_method.display_logo. png_square · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/png_square/visa.png"

payment_method.display_logo. method · string

Example:

"visa"

payment_method.display_logo. iconName · string

Example:

"visa"

payment_method.display_logo. displayName · string

Example:

"Visa"

payment_method. provider_reference · string

Example:

"ch_3Pv6duAMHowMCIhZ2P9NCA6j"

payment_method. type · string

Example:

"charge"

payment_method. name · string

Example:

"card"

payment_method. method_logo · object

Show child attributes

payment_method.method_logo. sm · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/sm/card.png"

payment_method.method_logo. md · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/md/card.png"

payment_method.method_logo. lg · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/lg/card.png"

payment_method.method_logo. svg · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/svg/card.svg"

payment_method.method_logo. svg_square · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/svg_square/card.svg"

payment_method.method_logo. png_square · string

Example:

"https://api.sandbox.hit-pay.com/icons/methods/png_square/card.png"

payment_method.method_logo. method · string

Example:

"card"

payment_method.method_logo. iconName · string

Example:

"card"

payment_method.method_logo. displayName · string

Example:

"Cards"

payment_method. data · object

Show child attributes

payment_method.data. brand · string

Example:

"Visa"

payment_method.data. last4 · string

Example:

"4242"

payment_method.data. country_code · string

Example:

"US"

payment_method.data. country · string

Example:

"United States of America"

customer_id · string

Example:

"9a659602-eafd-4731-972d-424aef24fb2f"

customer · object

Show child attributes

customer. name · string

Example:

"KimC"

customer. email · string

Example:

"[e-mail]"

customer. phone_number · string

Example:

"993348342"

payment_request_id · string | null

Example:

null

webhook_status · boolean

Example:

false

order_reference_number · string | null

Example:

null

target_id · string

Example:

"9c0fd92e-1cc8-478f-8b2e-71ee8a218ec5"

target_type · string

Example:

"business_recurring_plan"

executor · string | null

Example:

null

location · object

Show child attributes

location. id · string

Example:

null

location. name · string

Example:

null

location. address · string

Example:

null

channel · string

Example:

"api_recurring_dashboard"

admin_fee · boolean

Example:

false

refunds · object[]

Example:

[]

webhook_logs · object[]

Example:

[]

terminal_id · string | null

Example:

null

closed_at · string

Example:

"2024-09-04T08:00:16+08:00"

created_at · string

Example:

"2024-09-04T08:00:17+08:00"

updated_at · string

Example:

"2024-09-04T08:01:19+08:00"