List Transfer (Shop)

List of Transfer

The List Transfer (Shop) 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/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/

Note: you must insert shop_id in path param request.

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.
side	string	Filter transactions by the transfer side (e.g., Payout or Incomig). Optional filter.
type	string	Filter transactions by the transfer type (e.g., Invoice , Withdraw). Optional filter.
symbol	string	Filter transactions by currency symbol (e.g., "USDT", "BTC"). Optional filter.
create_at	string	Sort transactions by creation date. Accepts either "asc" or "desc" to sort in ascending or descending order.
amount	string	Sorts transfers by amount. Can be "asc" (ascending) or "desc" (descending). Default is no sorting.

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.
created_at*	string	The timestamp when the transfer was created.
side_id*	integer	ID related to the side of the transfer (for example, a unique ID for each transfer side).
side*	string	Type of side for the transfer. Can be Invoice or Withdraw.
type*	string	The type of transfer. Can be Incoming or Payout.
symbol*	string	The symbol of the currency involved in the transfer.
amount*	float	The amount of the currency being transferred. Example: 100.

An example of response:

200: OK

{
    "error": false,
    "number": 0,
    "message": {
        "page_count": 1,
        "page": 1,
        "previous_page": 0,
        "next_page": 0,
        "transfers": [
            {
                "created_at": "2024-09-14 00:35:18.39012 +0330 +0330",
                "side_id": 14,
                "side": "Withdraw",
                "type": "Payout",
                "symbol": "TRX",
                "amount": 100
            },
            {
                "created_at": "2024-09-13 20:11:49.990745 +0330 +0330",
                "side_id": 13,
                "side": "Withdraw",
                "type": "Payout",
                "symbol": "TRX",
                "amount": 100
            }
        ]
    }
}

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/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/?per_page=100&page=1&created_at=desc' \
--header 'X-Api-Key: YOUR_API_KEY'

Python

import requests

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

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

response = requests.get(
    'https://api.payhubix.com/v1/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/',
    params=params,
    headers=headers,
)

Node.js

import axios from 'axios';

const response = await axios.get('https://api.payhubix.com/v1/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/', {
  params: {
    'per_page': '100',
    'page': '1',
    'created_at': 'desc'
  },
  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/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/", [
    'query' => [
        'per_page' => '100',
        'page' => '1',
        'created_at' => 'desc'
    ],
    '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/wallet/shops/019242e7-d18f-788f-813e-a2c72177e172/transfers/?per_page=100&page=1&created_at=desc", 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