This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Captures an order's authorized payments.
You can only call this method when authenticated as a Wix app or Wix user identity.
Order ID.
List payment IDs and amounts to capture.
Order transactions updated with captured payment.
Capture previously authorized payments.
curl -X POST \
'https://www.wixapis.com/ecom/v1/order-billing/capture-authorized-payments' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
--data-binary '{
"orderId": "3545c2f2-7768-4e6e-b64b-dcc11dc7a7f9",
"payments": [
{
"paymentId": "496aaea1-4e2f-4cb1-9522-6b85f49b91e2",
"amount": {
"amount": "1"
}
}
]
}'
{
"orderTransactions": {
"orderId": "3545c2f2-7768-4e6e-b64b-dcc11dc7a7f9",
"payments": [
{
"id": "23af2de7-b24d-41d5-8d27-cf925d378d32",
"regularPaymentDetails": {
"paymentOrderId": "eead5fa5-29c2-4f7e-957c-a5eb0286c235",
"gatewayTransactionId": "afba164b-a96c-4cb2-a22d-6eec692e1148",
"paymentMethod": "Credit/Debit Cards",
"providerTransactionId": "afba164b-a96c-4cb2-a22d-6eec692e1148",
"offlinePayment": false,
"status": "APPROVED",
"savedPaymentMethod": true,
"creditCardDetails": {
"lastFourDigits": "1111",
"brand": "visa"
}
},
"createdDate": "2024-12-25T08:36:29.499Z",
"updatedDate": "2024-12-25T08:36:32.351Z",
"amount": {
"amount": "2.0",
"formattedAmount": "$2.00"
},
"refundDisabled": false
},
{
"id": "496aaea1-4e2f-4cb1-9522-6b85f49b91e2",
"regularPaymentDetails": {
"paymentOrderId": "dc6e6d53-51d6-48a4-8755-ca87a4e370bf",
"gatewayTransactionId": "3376e961-48c7-4093-b8be-0320ace06777",
"providerTransactionId": "3376e961-48c7-4093-b8be-0320ace06777",
"offlinePayment": false,
"status": "AUTHORIZED",
"savedPaymentMethod": false,
"creditCardDetails": {
"lastFourDigits": "1111",
"brand": "visa"
},
"authorizationDetails": {
"delayedCapture": true,
"authorizedDate": "2024-12-25T08:46:05.539Z",
"captures": [
{
"status": "PENDING",
"amount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"createdDate": "2024-12-25T08:51:51.167Z",
"id": "053aa1b1-e589-4850-b67c-9755af1a73e4"
}
],
"scheduledAction": {
"actionType": "VOID",
"executionDate": "2024-12-26T08:46:05.539Z"
}
}
},
"createdDate": "2024-12-25T08:46:04.257Z",
"updatedDate": "2024-12-25T08:51:51.167Z",
"amount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"refundDisabled": false
}
],
"refunds": []
}
}
There is 1 error with this status code.
There is 1 error with this status code.
There are 2 errors with this status code.
There are 2 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.