improved

October 8th 2025

Improved

Initiate a payout transaction

The POST endpoint /payout/{user_token} was enhanced with a new query parameter dry_run.

  • dry_run (boolean, optional) — When set to true, performs all validation and calculation checks without initiating the actual payout.
    This allows clients to preview payout results (including limits, fees, and exchange rate validations) before committing the transaction.

Example usage

POST /payout/{user_token}?dry_run=true

Behavior

  • Executes the full validation flow as a regular payout request.
  • Payout token being returned is payout_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
  • No funds are transferred, and no payout transaction is created.
  • Useful for pre-validation and compliance testing in production or sandbox environments.

Backward compatibility
Existing clients remain unaffected. The new parameter is optional and defaults to false if omitted.