v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Sandbox

Simulate a payin

Triggers a simulated inbound payin on a sandbox deposit account. Useful for testing payin receipt flows without initiating a real bank transfer. Only available in sandbox environments.

post/api/sandbox/simulate/payin

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

destinationAccountIdstring uuid required

The ID of the payin deposit account that will receive the simulated inbound transfer.

Example request

{
  "destinationAccountId": "b4f3c1d2-89ab-4e56-8f01-23456789abcd",
  "rail": {
    "amount": {
      "value": "2500"
    }
  }
}

Response

The simulated payin was successfully initiated.