Shop Detail
see detail of shop
Note: your API key must have the "Shops" permission.
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/shops/
019242e7-d18f-788f-813e-a2c72177e172/
Request Header:
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).
is_hidden*
bool
Indicates whether the shop is hidden or visible.
is_sandbox*
bool
Indicates whether the shop is in sandbox (test mode).
pos_url
string
URL for create pos invoice.
currencies
objects
Currency data
An example of response:
{
"error": false,
"number": 0,
"message": {
"shop_id": "019242e7-d18f-788f-813e-a2c72177e172",
"name": "Amazon",
"status": "Enable",
"scope": "E-Commerce",
"description": "Online shop",
"website": "amazon.com",
"logo_url": null,
"transfer_fee_by": "Customer",
"service_fee_by": "Customer",
"service_fee_percent": 1,
"auto_confirmation": 10,
"is_hidden": false,
"is_sandbox": false,
"pos_url": "https://payhubix.com/pos/019242e7-d18f-788f-813e-a2c72177e172",
"currencies": [
{
"currency_id": 115,
"currency_name": "USDC",
"currency_symbol": "USDC",
"currency_type": "Crypto",
"precision": 6,
"withdrawable": true,
"paymentable": false,
"depositable": false,
"currency_icon_url": "https://payhubixstorage.darkube.app/payhubix/coins_icons/USDC_logo.jpg",
"network_id": 8,
"network_symbol": "ARBITRUM",
"network_status": "Disable",
"network_name": "Arbitrum",
"network_icon_url": "https://payhubixstorage.darkube.app/payhubix/network_icons/arbitrum_logo.jpg",
"network_scanner_url": "https://arbiscan.io/tx/",
"fee_withdraw": 0.6,
"fee_payment": 0.5,
"minimum_withdraw": 2,
"minimum_deposit": 2,
"is_native": false,
"tag": "stable-coins",
"supports_memo": false
}
]
}
}
Example codes:
curl --location 'https://api.payhubix.com/v1/shops/019242e7-d18f-788f-813e-a2c72177e172/' \
--header 'X-Api-Key: YOUR_API_KEY'
Last updated