Skip to main content
API docs by Redocly

Coinsflow (1.0)

Download OpenAPI specification:Download

API documentation

balance

Balance list

This call allows you to get a list of crypto currencies balances. Further filtering for dedicated wallet specific balances is possible via the "Query" parameters section.

Authorizations:
HMAC
query Parameters
asset
uuid

To be used alongside "wallet" parameter. This parameter takes an asset’s ID and isolates the results shown only to that asset

wallet
string

This parameter takes a "dedicated wallet’s" address to return back the available balance only within that particular wallet. If utilized alongside "asset" will limit the results further to show only that particular asset’s balance within the dedicated wallet

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Balance details

This call allows you to get the balance of a crypto currency.

Authorizations:
HMAC
path Parameters
id
required
string

This parameter, added as part of the URL, allows you to single out the desired balance you want information on.

query Parameters
network
required
string

This parameter, added as part of the query, allows you to indicate the desired network in which the balance is available.

Responses

Response samples

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

Balance log list

This call allows you to get a list of logs of crypto currencies balances.

Authorizations:
HMAC

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Balance log details

This call allows you to get the logs of a crypto currencies balance.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired log's balance you want information on.

query Parameters
network
required
string

This parameter, added as part of the query, allows you to indicate the desired network where the log's balance is available.

Responses

Response samples

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

callbacks

Get callbacks url list

This call allows you to get the list of all callback urls (the configured urls where callbacks are received).

Authorizations:
HMAC

Responses

Response samples

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

Create callback url

This call allows you to create a callback url (configure an url where callbacks are received).

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

This parameter allows you to indicate the url path to receive the callbacks.

active
boolean
Default: true

This parameter allows you to indicate if the callback url is active to receive callbacks or not. (it is active by default).

Responses

Response samples

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

Update specific callback url

This call allows you to edit and change a callback url (configure a url to receive callbacks).

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to indicate the unique code that identifies the callback url.

Request Body schema: application/x-www-form-urlencoded
url
string

This parameter allows you to indicate the url path to receive the callbacks.

active
boolean
Default: true

This parameter allows you to indicate if the callback url is active to receive callbacks or not. (it is active by default).

Responses

Response samples

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

Delete specific callback url

This call allows you to delete a callback url (a configured url where callbacks are received).

Note: callbacks are soft deleted to preserve log integrity

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to indicate the unique code that identifies the callback url.

Responses

List callbacks

This call allows you to get the list of all callbacks.

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

status
string
Enum: "QUEUED" "FAILED" "SUCCESS"

This parameter allows you to filter the list by items status (queued, failed or success).

Responses

Response samples

Content type
application/json
{
  • "count": 3,
  • "data": [
    ]
}

Schedule to resend all failed callbacks

This call allows you to try to resend all callbacks with failed status.

Authorizations:
HMAC

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Schedule to resend callbacks by id

This call allows you to try to resend a specific callback (by id).

Authorizations:
HMAC
path Parameters
id
required
string

This parameter displays the unique code that identifies the callback to resend.

Responses

Response samples

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

List callback logs

This call allows you to list all callbacks.

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ]
}

deposit

Deposit create

This call allows you to create a deposit with the desired amount and the desired cryptocurrency (asset).

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
amount
required
string^\d{1,18}(\.\d{1,18})?$

This parameter allows you to insert the desired amount to deposit.

asset
string <uuid>

This parameter allows you to indicate the crypto currency in which the amount is deposited. The asset is provided by the unique code that identifies it (if you don't have the asset's code, contact our support).

externalId
string

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

qr
boolean
Default: false

This parameter (set as FALSE by default), if checked as TRUE, indicates that you want the base64 encoded qr code for this wallet to be included as part of the response so you can decode the base64 string and display it as data:image/png;base64).

Responses

Request samples

Content type
application/x-www-form-urlencoded
amount=10.12&asset=5a841cf2-3786-47ad-8831-36ccea9ed096

Response samples

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

Deposit details

This call allows you to get the information on a specific deposit.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the deposit you want to get the information.

Responses

Response samples

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

Update Deposit

This call allows you to add an external id to a deposit. Keep in mind that this is a one time operation and is only possible if it was null during deposit creation. After adding an externalID you can't change it again.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the deposit you want to get the information.

Request Body schema: application/json
externalId
string

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

Responses

Request samples

Content type
application/json
{
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "asset": {
    },
  • "amount": "10.10",
  • "targetAmount": "string",
  • "wallet": "string",
  • "status": "PENDING",
  • "network": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "toAsset": {
    }
}

