bolt

Get the Charge detail by chargeId

Get the Charge detail by chargeId

get/bolt/v1/ui/charges/{chargeId}

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/bolt/v1/ui/charges/{chargeId}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

chargeIdstring required

chargeId

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

chargeAmountinteger
chargeCreatedAtstring
chargeCreditCardBrand'AMEX' | 'DINERS' | 'DISCOVER' | 'JCB' | 'MASTERCARD' | 'UNIONPAY' | 'VISA' | 'UNKNOWN'
chargeCreditCardCountrystring
chargeCreditCardHolderNamestring
chargeCreditCardLast4string
chargeIdstring
chargeInstallmentPeriod3 | 4 | 6 | 10
chargeSource'BOLT'
chargeSourceCreatedBystring
chargeSourceDeviceIdstring
chargeStatus'PENDING' | 'SUCCEEDED' | 'FAILED'
chargeTransactionTimestring
currency'THB'
displayStatus'PAID' | 'VOIDED' | 'REFUNDED' | 'PENDING' | 'FAILED'
displayTransactionTimestring
merchantIdstring
paymentMethodType'CARD' | 'CARD_INSTALLMENTS' | 'QR_PROMPT_PAY' | 'ALIPAY' | 'ALIPAY_PLUS' | 'LINE_PAY' | 'MAKE' | 'SHOPEE_PAY' | 'TRUE_MONEY' | 'WECHAT_PAY' | 'SPAY_LATER'
referenceIdstring
refundIdstring
refundOption'NONE' | 'VOID' | 'REFUND'
refundTransactionTimestring
sourceIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.