public-docs.xbo-dev.space-app.io Open in urlscan Pro
2606:4700:3108::ac42:2889  Public Scan

URL: https://public-docs.xbo-dev.space-app.io/
Submission: On July 02 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

NAV
 * Introduction
   * Base URL
   * Return codes
   * Authentication
 * List all currencies and networks
 * Deposit Crypto
   * OBSOLETE Get wallet address
   * OBSOLETE Get a unique deposit address
   * Get a unique deposit address
   * OBSOLETE Get a list of all crypto addresses
   * Get a list of all crypto addresses
 * OTC Trading
   * List currency pairs
   * Request for conversion quote
   * Convert funds
   * Check balance on wallet
   * Get OTC trading history
 * Spot Trading
   * Get the list of pairs for trading
   * Place a market order
 * Withdraw
   * Crypto withdrawal
   * Fiat withdrawal
 * Check Balance
 * Transaction history
   * Crypto transactions history
   * Fiat transactions history

 * Documentation Powered by Slate


INTRODUCTION


BASE URL

The base url is https://api.xbo.com

As per RESTful design patterns, XBO Client API uses following HTTP methods:

 * GET - Read resources
 * POST - Create new resources
 * PUT - Modify existing resources
 * DELETE - Remove resources

When you are making a request, you can pass arguments in it as:

 * Parameters
 * Valid JSON with application/json header.

Timestamps and other time-related fields are in milliseconds.

Data in response is listed in chronological order, newest on top.

Parameters for GET endpoints must be sent as a query string.

Parameters For POST, PUT, and DELETE endpoints may be sent as a query string or
in the request body with content type application/json. You can mix parameters
between both the query string and request body.

Parameters can be sent in any order.

If a parameter is sent in both the query string and request body, the query
string parameter will be used.


RETURN CODES

200 Successful Request.

201 Created successfully.

400 Bad Request. Check the format of your request for mistakes and try again.

401 Unauthorized. Check if your API key is eligible for using the endpoint.

500 Server Error. Issue on our side. Contact XBO Customer Support for more
information.

404 Resource is missing. Contact XBO Customer Support for more information.


AUTHENTICATION


API KEY

To access some endpoints you have to obtain API Key and secret.

Never share your API key/secret with anyone.



Copy to Clipboard// C# example
using System.Security.Cryptography;
using System.Text;
using Newtonsoft.Json;

var apiKey = "<apiKey>";
var apiSecret = "<apiSecret>";


var client = new HttpClient
{
    BaseAddress = new Uri("https://api.xbo.com")
};

var pathWithQuery = "/v1/test-api?testParam1=test1&testParam2=test2";
var pathWithOutQuery = "/v1/test-api";
var requestBody = JsonConvert.SerializeObject(
            new
            {
                testProperty1 = "test1",
                testProperty2 = "test12"
            });

var request = new HttpRequestMessage()
{
    Method = HttpMethod.Post,
    Content = new StringContent(requestBody, Encoding.UTF8, "application/json"),
    RequestUri = new Uri($"{pathWithQuery}", UriKind.Relative)
};

using HMACSHA256 hmac = new HMACSHA256(Convert.FromBase64String(apiSecret));
using var sha256 = SHA256.Create();

var contentHash = Convert.ToBase64String(sha256.ComputeHash(Encoding.UTF8.GetBytes(content)));
var timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds();
var signatureString = $"{timestamp}{request.Method}{pathWithOutQuery}{contentHash}";

var signatureHash = hmac.ComputeHash(Encoding.UTF8.GetBytes(signatureString));
request.Headers.Add("XBO-API-KEY", apiKey);
request.Headers.Add("XBO-API-SIGN", Convert.ToBase64String(signatureHash));
request.Headers.Add("XBO-API-TIMESTAMP", timestamp.ToString());

var response = await client.SendAsync(request);
// ...


Copy to Clipboard//JavaScript example
const crypto = require('crypto');
const request = require('request');

const apiKey = "<apiKey>";
const apiSecret = "<apiSecret>";
const pathWithOutQuery = "/v1/test-api";