Deposit details by Tx Hash

This call allows you to get the information on a specific deposit based off of it’s Tx Hash.

Authorizations:
HMAC
path Parameters
hash
required
string

This parameter allows you to insert the unique Tx Hash and identifies the deposit you want to get the information.

Responses

Response samples

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

Create an order with a deposit

This call allows you to create an order with a deposit.

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
amount
required
string^\d{1,18}(\.\d{1,18})?$

This parameter allows you to insert the desired amount to deposit.

asset
required
string <uuid>

This parameter allows you to indicate the crypto currency in which the amount is deposited. The asset is provided by the unique code that identifies it (if you don't have the asset's code, contact our support).

externalId
string

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

clientEmail
required
string

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

Responses

Response samples

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

Create a deposit for the given order

This call allows you to create one more deposit address for the given order. Useful in case you have order in status UNDERPAID.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the order.

Request Body schema: application/json
asset
string <uuid>

This parameter displays the unique code that identifies the asset.

Responses

Request samples

Content type
application/json
{
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096"
}

Response samples

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

exchange

Exchange create

This call allows you to create an exchange operation between a specific crypto currency (with a determined amount) to another crypto currency.

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
fromAsset
required
string <uuid>

This parameter allows you to determine the crypto currency from what the determined amount will be converted from.

toAsset
required
string <uuid>

This parameter allows you to determine the crypto currency to what the amount of the from crypto currency will be converted to.

amount
required
string

This parameter allows you to determine the amount of the crypto currency that will be converted into another crypto currency.

externalId
string

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

accountId
string <uuid>

This parameter allows you to insert an Account ID if this operation is related to the Account.

freezeRateId
string <uuid>

This parameter allows you to insert a freeze id provided by the /estimate endpoint. If a frozen exchange rate with such id exists, this exchange rate will be used instead of the current exchange rate.

Responses

Response samples

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

Exchange list

This Call allows you to get a list of all Exchanges

Authorizations:
HMAC

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Exchange estimate

This call allows you to estimate the cost of an exchange with an amount of a crypto currency into another cryptocurrency and freeze the rate for 2 minutes.

Authorizations:
HMAC
query Parameters
fromAsset
required
uuid

This parameter allows you to determine the crypto currency from what the determined amount will be converted from.

toAsset
required
uuid

This parameter allows you to determine the crypto currency to what the amount of the from crypto currency will be converted to.

amount
required
uuid

This parameter allows you to determine the amount of the crypto currency that will be converted into another crypto currency.

freezeRate
boolean

This parameter allows you to freeze the exchange rate you receive and use it in exchanges for the next 2 minutes.

freezeRateId
string

This parameter allows you to check if a frozen exchange rate you estimated previously is still applicable.

Responses

Response samples

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

Exchange pairs list

This call allows you to get a list of all pairs of crypto currencies available for conversion.

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

Request Body schema: application/x-www-form-urlencoded
fromAsset
string <uuid>

This parameter displays the crypto currency to be converted from.

toAsset
string <uuid>

This parameter displays the crypto currency to be converted to.

autoExchangeEnabled
boolean

This parameter indicates if the from crypto currency and to crypto currency can be converted automatically.

enabled
boolean

This parameter indicates if the from crypto currency and to crypto currency pair is available to be converted.

Responses

Response samples

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

Exchange rate

This call allows you to get the rate of conversion between a pair of crypto currencies.

Authorizations:
HMAC
query Parameters
amount
required
string

This parameter allows you to determine the amount of the crypto currency that will be converted into another crypto currency.

fromAsset
required
string <uuid>

This parameter allows you to determine the crypto currency from what the determined amount will be converted from.

toAsset
required
string <uuid>

This parameter allows you to determine the crypto currency to what the amount of the from crypto currency will be converted to.

externalId
string

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

accountId
string <uuid>

This parameter allows you to insert an Account ID if this operation is related to the Account.

freezeRateId
string <uuid>

This parameter allows you to insert a freeze id provided by the /estimate endpoint. If a frozen exchange rate with such id exists, this exchange rate will be used instead of the current exchange rate.

Responses

Response samples

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

Exchange rates

This call allows you to get the rates for available assets. You can add several assets, inside an array, to get the rate for all at once.

Authorizations:
HMAC
query Parameters
assets
Array of strings <uuid> [ items <uuid > ]

This parameter allows you to indicate the several assets for which you want to get the rates.

Responses

Response samples

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

merchant

Operation log

This call allows you to get the logs of operations.

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

cookie Parameters
string
Request Body schema:

Operation list filter and order

