Simulate Card Authorization

Use the /simulateCardAuth endpoint to simulate a card authorization in non-production environments. This endpoint creates but does not settle a card authorization for the account.


📘 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 account must be active
  • For debit accounts, sufficient balance is required
  • Card blocks must be set to 'none' on the account

Result:

When successfully called, this endpoint returns an authId that can be used with Simulate Card Settle to complete the transaction.

Choosing the simulation path (useAttachedCardNetwork):

Some accounts have a card network (Galileo) attached on top of a different primary system of record — for example, a LoanPro-backed line of credit with an attached Galileo 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 (Galileo). 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 primary vendor (e.g., LoanPro for an LMS-backed account), 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 primary vendor. For native Galileo accounts (where Galileo is also the primary vendor), this is always Galileo.
  • true — forces the attached card network path. Returns a 400 ATTACHED_CARD_NETWORK_NOT_FOUND error if the account has no attached card network.
  • false — forces the account's primary path, even if a card network is attached. For a LoanPro-backed account this routes the simulation to the LMS side.

For native Galileo accounts (no separate primary vendor), all three values resolve to the same Galileo simulation.

Body Params

POST /v1/transaction/simulateCardAuth Request body

string
required

Pass in the Spidr account ID

double
required
≤ 10000000

The amount of the simulated authorization

string

The description of the simulated transaction

string

The MCC code of the merchant for the simulated transaction

string
length between 1 and 100

The name of the merchant for the simulated transaction

string

The type of simulated card transaction metadata to use

boolean

Controls which path the simulation runs on for accounts that have a card network attached on top of a different primary vendor (e.g., a LoanPro-backed account with an attached Galileo card). Omit to default to the attached card network when present, otherwise the account's primary vendor. Set true to force the attached card network — returns a 400 ATTACHED_CARD_NETWORK_NOT_FOUND error if the account has none. Set false to force the account's primary path (e.g., the LMS-side simulation) even when a card network is attached. For native Galileo accounts, all three values resolve to Galileo. See the endpoint description for full details.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json