Settle a card authorization
curl --request POST \
--url https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1073741824
}
'import requests
url = "https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle"
payload = { "amount": 1073741824 }
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 1073741824})
};
fetch('https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle', 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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle",
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([
'amount' => 1073741824
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle"
payload := strings.NewReader("{\n \"amount\": 1073741824\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Key", "<api-key>")
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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1073741824\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1073741824\n}"
response = http.request(request)
puts response.read_body{
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "authorized",
"declinedReason": "<string>",
"completionReason": "settlement"
}Simulations
Settle a card authorization
Simulates settling an open authorization — for example, when a merchant captures funds after the customer has left. This converts the authorization hold into a posted transaction.
Sandbox only. This endpoint returns 404 Not Found in production environments.
POST
/
simulate
/
transactions
/
{transactionId}
/
settle
Settle a card authorization
curl --request POST \
--url https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1073741824
}
'import requests
url = "https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle"
payload = { "amount": 1073741824 }
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 1073741824})
};
fetch('https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle', 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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle",
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([
'amount' => 1073741824
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle"
payload := strings.NewReader("{\n \"amount\": 1073741824\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Key", "<api-key>")
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-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1073741824\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/simulate/transactions/{transactionId}/settle")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1073741824\n}"
response = http.request(request)
puts response.read_body{
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "authorized",
"declinedReason": "<string>",
"completionReason": "settlement"
}Authorizations
Path Parameters
The ID of the transaction to settle
Body
application/json
Settlement request
The settlement amount in cents (merchant currency). To settle for the full authorization, pass the authorized amount.
Required range:
1 <= x <= 2147483647Response
Successful operation
The transaction ID.
The transaction status.
Available options:
authorized, declined, settled Present when status is declined. The reason for the decline.
Present when status is settled. settlement after a settle, refund after a refund, authorization_reversal after a reverse.
Available options:
settlement, refund, authorization_reversal