api-card-authorizations

Get CardAuthorization by ID

Retrieves a CardAuthorization by cardAuthorizationId.

get/api/v1/card-authorizations/{cardAuthorizationId}

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/{cardAuthorizationId}
  • Auth: HTTP basic

Path parameters

cardAuthorizationIdstring required

cardAuthorizationId

Response

success

amountinteger
authorizedAtstring date-time

AuthorizedAt is the time when the CardAuthorization is recorded as AUTHORIZED

capturableAmountinteger
capturedAmountinteger
cardAuthorizationIdstring
createdAtstring date-time
currency'THB'
expiresAtstring date-time

ExpiresAt is the time when the CardAuthorization will expire

failureCode'CA_PROCESSING_FAILED' | 'CA_INSUFFICIENT_FUNDS' | 'CA_CARD_EXPIRED' | 'CA_CARD_DECLINED' | 'CA_CARD_RESTRICTED' | 'CA_CARD_INCORRECT_DETAILS' | 'CA_CARD_INCORRECT_PIN' | 'CA_CARD_PIN_ATTEMPT_EXCEEDED' | 'CA_AUTHENTICATION_FAILED'

In the event that the CardAuthorizationStatus is CardAuthorizationStatusFailed, one of the following failure codes would be present. CardAuthorizationFailureCodeFailed denotes generic failure due to processing, please retry with a new Charge. CardAuthorizationFailureCodeInsufficientFunds denotes a failure due to insufficient funds from the customer's payment method. CardAuthorizationFailureCodeCardExpired denotes a failure because the card has expired. CardAuthorizationFailureCodeCardDeclined denotes a failure because the card issuer declined the authorization. CardAuthorizationFailureCodeCardRestricted denotes a failure because the card is restricted from making this payment. CardAuthorizationFailureCodeCardIncorrectDetails denotes a failure due to incorrect card details (ex. card number, expiry date, cvv). CardAuthorizationFailureCodeCardIncorrectPIN denotes a failure due to an incorrect PIN. CardAuthorizationFailureCodeCardPINAttemptExceeded denotes a failure because the allowed number of PIN attempts was exceeded. CardAuthorizationFailureCodeAuthenticationFailed denotes a failure due to the customer authentication.

latestChargeIdstring
merchantIdstring
referenceIdstring
status'PENDING' | 'AUTHORIZED' | 'FINALIZED' | 'FAILED' | 'CANCELED' | 'AUTHORIZATION_EXPIRED'
supportsMulticaptureboolean
updatedAtstring date-time

Example response

{
  "amount": 10000,
  "capturableAmount": 5000,
  "capturedAmount": 5000,
  "paymentMethod": {
    "card": {
      "brand": "VISA",
      "countryAlpha2": "TH",
      "last4": "1111",
      "networkTransactionId": "NETWORK_TRANSACTION_ID"
    },
    "cardNetworkToken": {
      "brand": "VISA",
      "countryAlpha2": "TH",
      "last4": "1111",
      "networkTransactionId": "NETWORK_TRANSACTION_ID"
    }
  },
  "referenceId": "order_190821",
  "supportsMulticapture": true
}

Changes

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