Checkout

Capture totally or partially a transaction previously authorized

This API endpoint allows to capture totally or partially a transaction previously authorized. The amount of capture must not exceed authorized amount.

post/captures

Request

Base URL
https://api.test.bictorys.com/pay/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/bictorys/apis/pay/docs/captures/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

transactionIdstring uuid required

Unique identifier of the transaction Id.

Headers

X-Amzn-Trace-Idstring

HTTP request identifier allow to trace individual request sent from client to service.

Request body

amountnumber double

Amount to capture

currencystring

The currency associated to the amount.

Example request

{
  "amount": 45000,
  "currency": "XOF"
}

Response

The amount has been captured successfully

Changes

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