List Transfers

List of Transfer

Note: your API key must have the "Assets" permission.

The List Transfer API enables you to retrieve a list of financial transactions from a user's wallet. You can filter transactions by type, currency, date, and amount, and sort the results accordingly. Pagination is supported for easy navigation through large datasets. This API is ideal for viewing detailed transaction histories efficiently.

GET https://api.payhubix.com/v1/transfers/

Request Header:

Name	Type	Description
X-Api-Key*	string	Your API key for authentication and authorization.

Request Params:

Name	Type	Description
page	integer	The current page number for pagination. If not provided, defaults to 1.
per_page	integer	Number of transactions to display per page. If not provided, defaults to 20. Maximum value is capped at 100.

Response

Name	Type	Description
page_count*	integer	Total number of pages.
page*	integer	Current page number.
previous_page*	integer	Previous page number.
next_page*	integer	Next page number.
index*	integer	The position of the transaction in the list.
side_link*	string	A unique identifier for the transaction, used for referencing the deposit.
side*	string	Indicates the type of transaction (e.g., "Deposit"). Invoice or Withdraw.
type*	string	The type of transfer. Can be Incoming or Payout.
amount*	float	The amount of the currency being transferred. Example: 100.
currency.id*	string	A unique identifier for the cryptocurrency.
currency.name*	string	The name of the cryptocurrency (e.g., "Ethereum" or "Litecoin").
currency.symbol*	string	The symbol of the cryptocurrency (e.g., "ETH" or "LTC").
currency.icon_url*	string	The URL of the cryptocurrency's logo or icon.
created_at*	string	The timestamp when the transaction was created (in UTC format).

An example of response:

200: OK

{
    "error": false,
    "number": 0,
    "message": {
        "page_count": 1,
        "page": 1,
        "previous_page": 0,
        "next_page": 0,
        "transfers": [
            {
                "index": 1,
                "side_link": "DEP-MASGM42K",
                "side": "Deposit",
                "type": "Incoming",
                "amount": 0.000144,
                "currency": {
                    "id": 10002,
                    "name": "Ethereum",
                    "symbol": "ETH",
                    "icon_url": "https://payhubixstorage.darkube.app/payhubix/coins_icons/ETH_logo.jpg"
                },
                "created_at": "2025-01-05 10:51:20.756388 +0000 UTC"
            },
            {
                "index": 2,
                "side_link": "DEP-ABY2JIEQ",
                "side": "Deposit",
                "type": "Incoming",
                "amount": 0.001,
                "currency": {
                    "id": 101,
                    "name": "Litecoin",
                    "symbol": "LTC",
                    "icon_url": "https://payhubixstorage.darkube.app/payhubix/coins_icons/Litecoin_logo.jpg"
                },
                "created_at": "2024-12-31 19:30:10.210498 +0000 UTC"
            }
        ]
    }
}

401: Unauthorized

{
    "error": true,
    "number": 401,
    "message": "Unauthorized access to api"
}

403: Forbidden

{
    "error": true,
    "number": 403,
    "message": "You don't have permission to access this resource."
}

500: Something went wrong

{
    "error": true,
    "number": 500,
    "message": "Oops! Something went wrong on our end."
}

Example codes:

cURL

curl --location 'https://api.payhubix.com/v1/transfers/?per_page=100&page=1' \
--header 'X-Api-Key: YOUR_API_KEY'

Python

import requests

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}

params = {
    'per_page': '100',
    'page': '1'
}

response = requests.get('https://api.payhubix.com/v1/transfers/', params=params, headers=headers)

Node.js

import axios from 'axios';

const response = await axios.get('https://api.payhubix.com/v1/transfers/', {
  params: {
    'per_page': '100',
    'page': '1'
  },
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->get('https://api.payhubix.com/v1/transfers/', [
    'query' => [
        'per_page' => '100',
        'page' => '1'
    ],
    'headers' => [
        'X-Api-Key' => 'YOUR_API_KEY'
    ]
]);

Golang

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.payhubix.com/v1/transfers/?per_page=100&page=1", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := io.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

Note: Please make sure to replace YOUR_API_KEY in the code snippets with your actual merchant API key