merchant

Payout to a user via Coinflow Wallet

Changed on

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

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/merchant/withdraws/payout/delegated
  • Auth
    API key in header Authorization

Request body

speed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' | 'crypto' required
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' | 'crypto' required

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security merchant was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id payout-from-delegated-settlement-wallet removed and replaced with merchant_PayoutFromDelegatedSettlementWallet