GET
/
v1
/
charges
/
{charge_id}
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/charges/{charge_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "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": "cherykim@yopmail.com",
    "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

Path Parameters

​
charge_id
string
required

The charge id

Response

200 - application/json
Successful payment
​
id
string
​
currency
string
​
home_currency
string
​
exchange_rate
string | null
​
amount
number
​
amount_without_fees
number
​
refunded_amount
number
​
fixed_fee
number
​
discount_fee
number
​
discount_fee_rate
number
​
remark
string
​
status
string
​
payment_method
object
​
customer_id
string
​
customer
object
​
payment_request_id
string | null
​
webhook_status
boolean
​
order_reference_number
string | null
​
target_id
string
​
target_type
string
​
executor
string | null
​
location
object | null
​
channel
string
​
admin_fee
boolean
​
refunds
object[]
​
webhook_logs
object[]
​
terminal_id
string | null
​
closed_at
string
​
created_at
string
​
updated_at
string

Was this page helpful?

Get All ChargesExport Charges