Captures

Captures a payment

Captures a payment intent that has previously been created but not yet refunded or reversed. You can capture the full amount or a partial amount.

post/payment-intents/{paymentIntentId}/captures

Request

Base URL
https://api.dojo.tech
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/dojo/apis/dojo-api/docs/payment-intents/:paymentIntentId/captures/post.ts
A function with typed inputs. Its response is checked against the schema.

paymentIntentIdstring nullable required

The unique identifier of the payment intent.

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

amountinteger required

The capture amount. You can capture a full or partial amount. Multiple partial captures can be made on the same total.

tipsAmountinteger nullable

The tip amount.

{
  "amount": 2000
}

messagestring nullable

The description of the operation.

captureIdstring nullable

The unique identifier for the capture.

{
  "message": "Demo capture",
  "captureId": "cp_itIiJMEAvES3ynYF_Yhs2g"
}

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