Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Payments

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.
post/v0.2.4/payment/simulate-funding

Request body

rail'interac' | 'spei' required

The funding rail to simulate.

amountnumber

Funding amount in the rail's currency.

clabestring

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

senderNamestring
senderEmailstring email
receiverNamestring

Receiver name (used for SPEI simulation).

Response

Funding simulation completed.

statusstring

Example response

{
  "status": "success",
  "data": {
    "simulated": true
  }
}