Skip to main content
PUT
CLI

Testing balance accounts end to end

  1. Set the customer status to ACTIVE via the customer status endpoint
  2. Simulate USD_BALANCE with this endpoint
  3. Create the balance account
  4. Credit it with account fund-in
The customer must be ACTIVE before capabilities can be simulated. Capabilities that depend on provider-side configuration that cannot be simulated return 400.
Simulating USD_BALANCE also approves external payout accounts that are still in review, including ones created before the capability was enabled. Call it again to approve accounts left in review by an earlier simulation.

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Path Parameters

id
string
required

Customer ID

Body

application/json
capabilities
enum<string>[]
required

Capabilities to make READY for this customer by simulating the underlying approvals.

Available options:
USD_ACH_PAYIN,
USD_ACH_PAYOUT,
USD_WIRE_PAYIN,
USD_WIRE_PAYOUT,
USD_BALANCE,
USD_YIELD,
SWIFT_PAYIN,
SWIFT_PAYOUT,
STABLECOIN_PAYIN,
STABLECOIN_PAYOUT,
STABLECOIN_SWAPS,
AED_FX_PAYOUT,
AUD_FX_PAYOUT,
BHD_FX_PAYOUT,
BOB_FX_PAYOUT,
BRL_FX_PAYOUT,
CLP_FX_PAYOUT,
CNY_FX_PAYOUT,
COP_FX_PAYOUT,
DOP_FX_PAYOUT,
EGP_FX_PAYOUT,
EUR_FX_PAYOUT,
GBP_FX_PAYOUT,
HKD_FX_PAYOUT,
IDR_FX_PAYOUT,
INR_FX_PAYOUT,
JPY_FX_PAYOUT,
KRW_FX_PAYOUT,
KWD_FX_PAYOUT,
MXN_FX_PAYOUT,
MYR_FX_PAYOUT,
PEN_FX_PAYOUT,
PHP_FX_PAYOUT,
PYG_FX_PAYOUT,
QAR_FX_PAYOUT,
SAR_FX_PAYOUT,
SGD_FX_PAYOUT,
THB_FX_PAYOUT,
TRY_FX_PAYOUT,
TWD_FX_PAYOUT,
USD_FX_PAYOUT,
VND_FX_PAYOUT
Example:

Response

Capabilities simulated successfully

id
string
required

Customer ID

Example:

"cus_abc123"

capabilities
object[]
required