Shop Detail

see detail of shop

The Shop Detail API allows you to retrieve detailed information about a specific shop using its unique shop ID. This API provides comprehensive details including the shop's status, description, fees, and associated currencies. It is useful for obtaining all necessary information about a shop for administrative or display purposes.

GET https://api.payhubix.com/v1/payment/shops/019242e7-d18f-788f-813e-a2c72177e172/

Note: you must insert shop_id in request

Request Header:

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

Response:

Name	Type	Description
shop_id*	string	Unique identifier (UUID) of the shop (e.g., "0191d2f3-6bba-7ed7-9a85-1dc165a43c36").
name*	string	Name of the shop (e.g., "Petshop").
status*	string	Status of the shop (whether it is Enable or Disable).
scope	string	The operational scope of the shop (e.g., "test"). Can be null.
description	string	A description of the shop (e.g., "Petshop").
website	string	Website of the shop.
logo_url	string	URL of the shop's logo.
transfer_fee_by*	string	Indicates who is responsible for the transfer fee (Customer or Merchant).
service_fee_by*	string	Indicates who is responsible for the service fee (Customer or Merchant).
service_fee_percent*	float	Percentage of the service fee charged by the merchant (e.g., 1%).
auto_confirmation*	float	Percentage of auto confirmation amount(e.g., 0 means no auto confirmation).
url*	string	The shop URL.
is_hidden*	bool	Indicates whether the shop is hidden or visible.
is_sandbox*	bool	Indicates whether the shop is in sandbox (test mode).
currency_id*	integer	Unique identifier of the currency.
currency_name*	string	Name of the currency (e.g., Tether, Bitcoin).
currency_status*	string	Status of the currency (whether it is Enable or Disable).
currency_symbol*	string	Symbol of the currency (e.g., USDT, BTC).
currency_type*	string	Indicates whether the currency is Fiat or Crypto.
currency_icon_url*	string	URL of the currency's icon image.
slug	string	URL-friendly slug or short name of the currency (e.g., tether).
network_id#*	integer	Unique identifier of the network for the currency.
network_symbol#*	string	Symbol of the network (e.g., TRX for Tron).
network_status#*	string	Status of the network (whether it is Enable or Disable).
network_name#*	string	Name of the network (e.g., Tron, Ethereum).
network_icon_url#*	string	URL of the network icon.
network_scaner_url#*	string	URL for the block explorer or scanner for the currency's network (if available).
fee_withdraw#*	float	Fee charged for withdrawal in this currency.
fee_payment#*	float	Fee charged for payment in this currency.
minimum_withdraw#*	float	Minimum amount that can be withdrawn.
precision*	integer	Decimal precision of the currency.
withdrawable*	bool	Whether the currency can be withdrawn.
paymentable*	bool	Whether the currency can be used for payments.
status*	string	Current status of the currency (typically "Enable").
is_native#*	bool	Indicates whether the currency is native to the network (e.g., TRX is native to the Tron network).
pos_url	string	URL for create pos invoice.

Note: If Currency was Fiat then # fields are not present.

An example of response:

200: OK

{
    "error": false,
    "number": 0,
    "message": {
        "shop_id": "019242e7-d18f-788f-813e-a2c72177e172",
        "name": "Amazon",
        "status": "Enable",
        "scope": "test",
        "description": "Amazon",
        "website": "https://www.amazon.com/",
        "logo_url": null,
        "transfer_fee_by": "Customer",
        "service_fee_by": "Merchant",
        "service_fee_percent": 1,
        "auto_confirmation": 0,
        "url": "",
        "is_hidden": false,
        "is_sandbox": false,
        "currencies": [
            {
                "currency_id": 1,
                "currency_name": "Tron",
                "currency_status": "Enable",
                "currency_symbol": "TRX",
                "currency_type": "Crypto",
                "currency_icon_url": "https://payhubix.com/payhubix/coins_icons/TRX_logo.jpg",
                "slug": "",
                "network_id": 1,
                "network_symbol": "TRX",
                "network_status": "Enable",
                "network_name": "Tron",
                "network_icon_url": "https://payhubix.com/payhubix/network_icons/TRX_logo.jpg",
                "network_scaner_url": "",
                "fee_withdraw": 0,
                "fee_payment": 0,
                "minimum_withdraw": 0,
                "precision": 0,
                "withdrawable": false,
                "paymentable": false,
                "status": "",
                "is_native": false,
                "pos_url": "https://payhubix.com/pos/019242e7-d18f-788f-813e-a2c72177e172"
            }
        ]
    }
}

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/payment/shops/019242e7-d18f-788f-813e-a2c72177e172/' \
--header 'X-Api-Key: YOUR_API_KEY'

Python

import requests

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

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

Node.js

import axios from 'axios';

const response = await axios.get('https://api.payhubix.com/v1/payment/shops/019242e7-d18f-788f-813e-a2c72177e172/', {
  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/payment/shops/019242e7-d18f-788f-813e-a2c72177e172/', [
    '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/payment/shops/019242e7-d18f-788f-813e-a2c72177e172/", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "X-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