Capture Charge on CardAuthorization

Capture Charge on CardAuthorization by its ID.

post/api/v1/card-authorizations/{cardAuthorizationId}/charges

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}/charges
Auth: HTTP basic

Path parameters

cardAuthorizationIdstring required

cardAuthorizationId

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

isFinalboolean

IsFinal indicates whether this capture is the final capture for the CardAuthorization.

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.

Example request

{
  "amount": 10000,
  "isFinal": true,
  "referenceId": "order_190821"
}

Response

apidto.CaptureCardAuthorizationByIDResponse

chargeIdstring

Changes

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