api-card-authorizations

Create CardAuthorization

Create CardAuthorization to attempt to authorize a card payment to be manually captured later

post/api/v1/card-authorizations

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/card-authorizations
  • 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.

currency'THB' required
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.

returnUrlstring

ReturnURL is the URL to redirect customers back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile app, you can supply an application URI scheme. Required for cardAuthorizations that redirect out of Beam

skip3dsFlowboolean

Skip3DSFlow indicates whether to skip the 3DS flow.

supportsMulticaptureboolean

SupportsMulticapture indicates whether the card authorization can be partially captured multiple times

Example request

{
  "amount": 10000,
  "paymentMethod": {
    "card": {
      "cardHolderName": "CARDHOLDER NAME",
      "expiryMonth": 12,
      "expiryYear": 30,
      "pan": "4111111111111111",
      "securityCode": "123"
    },
    "cardNetworkToken": {
      "cardHolderName": "CARDHOLDER NAME",
      "expiryMonth": 12,
      "expiryYear": 30
    },
    "cardToken": {
      "securityCode": "123"
    }
  },
  "referenceId": "order_190821",
  "returnUrl": "https://www.beamcheckout.com",
  "supportsMulticapture": true
}

Response

success

actionRequired'NONE' | 'REDIRECT'

the action required to complete the payment process. For CardAuthorizationActionNone, no further action is required. For CardAuthorizationActionRedirect, redirect the paying customer to the given URL to complete the process.

cardAuthorizationIdstring

Changes

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