curl --request POST \
--url https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId} \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"customerId": null,
"includeRawProcessorResponse": false,
"invoice": {
"merchantInvoiceRefId": null,
"orderProcessingChannel": null,
"ecommercePlatformUrl": null,
"amount": {
"currency": "USD",
"value": 30.99
}
},
"dynamicDescriptor": null,
"reportGroup": null
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}"
payload = {
"customerId": None,
"includeRawProcessorResponse": False,
"invoice": {
"merchantInvoiceRefId": None,
"orderProcessingChannel": None,
"ecommercePlatformUrl": None,
"amount": {
"currency": "USD",
"value": 30.99
}
},
"dynamicDescriptor": None,
"reportGroup": None
}
headers = {
"x-revolv3-token": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-revolv3-token': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
customerId: null,
includeRawProcessorResponse: false,
invoice: {
merchantInvoiceRefId: null,
orderProcessingChannel: null,
ecommercePlatformUrl: null,
amount: {currency: 'USD', value: 30.99}
},
dynamicDescriptor: null,
reportGroup: null
})
};
fetch('https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customerId' => null,
'includeRawProcessorResponse' => false,
'invoice' => [
'merchantInvoiceRefId' => null,
'orderProcessingChannel' => null,
'ecommercePlatformUrl' => null,
'amount' => [
'currency' => 'USD',
'value' => 30.99
]
],
'dynamicDescriptor' => null,
'reportGroup' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-revolv3-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}"
payload := strings.NewReader("{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-revolv3-token", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-revolv3-token"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}"
response = http.request(request)
puts response.read_body{
"customerId": 1,
"invoiceId": 1,
"merchantInvoiceRefId": "1234-5678-9101",
"merchantPaymentMethodRefId": null,
"networkTransactionId": "98c1dcb5-086c-4402-be38-459ab7f97fad",
"invoiceStatus": "Paid",
"invoiceAttemptStatus": "Success",
"message": "Approved",
"amount": {
"currency": "USD",
"value": 30.99
},
"paymentMethodId": 1,
"paymentMethodTypeId": 0,
"paymentProcessor": null,
"processorMerchantId": null,
"rawResponse": "Processor raw response (without parsing on Revolv3 side)",
"paymentMethodCreditCardDetails": null,
"responseMessage": null,
"responseCode": null,
"processorResponseDateTime": null,
"authCode": null,
"processorTransactionId": null,
"revolv3ResponseCode": null,
"revolv3ResponseMessage": null
}{
"message": "Unable to perform the request action with provided data.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}{
"message": "Attempted to perform an unauthorized operation.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}{
"message": "Unable to process this operation.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}Capture
Captures funds from a previously authorized transaction, completing the payment. Use this endpoint when you’ve already authorized a payment, and now want to finalize the charge.
You must provide the paymentMethodAuthorizationId - original authorization reference.
The amount captured can be equal to or less than the originally authorized amount, depending on business logic and processor rules.
Partial captures are supported in many cases.
Typical use cases include delayed fulfillment, pre-order models, or merchant-controlled capture flows.
curl --request POST \
--url https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId} \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"customerId": null,
"includeRawProcessorResponse": false,
"invoice": {
"merchantInvoiceRefId": null,
"orderProcessingChannel": null,
"ecommercePlatformUrl": null,
"amount": {
"currency": "USD",
"value": 30.99
}
},
"dynamicDescriptor": null,
"reportGroup": null
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}"
payload = {
"customerId": None,
"includeRawProcessorResponse": False,
"invoice": {
"merchantInvoiceRefId": None,
"orderProcessingChannel": None,
"ecommercePlatformUrl": None,
"amount": {
"currency": "USD",
"value": 30.99
}
},
"dynamicDescriptor": None,
"reportGroup": None
}
headers = {
"x-revolv3-token": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-revolv3-token': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
customerId: null,
includeRawProcessorResponse: false,
invoice: {
merchantInvoiceRefId: null,
orderProcessingChannel: null,
ecommercePlatformUrl: null,
amount: {currency: 'USD', value: 30.99}
},
dynamicDescriptor: null,
reportGroup: null
})
};
fetch('https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customerId' => null,
'includeRawProcessorResponse' => false,
'invoice' => [
'merchantInvoiceRefId' => null,
'orderProcessingChannel' => null,
'ecommercePlatformUrl' => null,
'amount' => [
'currency' => 'USD',
'value' => 30.99
]
],
'dynamicDescriptor' => null,
'reportGroup' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-revolv3-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}"
payload := strings.NewReader("{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-revolv3-token", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Payments/capture/{paymentMethodAuthorizationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-revolv3-token"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"customerId\": null,\n \"includeRawProcessorResponse\": false,\n \"invoice\": {\n \"merchantInvoiceRefId\": null,\n \"orderProcessingChannel\": null,\n \"ecommercePlatformUrl\": null,\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 30.99\n }\n },\n \"dynamicDescriptor\": null,\n \"reportGroup\": null\n}"
response = http.request(request)
puts response.read_body{
"customerId": 1,
"invoiceId": 1,
"merchantInvoiceRefId": "1234-5678-9101",
"merchantPaymentMethodRefId": null,
"networkTransactionId": "98c1dcb5-086c-4402-be38-459ab7f97fad",
"invoiceStatus": "Paid",
"invoiceAttemptStatus": "Success",
"message": "Approved",
"amount": {
"currency": "USD",
"value": 30.99
},
"paymentMethodId": 1,
"paymentMethodTypeId": 0,
"paymentProcessor": null,
"processorMerchantId": null,
"rawResponse": "Processor raw response (without parsing on Revolv3 side)",
"paymentMethodCreditCardDetails": null,
"responseMessage": null,
"responseCode": null,
"processorResponseDateTime": null,
"authCode": null,
"processorTransactionId": null,
"revolv3ResponseCode": null,
"revolv3ResponseMessage": null
}{
"message": "Unable to perform the request action with provided data.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}{
"message": "Attempted to perform an unauthorized operation.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}{
"message": "Unable to process this operation.",
"serverRequestId": "4bf92f3577b34da6a3ce929d0e0e4736",
"clientRequestId": "cddab9d1-7caa-43d9-8b1d-f688134c44b0"
}Headers
Optional identifier generated by the client to match its own logs with this request.
Allowed values: 1 to 128 characters, letters, digits and ., _, :, -.
Examples: order-12345, 3f2b8c1e-9d4a-4e7b-a1c5-6b0d2e8f7a91 (GUID), checkout:2026-11-02.17, retry_1.order-12345.
A valid value is returned in the Client-Request-Id response header and is stored with Revolv3 request logs, so it can be used when contacting support.
An invalid value is ignored and the request is processed normally. Do not send sensitive data in this header.
1 - 128^[A-Za-z0-9._:-]{1,128}$Body
Response
OK
The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction. You must include this value in the request message (originalNetworkTransactionId element) for subsequent recurring payments.
100Conditional. The value is returned if includeRawProcessorResponse = true. This field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.
10000
