Skip to content
FFastPay Docs

Crypto

Request a withdrawal

POST/api/v1/crypto/withdrawals

Checks the address, the balance and the minimum, prices it and emails the business admin a code bound to its amount and address. Nothing moves until the code is confirmed. An amount below the smallest that can be sent after fees is refused with details.minimum_units and details.asset.

AuthorizationBearer sk_test_… or sk_live_…

Headers#

  • X-Fastpay-ModestringOptional

    One of test, live.

  • Idempotency-KeystringRequired

    Client-generated key that makes the request safe to retry. Replaying the key with an identical payload returns the original response; replaying it with a different payload is rejected. Up to 255 characters.

Body parameters#

  • amount_unitsintegerRequired

    Base units of 8 decimals. At least 1.

  • assetstringRequired
  • address_iduuidOptional

Responses#

  • 201Requested; a code was sent
  • 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.