Skip to main content
POST
/
cash-ins
/
simulate
/
auth-commit
Simulate cash-in auth commit
curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "accountNumber": "<string>",
  "accountReferenceNumber": "<string>",
  "amount": "<string>",
  "originalConfirmationId": "<string>",
  "customerId": "<string>",
  "description": "<string>"
}
'
import requests

url = "https://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit"

payload = {
"accountNumber": "<string>",
"accountReferenceNumber": "<string>",
"amount": "<string>",
"originalConfirmationId": "<string>",
"customerId": "<string>",
"description": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
accountNumber: '<string>',
accountReferenceNumber: '<string>',
amount: '<string>',
originalConfirmationId: '<string>',
customerId: '<string>',
description: '<string>'
})
};

fetch('https://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit', 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://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit",
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([
'accountNumber' => '<string>',
'accountReferenceNumber' => '<string>',
'amount' => '<string>',
'originalConfirmationId' => '<string>',
'customerId' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit"

payload := strings.NewReader("{\n \"accountNumber\": \"<string>\",\n \"accountReferenceNumber\": \"<string>\",\n \"amount\": \"<string>\",\n \"originalConfirmationId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountNumber\": \"<string>\",\n \"accountReferenceNumber\": \"<string>\",\n \"amount\": \"<string>\",\n \"originalConfirmationId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.10/cash-ins/simulate/auth-commit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountNumber\": \"<string>\",\n \"accountReferenceNumber\": \"<string>\",\n \"amount\": \"<string>\",\n \"originalConfirmationId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "authorizedAmount": "<string>",
  "confirmationId": "<string>",
  "responseCode": "<string>",
  "responseId": "<string>",
  "responseText": "<string>"
}

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Body

application/json
accountNumber
string
required
accountReferenceNumber
string
required
amount
string
required

Wire-safe decimal string for financial float values (USD amounts, percentages).

originalConfirmationId
string
required
customerId
string

Optional customer public ID (OMSX TypeID, cst_…). When provided, a minimal transactions row is synthesised on successful commit so the sandbox buy shows up in the transactions list.

description
string

Response

200 - application/json

The request has succeeded.

authorizedAmount
string
required

Wire-safe decimal string for financial float values (USD amounts, percentages).

confirmationId
string
required
responseCode
string
required
responseId
string
required
responseText
string
required