Skip to main content
POST
/
cash-ins
/
simulate
/
auth-commit
Simulate cash-in auth commit
curl --request POST \
  --url https://api.polygon.technology/v0.9/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>"
}
'
{
  "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. Temporary - the real path will be webhook-driven once the cash-in → transaction bridge lands.

​
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