checkout

Gets Charge UI object by ID

Gets Charge UI object by ID

get/checkout/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/checkout/v1/ui/charges/{chargeId}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

chargeIdstring required

chargeId

Response

success

chargeAmountinteger
chargeDisplayStatus'PENDING' | 'FAILED' | 'PAID' | 'VOIDED' | 'REFUNDED'
chargeIdstring
chargeInstallmentPeriod3 | 4 | 6 | 10
chargeSource'PAYMENT_LINK' | 'STORE_LINK' | 'QR_PROMPT_PAY_LINK' | 'API' | 'BOLT'
chargeStatus'PENDING' | 'SUCCEEDED' | 'FAILED'
chargeTransactionTimestring
currency'THB'
customerIdstring
paymentMethodType'CREDIT_CARD' | 'CREDIT_CARD_INSTALLMENTS' | 'INTERNET_BANKING' | 'QR_PROMPT_PAY' | 'E_WALLET' | 'BNPL'
refundTransactionTimestring
sourceIdstring

Changes

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