The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
batchIduuidRequired
The batchId value for this operation. Its accepted type and constraints are listed above and below.
afterintegerRequired
The after value for this operation. Its accepted type and constraints are listed above and below.
min: -1 · max: 999
limitintegerRequired
Maximum records per page, subject to the contract limit.
min: 1 · max: 100
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
batchobjectRequired
The batch value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
batchIduuidRequired
The batchId value for this operation. Its accepted type and constraints are listed above and below.
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"queued""complete"
totalintegerRequired
The total value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 1000
processedintegerRequired
The processed value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 1000
itemsarrayRequired
The items value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 100
Show child fields
positionintegerRequired
The position value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 999
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
idempotencyKeystringRequired
Stable business idempotency key. The same key and payload replay the result; do not randomize on retries.
minLength: 1 · maxLength: 120
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"queued""accepted""rejected""failed"
receiptobject | nullRequired
The receipt value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
entitlementIduuidRequired
The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
kindenumRequired
The kind value for this operation. Its accepted type and constraints are listed above and below.
The originalId value for this operation. Its accepted type and constraints are listed above and below.
quantityobjectRequired
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
requestedQuantityobjectOptional
Original quantity for explicit cap/overflow. quantity is the quantity accepted or rejected by the operation.
overageBehaviorenumOptional
cap accepts the largest permitted quantity, possibly zero. overflow requests the full quantity subject to overage permission, usage caps and cash budgets. Omission keeps all-or-nothing behavior.
Show allowed values
"cap""overflow"
acceptedbooleanRequired
Whether business rules accepted the operation. HTTP 200 does not imply accepted is true.
reasonenum | nullRequired
Rejection reason or ledger operation description; interpret with accepted and status.
createdAtdate-timeRequired
ISO 8601 UTC time when the record was created.
reservationStatusenum | nullRequired
The reservationStatus value for this operation. Its accepted type and constraints are listed above and below.
expiresAtdate-time | nullRequired
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
allocationsarrayRequired
Balance allocations involved in this evaluation or ledger operation.
maxItems: 500
errorCodeenum | nullRequired
The errorCode value for this operation. Its accepted type and constraints are listed above and below.
nextAfterinteger | nullRequired
The nextAfter value for this operation. Its accepted type and constraints are listed above and below.
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.