from
string <date>

This parameter allows you to indicate the start date of the report time range.

to
string <date>

This parameter allows you to indicate the end date of the report time range.

status
string
Enum: "CREATED" "PENDING" "PROCESSING" "PAID" "UNDERPAID" "OVERPAID" "EXPIRED" "FAILED" "SUCCESS" "REFUNDED" "PARTIALLY_REFUNDED" "EXCHANGING" "EXCHANGE_FAILED"

This paramater allows to indicate the operation status to be displayed (hiding all other statuses).

asset
string <uuid>

This paramater allows to indicate the crypto currency used on the operation (hiding all other assets).

assetFrom
string <uuid>

This parameter allows to indicate the crypto currency being exchanged or spent in the transaction.

type
string
Enum: "DEPOSIT" "ORDER" "WITHDRAWAL" "EXCHANGE" "PAYOUT"

This paramater allows to indicate the type of operation (hiding all other operation types).

order
string
Enum: "ASC" "DESC"

This paramater allows to indicate the way the list is displayed (ascending or desceding).

orderField
string
Enum: "operationId" "asset" "createdAt" "clientEmail" "amount" "status" "type"

This paramater allows to indicate the order to display the fields.

search
string

This paramater allows to indicate the partial code of the redId to be displayed (hiding all entries whose refID does not match the partial code).

accounts
Array of strings <uuid> [ items <uuid > ]

This paramater allows to filter by account ID.

orFilter[asset][]
Array of strings <uuid> [ items <uuid > ]

This parameter allows to filer the results by multiple asset values.

orFilter[assetFrom][]
Array of strings <uuid> [ items <uuid > ]

This parameter allows to filer the results by multiple assetFrom values.

Responses

Request samples

Content type
from=2019-08-24&to=2019-08-24&status=CREATED&asset=5a841cf2-3786-47ad-8831-36ccea9ed096&type=DEPOSIT&order=ASC&orderField=operationId&search=string

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Operation Details

This call returns the current state of an Operation, based on the given Reference ID.

Authorizations:
HMAC
path Parameters
id
required
string

Responses

Response samples

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

Asset list

This call allows you to get the list of available assets based on the list of assets configured on your account.

Authorizations:
HMAC
query Parameters
active
boolean

This parameter allows you to filter the list by active, inactive or all crypto currencies.

type
string
Enum: "CRYPTO" "FIAT"

Determines which type of assets should be displayed in the response, if no value is given, the default is all asset types.

Responses

Response samples

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

Asset details

This call allows you to get information on a specific asset.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired crypto currency you want information on.

Responses

Response samples

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

Asset enable

This call allows you to enable a disabled crypto currency on your account.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired crypto currency you want information on.

Responses

Response samples

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

Asset disable

This call allows you to disable an active crypto currency on your account.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired crypto currency you want information on.

Responses

Response samples

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

Auto exchange list

This call allows you to get the list of auto exchange pairs

Authorizations:
HMAC

Responses

Response samples

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

Enable auto exchange

This call allows you to enable a disabled crypto currencies pair auto exchange on your account.

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
fromAsset
required
string <uuid>
toAsset
required
string <uuid>

Responses

Response samples

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

Disable auto exchange

This call allows you to disable an active crypto currencies pair auto exchange on your account.

Authorizations:
HMAC

Responses

Response samples

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

Reporting create

This call allows you to generate reports. The generated report link is sent to the current user's email address.

Authorizations:
HMAC
Request Body schema: application/x-www-form-urlencoded
from
string <date>

This parameter allows you to indicate the start date of the report time range.

to
string <date>

This parameter allows you to indicate the end date of the report time range.

status
string
Enum: "CREATED" "PENDING" "PROCESSING" "PAID" "UNDERPAID" "OVERPAID" "EXPIRED" "FAILED" "SUCCESS" "REFUNDED" "PARTIALLY_REFUNDED" "EXCHANGING"

This parameter allows you to indicate the status to filter the report (CREATED, PENDING, PROCESSING, PAID, UNDERPAID, OVERPAID, EXPIRED, FAILED, SUCCESS, REFUNDED, PARTIALLY_REFUNDED, or EXCHANGING). Leaving the filed empty generates a report with all statuses.

asset
string <uuid>

This parameter allows you to indicate the crypto currency to filter the report. Leaving the field empty generates a report with all assets.

order
string

This parameter allows you to indicate the order to filter the report.

type
string
Enum: "DEPOSIT" "ORDER" "WITHDRAWAL" "EXCHANGE" "PAYOUT"

