Transactions
Reconcile a Business Transaction whose outcome is pending
For a Business Transaction left in EXECUTING, writes its terminal status from the execution intent: EXECUTED when the release is recorded, or FAILED when an operator recorded that nothing was released.
POST
/
transactions
/
{businessTransactionId}
/
reconcile
cURL
# Reconciles a transaction whose outcome is pending (status EXECUTING). Operator
# credentials only: a plain API key is refused with 403. Nothing is released.
TXN_ID="6f6582a1-4e1a-4800-a73b-cb4c3aa32110"
curl -X POST "https://parmana-api-real.vercel.app/transactions/$TXN_ID/reconcile" \
--silent \
-H "Authorization: Bearer $PARMANA_OPERATOR_KEY"import { ParmanaClient } from "@parmana/sdk";
// Operator credentials only: a plain API key is refused with 403.
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_OPERATOR_KEY!,
});
const result = await client.reconcileTransaction(
"6f6582a1-4e1a-4800-a73b-cb4c3aa32110",
);
console.log(result.status, result.changed);import os
from parmana import ParmanaClient
# Operator credentials only: a plain API key is refused with 403.
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_OPERATOR_KEY"],
)
result = client.reconcile_transaction("6f6582a1-4e1a-4800-a73b-cb4c3aa32110")
print(result.status, result.changed)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile', 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://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"businessTransactionId": "9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90",
"changed": true,
"status": "EXECUTED"
}{
"error": "authentication required"
}{
"error": "Reconciliation is available only to human operator credentials.",
"code": "NON_HUMAN_CALLER_DENIED"
}{
"error": "Business Transaction not found.",
"code": "NOT_FOUND"
}{
"error": "Business Transaction 'x': outcome unknown: the release is not confirmed; no automatic action was taken",
"code": "INVALID_STATUS_TRANSITION"
}Authorizations
Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.
Path Parameters
⌘I
cURL
# Reconciles a transaction whose outcome is pending (status EXECUTING). Operator
# credentials only: a plain API key is refused with 403. Nothing is released.
TXN_ID="6f6582a1-4e1a-4800-a73b-cb4c3aa32110"
curl -X POST "https://parmana-api-real.vercel.app/transactions/$TXN_ID/reconcile" \
--silent \
-H "Authorization: Bearer $PARMANA_OPERATOR_KEY"import { ParmanaClient } from "@parmana/sdk";
// Operator credentials only: a plain API key is refused with 403.
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_OPERATOR_KEY!,
});
const result = await client.reconcileTransaction(
"6f6582a1-4e1a-4800-a73b-cb4c3aa32110",
);
console.log(result.status, result.changed);import os
from parmana import ParmanaClient
# Operator credentials only: a plain API key is refused with 403.
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_OPERATOR_KEY"],
)
result = client.reconcile_transaction("6f6582a1-4e1a-4800-a73b-cb4c3aa32110")
print(result.status, result.changed)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile', 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://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-api-real.vercel.app/transactions/{businessTransactionId}/reconcile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"businessTransactionId": "9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90",
"changed": true,
"status": "EXECUTED"
}{
"error": "authentication required"
}{
"error": "Reconciliation is available only to human operator credentials.",
"code": "NON_HUMAN_CALLER_DENIED"
}{
"error": "Business Transaction not found.",
"code": "NOT_FOUND"
}{
"error": "Business Transaction 'x': outcome unknown: the release is not confirmed; no automatic action was taken",
"code": "INVALID_STATUS_TRANSITION"
}