checkout

Create a charge on a store link

Create a charge on a store link with corresponding storeLinkId

post/checkout/v1/store-links/{storeLinkId}/charge

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/store-links/{storeLinkId}/charge
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

storeLinkIdstring required

storeLinkId

Request body

amountinteger required

Amount is in the smallest unit of Currency

currency'THB' required
merchantPolicyIdstring

MerchantPolicyID is the id of the merchant policy the customer accepted at checkout.

referenceIdstring

ReferenceID is a free text field for merchants to optionally provide for reconciliation purposes. Beam does not provide any unique constraints for this field. Maximum 100 characters.

setUpCustomerboolean

SetUpCustomer set to true to set up the customer for future payments with Beam. Note that the customer must first consent to this legally first.

Example request

{
  "amount": 10000
}

Response

success

actionRequired'NONE' | 'REDIRECT' | 'ENCODED_IMAGE'
chargeIdstring
paymentMethodType'CREDIT_CARD' | 'CREDIT_CARD_INSTALLMENTS' | 'INTERNET_BANKING' | 'QR_PROMPT_PAY' | 'E_WALLET' | 'BNPL'

Changes

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