This parameter allows you to indicate thetype to filter the report (DEPOSIT, WITHDDRAWAL, EXCHANGE, or PAYOUT). Leaving the field empty generates a report with all assets.

orderField
string

This parameter allows you to indicate the order field to filter the report.

reportFormat
string
Enum: "Xlsx" "Xls" "Csv"

This parameter allows you to indicate the format to generate the report (XLXS, XLS, or CSV).

Responses

Response samples

Content type
application/json
{
  • "code": -100,
  • "msg": "Request data is invalid"
}

order

Create an Order

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

This parameter displays the name given to the payment link.

description
required
string

This parameters displays the description given to the payment link's target.

amount
required
string

This parameter displays the amount associated to the order. If left empty, any amount deposited will change the Order to “PAID”

asset
required
string <uuid>

The unique code that identifies the desired asset you want to be the cryptocurrency associated with the Order. Full list of assets will be given to you by Coinsflow integration manager.

clientEmail
string <string>

This parameter displays the email address of the client involved in the transaction. It is optional.

externalId
string <string>

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

expirationDate
string <date>

This parameter sets the date and time until then the client is allowed to follow the payment link (payment link lifetime). The format is as follows: yyyy-mm-dd hh:ii:ss. The date and time should be in UTC.

isSinglePayment
boolean
Default: false

This parameter limits the Order to only one Deposit. amount will not affect final status, it will always reach PAID.

Responses

Response samples

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

List of orders

This call allows you to get the list of orders.

Authorizations:
HMAC
query Parameters
search
string

Search by refId

orderField
string
Enum: "amount" "paidAmount" "asset" "createdAt" "clientEmail" "status" "createdAt"

This parameter allows you to indicate the order field to filter the list. Default createdAt.

offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

from
string <date>

This parameter allows you to indicate the start date of the list.

to
string <date>

This parameter allows you to indicate the end date of the list.

order
string
Enum: "ASC" "DESC"

This parameter allows you to indicate the order.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Order details

This call allows you to get the information on a specific order.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the order.

Responses

Response samples

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

Mark Order as paid

This call allows you to mark an UNDERPAID | OVERPAID | PARTIALLY_REFUNDED order as paid.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the order.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": "string",
  • "asset": {
    },
  • "description": "string",
  • "paidAmount": "string",
  • "clientEmail": "string",
  • "externalId": "string",
  • "status": "CREATED",
  • "operationLog": {
    }
}

Refund the Order

This call allows you to refund an overpaid Order, the refund will be partial, only for the amount above the requested for the Order.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter allows you to insert the unique code and identifies the order.

Responses

Response samples

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

Payment link list

This call allows you to get a list of payment links created.

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

payout

Payout create

This call allows you to create a payout with the desired cryptocurrency (asset), and, optionally, to auto exchnage an asset you have on your balance for the one you want to pay out.

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 optional parameter allows you to specify an address of an account wallet from which you want to make a payout.

walletTag
string

This optional parameter allows you to insert the unique numerical code, required by some blockchains, to pair with the deposit address, as an additional security measure.

exchange
boolean

Set this parameter to true if the payout requires an asset exchange before being processed. When enabled, the system will exchange the asset from your available balance into the one specified in requestedAsset. The recipient will receive the equivalent of amount in requestedAsset, minus any applicable fees.

requestedAsset
string <uuid>

This parameter indicates the asset the funds should be converted to before payout is processed. Mandatory if exchange is true.

treatAsRequestedAmount
boolean

This parameter determines, whether the amount value refers to the requested asset amount. If treatAsRequestedAmount is true, exchange should be true as well. If treatAsRequestedAmount is true, requestedAsset must be provided.

Responses

Response samples

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

Payout list

This Call allows you to get a list of all Payouts

Authorizations:
HMAC

Responses

Response samples

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

Payout estimate

This call allows you to get an estimate on the fees applicable to a specific address to a specific location.

Authorizations:
HMAC
query Parameters
asset
required
string <uuid>

This parameter allows you to indicate the crypto currency in which the payout is to be made. The asset is provided by the unique code that identifies it (if you don't have the asset's code, contact our support).

destination
required
string

This parameter allows you to indicate the address to where the payout is to be made.

amount
string

This parameter specifies amount to be payed out.

exchange
boolean

This parameter determines if the payout requires an asset exchange before being processed.

requestedAsset
string

This parameter specifies the target asset that the asset should be exchanged to.

Responses

Response samples

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

Payout details

This call provides information on the indicated payout.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired payout you want information on.

Responses

Response samples

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

Mass payout create

