checkout

Create a charge on a payment link

Create a charge on a payment link with corresponding keys

post/checkout/v1/payment-links/{merchantId}/{paymentLinkId}/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/payment-links/{merchantId}/{paymentLinkId}/charge
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

merchantIdstring required

merchantId

paymentLinkIdstring required

paymentLinkId

Request body

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.

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.