api-bolt-intents

Create Bolt Intent

Create Bolt Intent

post/api/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/api/v1/bolt-intents
  • Auth: HTTP basic

Request body

amountinteger required

Amount in the smallest units of that currency: 1 == 1 Satang == 0.01 THB. 2125 == 2125 Satang == 21.25 THB.

boltConnectionIdstring

BoltConnectionID to hand off created BoltIntent to

currency'THB' required
expiryDurationInSecinteger required

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

internalNotestring
referenceIdstring

Example request

{
  "amount": 10000
}

Response

BoltIntent

amountinteger required

Amount in the smallest units of that currency: 1 == 1 Satang == 0.01 THB. 2125 == 2125 Satang == 21.25 THB.

boltConnectionIdstring

BoltConnectionID to hand off created BoltIntent to

createdAtstring required
createdBystring required
currency'THB' required
expiresAtstring
idstring required
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'

In the event that the ChargeStatus is ChargeStatusFailed, one of the following failure codes would be present. ChargeFailureCodeFailed denotes generic failure due to processing, please retry with a new Charge. ChargeFailureCodeInsufficientFunds denotes a failure due to insufficient funds from the customer's payment method. The following codes are for card and card installment payments only. ChargeFailureCodeCardExpired denotes a failure because the card has expired. ChargeFailureCodeCardDeclined denotes a failure because the card issuer declined the payment. ChargeFailureCodeCardRestricted denotes a failure because the card is restricted from making this payment. ChargeFailureCodeCardIncorrectDetails denotes a failure due to incorrect card details (ex. card number, expiry date, cvv). ChargeFailureCodeCardIncorrectPIN denotes a failure due to an incorrect PIN. ChargeFailureCodeCardPINAttemptExceeded denotes a failure because the allowed number of PIN attempts was exceeded. ChargeFailureCodeAuthenticationFailed denotes a failure due to the customer authentication.

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'

The result of the latest payment attempt on a Bolt Intent.

status'ACTIVE' | 'CANCELED' | 'EXPIRED' | 'PAID' | 'VOIDED' | 'REFUNDED' required
updatedAtstring required
updatedBystring required

Changes

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