Use the /simulateCardSettle endpoint to settle a simulated card authorization that was created via Simulate Card Auth.
📘 Note: This endpoint is only available in non-production environments (local, development, sandbox, cv). Calls to this endpoint in production will return an error.
Requirements:
- The
authIdmust be from a valid pending authorization - The account must be active
Result:
When successfully called, the authorization is settled and the account balance is updated accordingly.
Choosing the simulation path (useAttachedCardNetwork):
useAttachedCardNetwork):Some accounts have a card network attached on top of a different primary system of record — for example, a line of credit with an attached card. For those accounts there are two distinct paths that can produce a transaction, and this flag controls which one the simulation exercises:
- Card network path — the simulation is run against the attached card network. This mirrors what happens in production when a real card swipe is authorized by the network and then forwarded to the primary system.
- Primary path — the simulation is run directly against the account's system of record (e.g., the loan management system for a line of credit), bypassing the card network. Useful for testing the system-of-record's behavior in isolation.
Behavior by value:
- Omitted (default) — runs on the attached card network when one is present on the account; otherwise runs on the account's system of record. For standard card accounts (where the card network is also the system of record), this is always the card network.
true— forces the attached card network path. Returns a400 ATTACHED_CARD_NETWORK_NOT_FOUNDerror if the account has no attached card network.false— forces the account's primary path, even if a card network is attached. For a line-of-credit account this routes the simulation to the loan management system.
For standard card accounts (no separate system of record), all three values resolve to the same simulation.
Important: the value passed here must match the value used on the originating Simulate Card Auth call. Settling on a different path than the auth was created on will fail to find the pending authorization.
