v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get Charge Details

Get charge details

get/v1/charges/{charge_id}

Path parameters

charge_idstring required

The charge id

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

Successful payment

idstring

currencystring

home_currencystring

exchange_ratestring nullable

amountnumber

amount_without_feesnumber

refunded_amountnumber

fixed_feenumber

discount_feenumber

discount_fee_ratenumber

remarkstring

statusstring

customer_idstring

payment_request_idstring nullable

webhook_statusboolean

order_reference_numberstring nullable

target_idstring

target_typestring

executorstring nullable

channelstring

admin_feeboolean

refundsobject[]

webhook_logsobject[]

terminal_idstring nullable

closed_atstring

created_atstring

updated_atstring

Example response

{
  "id": "9cecc92d-9d93-49d6-bd3f-2bb74dcbb283",
  "currency": "sgd",
  "home_currency": "sgd",
  "amount": 100,
  "amount_without_fees": 95.85,
  "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"
  },
  "target_id": "9c0fd92e-1cc8-478f-8b2e-71ee8a218ec5",
  "target_type": "business_recurring_plan",
  "channel": "api_recurring_dashboard",
  "refunds": [],
  "webhook_logs": [],
  "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"
}