bolt

Creates a new Bolt Intent

Creates a new Bolt Intent

post/bolt/v1/bolt-intents

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/bolt-intents
  • Auth: OAuth 2 (implicit, authorization URL "")

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Request body

actionRequired'CARD_PRESENT_CHARGE' | 'CHARGE' | 'INSTALLMENTS_CHARGE' | 'BOLTCHECKOUT_REDIRECT' required
amountinteger required

Amount is in the smallest unit of Currency. limit Amount to 2.1B to prevent integer overflow on Bolt+.

currency'THB' required
deviceIdstring
expiryDurationInSecinteger

ExpiryDurationInSec indicates how long should the created BoltIntent should be active in seconds.

internalNotestring
isFromBoltPlusboolean

Deprecated we can remove this in the future since we have bolt device type keep this until all bolts are above version released on 20260730

referenceIdstring

Response

success

actionRequired'CARD_PRESENT_CHARGE' | 'CHARGE' | 'INSTALLMENTS_CHARGE' | 'BOLTCHECKOUT_REDIRECT'
amountinteger
createdAtstring
createdBystring
currency'THB'
expiresAtstring
idstring
internalNotestring
latestChargeFailureCode'CH_PROCESSING_FAILED' | 'CH_INSUFFICIENT_FUNDS' | 'CH_CARD_EXPIRED' | 'CH_CARD_DECLINED' | 'CH_CARD_RESTRICTED' | 'CH_CARD_INCORRECT_DETAILS' | 'CH_CARD_INCORRECT_PIN' | 'CH_CARD_PIN_ATTEMPT_EXCEEDED' | 'CH_AUTHENTICATION_FAILED'
latestChargeIdstring
latestChargeStatus'PENDING' | 'SUCCEEDED' | 'FAILED'
referenceIdstring
result'CH_SUCCEEDED' | 'CH_PROCESSING_FAILED' | 'CH_INSUFFICIENT_FUNDS' | 'CH_CARD_EXPIRED' | 'CH_CARD_DECLINED' | 'CH_CARD_RESTRICTED' | 'CH_CARD_INCORRECT_DETAILS' | 'CH_CARD_INCORRECT_PIN' | 'CH_CARD_PIN_ATTEMPT_EXCEEDED' | 'CH_AUTHENTICATION_FAILED' | 'BI_CANCELED' | 'BI_EXPIRED'
updatedAtstring
updatedBystring

Changes

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