Skip to main content
POST
Capture an authorization

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

To test this endpoint you need to make an AUTHORIZATION request first

subMerchantId
string
required

Unique identifier of the submerchant.

amount
number
required

The amount to capture. May exceed the authorized amount up to the issuer's allowable excess limit.

transactionId
string
required

Identifier of the authorization to capture.

description
string

Free-text description.

taxAmount
number | null

The total amount of sales tax must be between: Visa percentage: 0.1% - 18% MasterCard percentage: 0.1% - 23% Default percentage: 0.1% - 50%

taxWithHold
boolean

When true, the sales tax portion is withheld from the merchant's settlement until released.

referenceId
string

Your own reference for this transaction. Returned in responses and query results for reconciliation.

dynamicFee
Dynamic fee · object

Defines the platform fee that the service provider charges the merchant for the transaction. The fee is calculated using fixed and discountRatePerc and deducted from the merchant's transaction proceeds when payouts are calculated. It does not increase or otherwise modify the transaction amount submitted for processing.

processingDynamicFee
Dynamic processing fee · object

Defines the payment-processing fee that the service provider charges the merchant for the transaction. The fee is calculated using the supported fixed and percentage values, deducted from the merchant's transaction proceeds, and accounted for separately from the platform fee. It does not increase or otherwise modify the transaction amount submitted for processing.

metadata
object

metadata is an object that can host as much as 50 key-value pairs, where the keys can be at most 40 char length and can’t include the characters “[“ or “]”, and the values must be strings and cannot exceed 500 chars Learn more about metadata

billingDescriptor
object

Overrides the descriptor that appears on the cardholder's statement.

Response

200 - application/json

Successful fund capture

data
object

The response payload.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

message
string

Human-readable result message.

code
string

Machine-readable result code. See the Error Codes reference.

Last modified on August 31, 2026