Sign in

v3

latestOpenAPI 3.1.02026-08-06186981679.4 KB
merchant

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.

post/merchant/withdraws/payout/delegated

Headers

Authorizationstring required

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

Request body

speed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' required
accountstring required

The debit card, bank or Iban pci-compliant token

userIdstring required

The Merchant generated userId for the user.

waitForConfirmationboolean

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.

idempotencyKeystring required

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.

Response

Ok

signaturestring
effectiveSpeed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' required