API ReferenceMerchant

Payout to a user via Coinflow Wallet

Payout a user from the coinflow wallet balance. By default, this endpoint waits for transaction confirmation before returning. Set waitForConfirmation to false to return immediately after queuing the transaction.

Authentication

Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.
speedenumRequired
userIdstringRequired
The Merchant generated userId for the user.
idempotencyKeystringRequired
Client generates an idempotency key, which is a unique key that the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions.
accountstring or objectRequired

The payout destination. Every speed except crypto takes the payout account token; the crypto speed takes the on-chain destination.

amountobjectRequired
waitForConfirmationbooleanOptional

If true (default), the API will wait for transaction confirmation before returning. If false, the transaction will be queued for processing and the API will return immediately with just the signature.

Response

Ok
effectiveSpeedenum
signaturestringOptional

Errors

402
Payment Required Error
451
Unavailable for Legal Reasons Error
503
Service Unavailable Error