Simulations

Simulate Card Authorization Increment

⚠️ Sandbox & development only. Simulation endpoints are not available in production and return 404 Not Found there.

Simulates incrementing the amount of a previously simulated card authorization in the sandbox. Pass the authorization_id returned when you created the authorization.

post/simulations/card_authorizations/{authorization_id}/increment

Request

Path parameters

authorization_idstring required

The simulated authorization, as returned by Simulate Card Authorization.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

is_amount_controllableboolean nullable

Whether the final captured amount may differ from the incremented amount.

Response

Successful Response

authorization_idstring required

The authorization identifier. Pass this to capture, increment, or reverse the authorization.

status'pending' | 'closed' | 'expired' | 'reversed' required
amountstring required

The authorization amount, in dollars.

approvedboolean required

Whether the authorization was approved.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

Changes

No recorded changes to this operation across all 1 revision of this API.