This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Manually captures an authorized transaction by ID.
You can only call this method when authenticated as a Wix app or Wix user identity.
Transaction ID.
Wix Payments account ID.
Amount to capture in minor units (for example, cents). When not passed, the whole transaction amount will be captured.
Amount that can be captured or voided in minor units to place a hold on a card to reserve funds. Specify the amount to prevent double partial captures.
Key to ensure idempotency.
Corresponding capture ID within the external entity that initiated the transaction capture.
Metadata to store within the created capture.
Captured transaction information.
Capture ID.
Capture previously created authorized transaction
curl -X POST \
https://www.wixapis.com/payments/v3/transactions/29298cc4-43b1-4ae9-bd52-be5e35cd114b/capture \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: <AUTH>' \
-d '{
"accountId": "6f82b2ce-2a15-4bd7-84b5-392c74b3719c"
}'{
"transaction": {
"id": "29298cc4-43b1-4ae9-bd52-be5e35cd114b",
"currency": "USD",
"capturableAmount": "0",
"refundableAmount": "100",
"providerTransactionId": "pi_1H7iJ4AaXaGogcA7QBfvragk",
"metadata": {
"metadataKey": "metadataValue"
},
"authorization": {
"amount": "100",
"status": "SUCCEEDED",
"networkReference": {
"networkTransactionId": "WvTnyhZlYER07Ate"
},
"authCode": "123456"
},
"captures": [
{
"id": "a885c8b6-8794-4f61-9fb0-bec93e0715b4",
"amount": "100",
"status": "SUCCEEDED",
"metadata": {}
}
],
"refunds": [],
"disputes": [],
"voids": [],
"accountId": "6f82b2ce-2a15-4bd7-84b5-392c74b3719c",
"paymentMethod": {
"typeId": "creditCard"
}
},
"captureId": "a885c8b6-8794-4f61-9fb0-bec93e0715b4"
}There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.