API Reference
Log In
API Reference

Simulate funding via a specified rail. Only works in staging or sandbox.

General-purpose funding simulation endpoint. Use the rail field to select the funding rail.

Supported rails:

  • interac — Simulates Interac e-Transfer (CAD). Supports reference (issueID/t_id/p_id) and/or amount.
  • spei — Simulates SPEI deposit (MXN) via Bitso test endpoint. Pass reference (issueID or chiRef) to fund an existing transaction, or pass clabe + amount directly.
Body Params
string
enum
required

The funding rail to simulate.

Allowed:

Transaction reference (issueID, chiRef, t_id, or p_id).

number

Funding amount in the rail's currency.

string

CLABE account number (for SPEI direct simulation without a pre-existing transaction).

string
Defaults to Test Sender
string
Defaults to [email protected]
string
Defaults to Test Sender

Receiver name (used for SPEI simulation).

Responses

403

Forbidden — only available in staging or sandbox.

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