Skip to Content

Capture API

You can see the API reference for captures at Capture API Specification.

Example Capture Request

POST https://api.beamcheckout.com/api/v1/card-authorizations/{{cardAuthorizationId}}/charges Content-Type: application/json Authorization: Basic {{yourMerchantId}} {{yourApiKey}} { "amount": 8000, "currency": "THB", "referenceId": "order_190821_capture_1", "isFinal": true }
Note

The amount field is in the smallest currency unit. For example, for Thai Baht (THB), the amount is in Satang.

For more information on authentication, please refer to the Authentication guide.

If the card authorization supports multiple captures (denoted by supportsMulticapture field in the Card Authorization object), you can set isFinal to false to allow calling Capture API multiple times until

  • the total captured amount equals the authorized amount
  • or isFinal is set to true.
Last updated on