cURL
curl --request POST \
--url https://api.xpaycheckout.com/payments/capture-payment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"intentId": "in_fooBOwYsaK50AEfK"
}
'import requests
url = "https://api.xpaycheckout.com/payments/capture-payment"
payload = { "intentId": "in_fooBOwYsaK50AEfK" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({intentId: 'in_fooBOwYsaK50AEfK'})
};
fetch('https://api.xpaycheckout.com/payments/capture-payment', 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.xpaycheckout.com/payments/capture-payment",
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([
'intentId' => 'in_fooBOwYsaK50AEfK'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.xpaycheckout.com/payments/capture-payment"
payload := strings.NewReader("{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/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.xpaycheckout.com/payments/capture-payment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xpaycheckout.com/payments/capture-payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"errorCode": null,
"errorMessage": null
}{
"errorCode": "bad_request",
"errorDescription": "Failed to read request"
}Payments
Capture Payment
Captures a payment that was previously authorized by creating an intent with manualCapture set to true.
POST
/
payments
/
capture-payment
cURL
curl --request POST \
--url https://api.xpaycheckout.com/payments/capture-payment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"intentId": "in_fooBOwYsaK50AEfK"
}
'import requests
url = "https://api.xpaycheckout.com/payments/capture-payment"
payload = { "intentId": "in_fooBOwYsaK50AEfK" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({intentId: 'in_fooBOwYsaK50AEfK'})
};
fetch('https://api.xpaycheckout.com/payments/capture-payment', 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.xpaycheckout.com/payments/capture-payment",
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([
'intentId' => 'in_fooBOwYsaK50AEfK'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.xpaycheckout.com/payments/capture-payment"
payload := strings.NewReader("{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/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.xpaycheckout.com/payments/capture-payment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xpaycheckout.com/payments/capture-payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intentId\": \"in_fooBOwYsaK50AEfK\"\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"errorCode": null,
"errorMessage": null
}{
"errorCode": "bad_request",
"errorDescription": "Failed to read request"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.
Maximum string length:
255Pattern:
^[a-zA-Z0-9\-_:\.]+$Body
application/json
Capture Payment
Unique identifier of the previously authorized payment intent
Example:
"in_fooBOwYsaK50AEfK"
Response
Capture Payment response
Current status of the payment intent. Refer to payment statuses.
Example:
"SUCCESS"
Machine-readable error code when the capture is unsuccessful. Refer to error codes.
Example:
null
Human-readable error message when the capture is unsuccessful.
Example:
null
Was this page helpful?