Simulator

Find someone to send money to (sandbox only)

GET/simulator/counterparties

Sandbox only. In production this path does not exist and answers 404.

The sandbox's test counterparties, each as the destination its request takes, so you can send it as it is: payoutDestination is an individual Jeton user for POST /payouts, and transferDestination is a business for POST /transfers. Both belong to the sandbox and are the same for every merchant.

A payout or transfer to them is a real one: your balance, limits and fee apply, and its status, event and webhook follow as in production. If the counterparty has no active account in the currency you send, the request is refused as it would be for anyone (payout_recipient_not_found, destination_not_found).

One that this sandbox does not have is absent.

Authentication
ApiKeyAuth
Execution
synchronous

Responses

The test counterparties.

Headers

  • X-Request-Idstring
    The request's trace id: the same value a problem body carries as traceId. Quote it when you contact support. A replayed response (Idempotent-Replayed: true) carries the replay's own; its body keeps the original request's traceId.
  • RateLimit-Limitinteger
  • RateLimit-Remaininginteger
  • RateLimit-Resetinteger
    Seconds until the window resets.

Schema application/json

  • payoutDestinationobject
    The sandbox's test customer. Send it as the destination of POST /payouts.

    Example: {"type":"jeton_account","customerNumber":"4815162342"}

    • typestringrequired

      Allowed values: jeton_account

    • customerNumberstringrequired

      pattern ^[1-9][0-9]{0,18}$

  • transferDestinationobject
    The sandbox's test merchant. Send it as the destination of POST /transfers.

    Example: {"type":"business","merchantNumber":"4455667788"}

    • typestringrequired

      Allowed values: business

    • merchantNumberstringrequired

      pattern ^[0-9]{10}$