This call allows you to create several payouts at the same time with the desired cryptocurrency (asset).

Important: This endpoint only accepts application/x-www-form-urlencoded content type. The data parameter must contain CSV data with actual line breaks (not \n escape sequences).

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

This parameter identifies the mass payout on the platform.

data
string

CSV data for creating multiple payouts. Must contain actual line breaks between rows (not \n escape sequences).

Format: destination,amount,asset,treatAsGrossAmount

Note: When using API tools, use Shift+Enter to create actual line breaks in the form data field.

Responses

Request samples

Content type
application/x-www-form-urlencoded
title=string&data=destination%2Camount%2Casset%2CtreatAsGrossAmount%0A0x92009d7A79d3813DD3309e663d3a77844EF675D4%2C0.001%2C0b47a85e-a66a-461c-bb1a-e818def2ff82%2CFALSE

Response samples

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

Payout batch list

This call allows you to get a list of batches (it can be customized by title and\or period).

Authorizations:
HMAC
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

from
string <date>

This parameter indicates the start date and time for the list to be filtered.

to
string <date>

This parameter indicates the end date and time for the list to be filtered.

search
string

This parameter indicates the keyword to search on the title field.

orderField
string
Default: "createdAt"
Enum: "id" "itemsCount" "status" "createdAt" "title"

This parameter indicates the field used to order the entries on the list.

order
string
Default: "DESC"
Enum: "ASC" "DESC"

This parameter indicates the orientation (ascending or descending) of the entries on the list (based on the selected orderField.)

Responses

Response samples

Content type
application/json
{
  • "total": "string",
  • "data": [
    ]
}

Payout batch item list

This call allows you to get a list of entries of the inserted batch.

Authorizations:
HMAC
path Parameters
batchId
required
string <uuid>
query Parameters
offset
integer >= 0
Default: 0

This parameter allows you to indicate in what position to start from the list.

limit
integer [ 0 .. 50 ]
Default: 20

This parameter allows you to determine the amount of results per page.

from
string <date>

This parameter indicates the start date and time for the list to be filtered.

to
string <date>

This parameter indicates the end date and time for the list to be filtered.

search
string

This parameter indicates the keyword to search on the destination address field.

orderField
string
Default: "createdAt"
Enum: "createdAt" "id" "amount" "asset" "destination" "status" "treatAsGrossAmount"

This parameter indicates the field used to order the entries on the list.

order
string
Default: "DESC"
Enum: "ASC" "DESC"

This parameter indicates the orientation (ascending or descending) of the entries on the list (based on the selected orderField.)

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ],
  • "batch": {
    }
}

Add Mass Payout Item

Adds a new entry within a MassPayout Batch that is pending approval

Authorizations:
HMAC
path Parameters
batchId
required
string <uuid>
Request Body schema: application/json
amount
string

This parameter displays the amount of the crypto currency that will be used on the payout operation.

destination
string

This parameter displays the address for the payout operation.

treatAsGrossAmount
string

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.

asset
string

This parameter displays the crypto currency associated with the balance.

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "destination": "string",
  • "treatAsGrossAmount": "string",
  • "externalId": "string",
  • "asset": "string"
}

Delete Mass Payout Item

Deletes a single entry from a MassPayout Batch that is pending approval

Authorizations:
HMAC
path Parameters
batchId
required
string <uuid>
payoutBatchItemId
required
string

Responses

Edit Mass Payout Item

Changes the parameters of an Item within a MassPayout Batch that is pending approval. Parameters with “Inhereted” next to them must remain the same as the original Item within the Batch.

Authorizations:
HMAC
path Parameters
batchId
required
string <uuid>
payoutBatchItemId
required
string
Request Body schema: application/json
amount
string

This parameter displays the amount of the crypto currency that will be used on the payout operation.

asset
string

(Inherited) This parameter displays the crypto currency associated with the balance.

destination
string

This parameter displays the address for the payout operation.

treasAsGrossAmount
string

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).

rowNumber
string

(Inherited) This parameter displays the exact row within the Mass Payout for this Item

externalId
string

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

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "asset": "string",
  • "destination": "string",
  • "treasAsGrossAmount": "string",
  • "rowNumber": "string",
  • "externalId": "string"
}

top up

Top Up details

This call provides information on the indicated topup.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired topup you want information on.

Responses

Response samples

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

Settlement details

This call provides information on the indicated settlement.

Authorizations:
HMAC
path Parameters
id
required
string <uuid>

This parameter, added as part of the URL, allows you to single out the desired settlement you want information on.

Responses

Response samples

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