const req = {
    method: 'POST',
    url: '/v1/test-api?testParam1=test1&testParam2=test2',
    body: JSON.stringify({testProperty1:"test1",testProperty2:"test2"})
};
const timestamp = Math.floor(Date.now());
const contentHash = crypto.createHash("sha256").update(req.body).digest().toString("base64");
const signatureString = timestamp + req.method + pathWithOutQuery + contentHash;
const signature = crypto.createHmac("sha256",  Buffer.from(apiSecret, "base64")).update(Buffer.from(signatureString,"utf8")).digest().toString("base64");

const options = {
    baseUrl: 'https://api.xbo.com',
    url: req.url,
    method: req.method,
    headers: {
        'XBO-API-SIGN': signature,
        'XBO-API-TIMESTAMP': timestamp,
        'XBO-API-KEY': apiKey,
        'content-type': 'application/json'
    },
    body: req.body
};

request(options,function(err, response){
  // ...
}



> Make sure to replace <apiKey> and <apiSecret> with your API key and secret
> respectively.


MAKING REQUEST

All requests to authorized endpoints must contain the following headers:
XBO-API-KEY - API Key
XBO-API-SIGN - Signature (see below)
XBO-API-TIMESTAMP - request timestamp

All request bodies should have content type application/json and be valid JSON


SELECTING TIMESTAMP

XBO-API-TIMESTAMP must be number of milliseconds since
UNIX Epoch. It should be within 60 seconds of the API service time to be
considered as valid.


SIGNING MESSAGE

Signature is generated by creating a SHA256 HMAC using the API secret on the
string timestamp + method + pathWithQuery + contentHash

 * timestamp - the same value as XBO-API-TIMESTAMP
 * method - HTTP method in UPPER CASE
 * pathWithQuery - path of the URL with query string
 * contentHash - base64 encoded SHA256 hash of serialized content (empty for GET
   requests)


LIST ALL CURRENCIES AND NETWORKS

Use this endpoint to list all currencies and, in case of cryptocurrencies, with
their networks listed as well.

HTTP Request

GET /v1/currencies/

> Successful Response

Copy to Clipboard  {
    "currency": "string",
    "type": "string",
    "networks": [
      {
        "addressType": 0,
        "code": "string",
        "name": "string"
      }
    ]
  }


Response Fields

Name Type Description currency string Acronym of currency. type string Type of
currency. addressType string Type of network. code string Acronym (code) of
network. name string Name of network.


DEPOSIT CRYPTO


OBSOLETE GET WALLET ADDRESS

This endpoint is obsolete and supported as legacy.

You can get the address of your wallet in one or more selected currencies using
the following endpoint

HTTP Request

GET /v1/deposit-address/{ **currency** }/{ **network** }

> Successful Response

Copy to Clipboard{
  "currency": "string",
  "address": "string",
  "additionalAddress": "string",
  "additionalAddressType": "string"
}


Parameters

Name Type Required Description currency string + Symbol of the cryptocurrency in
acronym format, e.g., ETH, BTC, USDT, etc. network string + The chain network
code for the currency, e.g., for USDT - OMNI, ERC20, TRC20.

Response Fields

Name Type Description currency string Symbol of wallet's currency in acronym
format, e.g., ETH, BTC, USDT, etc. address string Address of the wallet.
additionalAddress string Additional address info of network, if applicable. Used
for tag, memo and notes of the network. additionalAddressType string Type of the
info in additional address field.


OBSOLETE GET A UNIQUE DEPOSIT ADDRESS

This endpoint is obsolete and supported as legacy. For the new implementation
please refer to the endpoint below.

You can request a unique address for your wallet, individual for each coin and
network.

HTTP Request

POST /v1/deposit-addresses/

> Request Body Example

Copy to Clipboard{
  "currency": "string",
  "networkCode": "string"
}


Parameters

Name Type Required Description currency string + Symbol of the cryptocurrency in
acronym format, e.g., ETH, BTC, USDT, etc. networkCode string + The chain
network code for the currency, e.g., for USDT - OMNI, ERC20, TRC20.

> Successful Response

Copy to Clipboard{
  "currency": "string",
  "address": "string",
  "additionalAddress": "string",
  "additionalAddressType": "string"
}


Response Fields

Name Type Description currency string Symbol of wallet's currency in acronym
format, e.g., ETH, BTC, USDT, etc. address string One-time Address of the
wallet. additionalAddress string Additional address info of network, if
applicable. Used for tag, memo and notes of the network. additionalAddressType
string Type of the info in additional address field.


GET A UNIQUE DEPOSIT ADDRESS

You can request a unique address for your wallet, individual for each coin and
network.

HTTP Request

POST /v2/deposit-addresses/

> Request Body Example

Copy to Clipboard{
    "currency": "BTC",
    "networkCode": "BTC_TEST",
    "addressType": "Additional",
    "clientTag": "tests"
}


Parameters

Name Type Required Description currency string + Symbol of the cryptocurrency in
acronym format, e.g., ETH, BTC, USDT, etc. networkCode string + The chain
network code for the currency, e.g., for USDT - OMNI, ERC20, TRC20. addressType
string + Address type. Can be: Primary, Additional, UniqueTag. clientTag string
Required for "addressType" = "UniqueTag", always empty for "addressType" =
"Primary", optional for "addressType" = "Additional" Unique client's identifier
in external system.

> Successful Response

Copy to Clipboard{
    "currency": "BTC",
    "address": "tb1qpcz67g5fv6y5vhrtvmxmqtnsg2zv5pxclece5n",
    "destinationTag": "string",
    "destinationTagType": "string",
    "addressType": "Additional",
    "clientTag": "testtag1"
}


Response Fields

Name Type Description currency string Symbol of wallet's currency in acronym
format, e.g., ETH, BTC, USDT, etc. address string One-time Address of the
wallet. destinationTag string Additional address info of network, if applicable.
Used for tag, memo and notes of the network. destinationTagType string Type of
the info in destinationTag field. addressType string Address type. Can be:
Primary, Additional, UniqueTag. clientTag string Unique client's identifier in
external system.


OBSOLETE GET A LIST OF ALL CRYPTO ADDRESSES

This endpoint is obsolete and supported as legacy. For the new implementation
please refer to the endpoint below.

You can request the list of all the cryptowallets belonging to you as XBO
client.

HTTP Request

GET /v1/deposit-addresses/

Parameters

Name Type Required Description address string Wallet address. Use this
parameter, to check if the exact wallet address belongs to your client account,
and display its details. networkCode string The chain network code for the
currency, e.g., for USDT - OMNI, ERC20, TRC20.

> Successful Response

Copy to Clipboard[
  {
    "currency": "string",
    "networkCode": "string",
    "address": "string",
    "additionalAddress": "string"
  },
  ....
  {
    "currency": "string",
    "networkCode": "string",
    "address": "string",
    "additionalAddress": "string"
  },
]


Response Fields

Name Type Description currency string Symbol of wallet's currency in acronym
format, e.g., ETH, BTC, USDT, etc. networkCode string The chain network code for
the currency, e.g., for USDT - OMNI, ERC20, TRC20. address string Address of the
wallet. additionalAddress string Additional address info of network, if
applicable. Used for tag, memo and notes of the network.


GET A LIST OF ALL CRYPTO ADDRESSES

You can request the list of all the cryptowallets belonging to you as XBO
client.

HTTP Request

GET /v2/deposit-addresses/

Parameters

Name Type Required Description address string Wallet address. Use this
parameter, to check if the exact wallet address belongs to your client account,
and display its details. networkCode string The chain network code for the
currency, e.g., for USDT - OMNI, ERC20, TRC20. clientTag string Unique client's
identifier in external system.

> Successful Response

Copy to Clipboard[
    {
        "currency": "XRP",
        "networkCode": "XRP_TEST",
        "address": "rBo6XnbVWFzfdCxfX9Ym4mmcEQtoMNr3Gh",
        "destinationTag": "1128467660",
        "type": "Additional",
        "clientTag": "12346"
    },
    {
        "currency": "BTC",
        "networkCode": "BTC_TEST",
        "address": "tb1q72xg8d4w0avuzvj3fzerr76vcumve96smnlhvk",
        "destinationTag": "string",
        "type": "UniqueTag",
        "clientTag": "123467"
    }
]


Response Fields

Name Type Description currency string Symbol of wallet's currency in acronym
format, e.g., ETH, BTC, USDT, etc. networkCode string The chain network code for
the currency, e.g., for USDT - OMNI, ERC20, TRC20. address string Address of the
wallet. additionalAddress string Additional address info of network, if
applicable. Used for tag, memo and notes of the network. clientTag string Unique
client's identifier in external system.


OTC TRADING

XBO Client API gives you the possibility to execute OTC trading transactions.


LIST CURRENCY PAIRS

See List all currencies and networks for more information.


REQUEST FOR CONVERSION QUOTE

Send the request to get the conversion rate for your selected currency pair in
selected amount

HTTP Request

POST /v1/otc-trading/request-for-quote/

> Request Body Example

Copy to Clipboard{
  "fromCurrency": "string",
  "toCurrency": "string",
  "fromAmount": 0,
  "toAmount": 0
}


Parameters

Name Type Required Description fromCurrency string + Acronym of the currency you
want to convert FROM. toCurrency string + Acronym of the currency you want to
convert your existing currency TO. fromAmount double Select one parameter out of
two, otherwise your request will be invalid. Amount of the currency you want to
convert FROM. toAmount double Amount of the currency you want to convert your
existing currency TO.

> Successful response

Copy to Clipboard{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "occuredOn": "2022-12-01T12:56:01.776Z",
  "validTo": "2022-12-01T12:56:01.776Z",
  "fromCurrency": "string",
  "toCurrency": "string",
  "amountFrom": 0,
  "amountTo": 0,
  "rate": 0
}


Response Fields

Name Type Description id string Unique ID of request. occuredOn
string(dateTtime) Time when the request reached our server. validTo
string(dateTtime) Time until the stated rate is valid. If the time has elapsed,
you need to send another request to convert your funds. fromCurrency string
Acronym of the currency you want to convert FROM. toCurrency string Acronym of
the currency you want to convert your existing currency TO. amountFrom decimal
Amount of the currency you want to convert FROM. amountTo decimal Amount of the
currency you want to convert your existing currency TO. rate decimal Conversion
rate, relevant for your request.


CONVERT FUNDS

Place a conversion order, if you agree with the conversion rate for your
selected currency pair.

HTTP Request

POST /v1/otc-trading/convert

> Request Body Example

Copy to Clipboard{
  "id": "string",
  "fromCurrency": "string",
  "toCurrency": "string",
  "fromAmount": 0,
  "toAmount": 0
}


In response you get the ID of the conversion transaction

Parameters

Name Type Required Description id string + Unique ID of request-for-quote
endpoint response. fromCurrency string + Acronym of the currency you want to
convert FROM. toCurrency string + Acronym of the currency you want to convert
your existing currency TO. fromAmount decimal + Amount of the currency you want
to convert FROM. toAmount decimal + Amount of the currency you want to convert
your existing currency TO.


CHECK BALANCE ON WALLET

See Check balance for more information.


GET OTC TRADING HISTORY

Display the desired number of previous records in OTC trading history.

HTTP request

POST /v1/otc-trading/history

> Successful response

Copy to Clipboard{
  "items": [
    {
      "id": 0,
      "operationExecutionTime": "2022-12-02T11:19:33.448Z",
      "amountFrom": 0,
      "amountTo": 0,
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 0,
      "status": "string"
    }
  ],
  "count": 0
}


Parameters

Name Type Required Description page int32 + Offset , each page equals count
value. For example, to get results 20-30, set page to 2, and count to 10. count
int32 + How much records to return.

Response fields

Name Type Description id int32 Unique transaction ID. operationExecutionTime
string(dateTtime) TIme the transaction was executed. amountFrom decimal Amount
of the currency converted FROM. amountTo decimal Amount of the currency
converted TO. fromCurrency string Acronym of the currency converted FROM.
toCurrency string Acronym of the currency converted TO. rate decimal Rate of
conversion. status string Status of the transaction. count int32 Count of the
record.


SPOT TRADING

with XBO Client API you can execute market orders.


GET THE LIST OF PAIRS FOR TRADING

Use this endpoint to get a list of asset pairs, available for trading.

HTTP Request

GET /v1/spot-trading/symbols

Parameters

Name Type Required Description page int32 + Offset , each page equals count
value. For example, to get results 20-30, set page to 2, and count to 10. count
int32 + How much records to return.

> Successful Response

Copy to Clipboard{
  "total": 617,
  "data": [
    {
      "symbol": "1INCH/BTC",
      "description": "1INCH/BTC",
      "baseCurrency": "1INCH",
      "quoteCurrency": "BTC",
      "minVolumeTrade": 1000,
      "maxVolumeTrade": 27586,
      "precision": 8,
      "volumeStep": 0.1
    },
    ....
    {
      "symbol": "1INCH/USD",
      "description": "USD",
      "baseCurrency": "1INCH",
      "quoteCurrency": "USD",
      "minVolumeTrade": 200,
      "maxVolumeTrade": 1000,
      "precision": 8,
      "volumeStep": 0.01
    }
  ]
}


Response Fields

Name Type Description total int32 Total number of trading pairs. symbol string
Acronym for the trading pair. description string Description of the pair.
baseCurrency string Acronym of the base currency in the pair. quoteCurrency
string Acronym of the quote currency in the pair. minVolumeTrade float The
minimal amount of trade you can place an order for the pair. maxVolumeTrade
float The maximal amount of trade you can place an order for the pair.
volumeStep float the minimal amount of increment in trade volume.


PLACE A MARKET ORDER

Use it to trade for a market price, active at the time of order execution.

HTTP Request

POST /v1/spot-trading/orders

> Request Body Example

Copy to Clipboard{
  "symbol": "ETH/USDT",
  "type": "Market",
  "side": "Sell",
  "amount": 0.009
}


Parameters

Name Type Required Description symbol string + Acronym for the trading pair.
type string + Type of the order you are making. Only "Market" type is supported
for now. side string + Are you buying or selling. Can be "Buy" or "Sell". amount
double + The volume of the trade.

> Successful Response

Copy to Clipboard{
  "id": 353108531,
  "symbol": ETH/USDT,
  "baseCurrency": ETH,
  "quoteCurrency": USDT,
  "takerCommission": 0.0,
  "makerCommission": 0.0,
  "type": Market,
  "side": Sell,
  "amount": 0.009,
  "price": 1537.24,
  "openTime": "0001-01-01T00:00:00",
  "updatedOn": "0001-01-01T00:00:00",
  "time": 0
}


Response Fields

Name Type Description id int64 Unique ID of the transaction. symbol string
Acronym for the trading pair. baseCurrency string Acronym of the base currency
in the pair. quoteCurrency string Acronym of the quote currency in the pair.
makerCommission decimal Commission fee for order maker. takerCommission decimal
Commission fee for order taker. type string Type of the order you are making.
Only "Market" type is supported for now. side string Are you buying or selling.
Can be "Buy" or "Sell". amount decimal The volume of the trade. price decimal
The price at which the order is executed. openTime string(dateTtime) Time at
which the order was placed. updatedOn string(dateTtime) Time at which the order
was executed. time int32 Time in ms, passed from order placement to execution.


WITHDRAW

You can withdraw your funds using XBO Client API by using the endpoints
described below.


CRYPTO WITHDRAWAL

Use this endpoint to make a crypto withdrawal.

HTTP Request

POST /v1/withdrawals

> Request Body Example

Copy to Clipboard{   
    "currency": "string",   
    "networkCode": "string",   
    "amount": 0,   
    "destinationAddress": "string",   
    "destinationAdditionalAddress": "string",   
    "referenceId": "string",
    "clientTag": "string"
    }


Parameters

Name Type Required Description currency int32 + Cryptocurrency of the
transaction. networkCode string + Network code of the transaction. amount
decimal + Amount of transaction. destinationAddress string + Address, to which
you are withdrawing. destinationAdditionalAddress string Additional address, if
applicable. referenceId string ID of the transaction in external payment system.
In case of Crypto Payx withdrawal, it will be a payout intent ID. clientTag
string Unique client's identifier in external system.

> Successful response

Copy to Clipboard{   
    "id": 0,   
    "currency": "string",   
    "networkCode": "string",   
    "amount": 0,   
    "fee": 0,   
    "destinationAddress": "string",   
    "destinationAdditionalAddress": "string",   
    "referenceId": "string",
    "clientTag": "string"
}


Response Fields

Name Type Description id int32 Unique ID of the withdrawal. currency string
Cryptocurrency of the transaction. networkCode string Network code of the
transaction. amount decimal Amount of the transaction. fee decimal Fee for the
transaction. destinationAddress string Address, to which the crypto was
withdrawn. destinationAdditionalAddress string Additional address field, if
applicable. referenceId string ID of the transaction in external payment system.
In case of Crypto Payx withdrawal, it will be a payout intent ID. clientTag
string Unique client's identifier in external system.


FIAT WITHDRAWAL

Use the following endpoint to execute fiat withdrawal.

HTTP Request

POST /v1/fiat/withdrawals

> Request Body Example

Copy to Clipboard{
  "amount": 0,
  "currency": "string",
  "iban": "string",
  "bankCountryIso2": "string",
  "recipientName": "string",
  "paymentReason": "string"
  "referenceId": "string"
}


Parameters

Name Type Required Description amount decimal + Amount you want to withdraw.
currency string + Currency in which you want to withdraw. iban string + IBAN of
recipient bank. bankCountryIso2 string + Bank country. recipientName string +
Name of the recipient. paymentReason string + Payment reason. referenceId string
Client's internal transaction ID. Needs to be unique within our system, not only
for client's transactions.

> Successful Response

Copy to Clipboard{
  "id": 0,
  "amount": 0,
  "fee": 0,
  "createdDate": "2022-12-02T06:47:58.261Z",
  "currency": "string",
  "status": "string",
  "reason": "string"
}


Response Fields

Name Type Description id int32 Unique ID of the withdrawal. amount decimal
Amount of the withdrawal. fee decimal Fee for the withdrawal. createdDate
string(dateTtime) When the withdrawal was created. currency string Currency of
the withdrawal. status string Status of withdrawal. reason string Reason of the
withdrawal status.


CHECK BALANCE

To check your balance on your wallets, use the following endpoint

HTTP Request

GET /v1/wallet/accounts

> Successful response

Copy to Clipboard{
  "name": "string",
  "type": "string",
  "currency": "string",
  "totalBalance": 0,
  "availableBalance": 0,
  "totalBalanceUsd": 0,
  "availableBalanceUsd": 0
}


Response Fields

Name Type Description name string Wallet name. type string Wallet type. currency
string Wallet currency. totalBalance decimal Total balance in wallet's currency.
availableBalance decimal Available balance in wallet's currency. totalBalanceUsd
decimal Total wallet's balance equivalent in USD. availableBalanceUsd decimal
Available wallet's balance equivalent in USD.


TRANSACTION HISTORY

Use the corresponding endpoints below to retrieve the history of transactions of
a specific type.


CRYPTO TRANSACTIONS HISTORY

HTTP Request

GET /v1/transactions

Parameters

Name Type Required Description currency string A specific cryptocurrency of
transactions, if needed. page int32 + Offset , each page equals count value. For
example, to get results 20-30, set page to 2, and count to 10. count int32 + How
much records to return. Record limit per one request is 500 transactions.
address string Show records only for the transactions to specific destination
address, if needed. clientTag string Show records only for the transactions to
specific clientTag, if needed. dateFrom string(dateTtime) Starting date for the
transactions. dateTo string(dateTtime) End date for the transactions.

Successful response

Copy to Clipboard{
    "total": 1,
    "data": 
      [
        {
            "id": "CTN77926",
            "currency": "XRP",
            "type": "Receive",
            "status": "Completed",
            "createdOn": "2024-02-12T14:06:32.2440677Z",
            "totalAmount": 20.00,
            "executedAmount": 20.00,
            "fee": 0.0,
            "networkCode": "XRP_TEST",
            "networkName": "XRP Testnet",
            "destinationAddress": "rBo6XnbVWFzfdCxfX9Ym4mmcEQtoMNr3Gh",
            "destinationAdditionalAddress": "1128467660",
            "referenceId": "string",
            "traceId": "string"
            "clientTag": "12346",
            "sourceAddress": "string"
        }   
      ]
}


Response Fields

Name Type Description id string Unique ID of the transaction. currency string
Cryptocurrency of the transaction. type string Type of the transaction. Can be
"Send" or "Receive" status string Status of the transaction. Can be "Pending",
"Completed", and "Declined" createdOn string(dateTtime) When the transaction was
created. totalAmount decimal Gross amount of the transaction. executedAmount
decimal Amount of the transaction, with the fee amount deducted. fee decimal Fee
for the transaction. networkCode string Network code of the transaction.
networkName string Network name of the transaction. networkTransactionId string
Unique network ID of the transaction. destinationAddress string Destination
address of the transaction. destinationAdditionalAddress string Additional
address field, if applicable. referenceId string Client's internal transaction
ID. Needs to be unique within our system, not only for client's transactions.
traceId string ID of the transaction in external payment system. For example, in
case of Crypto Payx transaction, it can be payment intent ID for the deposit,
and payout intent ID for the withdrawal. clientTag string Unique client's
identifier in external system. sourceAddress string Source address of the
transaction. is empty in case of internal transaction.


FIAT TRANSACTIONS HISTORY

HTTP Request

GET /v1/fiat/transactions

Parameters

Name Type Required Description currency string A specific currency of
transactions, if needed. page int32 + Offset , each page equals count value. For
example, to get results 20-30, set page to 2, and count to 10. count int32 + How
much records to return. Record limit per one request is 500 transactions.
dateFrom string(dateTtime) Starting date for the transactions. dateTo
string(dateTtime) End date for the transactions.

> Successful response

Copy to Clipboard{
  "data": [
    {
      "id": "string",
      "status": "string",
      "type": "string",
      "paymentMethod": "string",
      "createdOn": "2023-01-05T11:01:48.853Z",
      "totalAmount": 0,
      "executedAmount": 0,
      "fee": 0,
      "currency": "string",
      "lastCreditCardDigits": "string",
      "bankCountryCode": "string",
      "bankAccount": "string",
      "bankName": "string",
      "acquirerBank": "string",
      "acquirerAddress": "string",
      "acquirerSwift": "string",
      "acquirerAccount": "string"
      "referenceId": "string"
    }
  ],
  "total": 0
}


Response Fields

Name Type Description id string Unique ID of the transaction. status string
Status of the transaction. can be "Pending", "Completed", and "Declined". type
string Type of the transaction. Can be "Deposit" or "Withdrawal". paymentMethod
string Payment method of the transaction. Can be
"CreditCard","Apm","WireTransfer" or 0, if "type"="Withdrawal" createdOn
string(dateTtime) When the transaction was created. totalAmount decimal Gross
amount of the transaction. executedAmount decimal Amount of the transaction,
with the fee amount deducted. fee decimal Fee for the transaction. currency
string Currency of the transaction. lastCreditCardDigits string First and last
digits of the credit card for the transaction. For "CreditCard" payment method.
bankCountryCode string Bank country code. For "Withdrawal" transaction type or
"WireTransfer" payment method. bankAccount string Bank account number. For
"Withdrawal" transaction type or "WireTransfer" payment method. bankName string
Bank name. For "WireTransfer" payment method. acquirerBank string Acquirer name.
For "WireTransfer" payment method. acquirerAddress string Acquirer address. For
"WireTransfer" payment method. acquirerSwift string Acquirer SWIFT code. For
"WireTransfer" payment method. acquirerAccount string Acquirer account number.
For "WireTransfer" payment method.