Dashboard API

API for pulling your transactions from Poko dashboard

Endpoint

• Staging: https://stg.api.onramp.pokoapp.xyz/api/public/dashboard/transactions

• Production: https://api.onramp.pokoapp.xyz/api/public/dashboard/transactions

Making request

• Method: GET

• Header: attach your API_SECRET_KEY into this key x-api-secret

• Params

  • skip: for pagination, the number of records to ignore

  • take: for pagination, the number of records expected to get (max value is 50)

  • from_date: query all records from a specific date (example: 2023-05-23T07:10:36.822Z)

Example code

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://stg.api.onramp.pokoapp.xyz/api/public/dashboard/transactions?skip=2&take=2',
  'headers': {
    'x-api-secret': 'YOUR_API_SECRET_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Response

• transactions: list of transactions

• total: number of records returned (for pagination)

• skip: number of records have been ignored (for pagination)

Example response

{
    "transactions": [
        {
            "id": "e1654038-99cf-4db9-9823-b29497394304",
            "providerOrderId": "80855404-11d3-469e-b95d-537e707c5e68",
            "cryptoAmount": "0.01862846",
            "fiatAmount": "950000",
            "cryptoCurrency": "ETH",
            "fiatCurrency": "VND",
            "paymentMethod": "Card Payment", // serialized payment method from Poko
            "original_paymentMethod": "credit_debit_card", // payment method from the provider
            "provider": "transak",
            "usdAmount": "34.66306185602105",
            "status": "Succeeded", // serialized status from Poko
            "original_status": "COMPLETED", // status from the provider
            "transaction_hash": "DUMMY_TX_ID",
            "created_at": "2023-04-24T06:58:02.655Z",
            "updated_at": "2023-04-24T06:59:27.149Z",
            "user_data": {
                "userId": "poko_test_id_stag",
                "email": ""
            },
            "network": "ethereum",
            "transaction_link": "https://etherscan.io/tx/DUMMY_TX_ID",
            "walletReceive": null
        },
    ],
    "total": 1,
    "skip": 0
}