Skip to main content
API docs by Redocly

Coinsflow (1.0)

Download OpenAPI specification:Download

API documentation

payout

Payout create

This call allows you to create a payout with the desired cryptocurrency (asset).

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
amount
string

This parameter displays the amount of the selected asset to send to another wallet.

destination
string

this parameter displays the address of the wallet to receive the inserted amount.

asset
string <uuid>

This parameter displays the selected crypto currency in which the amount will be sent.

treatAsGrossAmount
boolean
Default: false

This parameter indicates if the network fee is deducted from the requested amount (set as True) or from your account (set as False, by default). This allows you to define who is charged with the network fee (the payout receiver or you).

externalId
string

This parameter allows you to insert an Internal ID (from your own system) to better keep track of these operations.

fromAddress
string

This parameter specifies the dedicated address you want to use for the Payout.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}