Skip to content
FFastPay Docs

Crypto

Change an automatic withdrawal

PUT/api/v1/crypto/auto-withdrawals/{asset}

Turns a coin's automatic withdrawal on or off. On needs a verified address for that coin and the code emailed to the business admin for exactly this setting: without a code, one is sent (202) and nothing changes. Through the secret key it also needs API withdrawals turned on.

AuthorizationBearer sk_test_… or sk_live_…

Path parameters#

  • assetstringRequired

Headers#

  • X-Fastpay-ModestringOptional

    One of test, live.

Body parameters#

  • enabledbooleanRequired
  • address_iduuidOptional
  • codestringOptional

    The code emailed to the business admin. Up to 12 characters.

  • minimum_unitsintegerOptional

    At least 0.

  • run_atstringOptional

Responses#

  • 200OK
  • 202A code was emailed to the business admin; nothing changed yet.
  • 400The request could not be read.
  • 401The secret key is missing, invalid or revoked.
  • 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
  • 404Nothing was found for this business and mode.
  • 409The request clashes with the current state, such as a reference reused with different details.