List Shop

see list of shops

The List Shop API provides a paginated list of shops with options to filter and sort the results. You can retrieve a list of shops with various filters such as status and creation date, and specify the number of items per page. This API is useful for managing or displaying multiple shops and provides essential details like shop name, status, and unique identifier.

GET https://api.payhubix.com/v1/payment/shops/

Request Header:

Name
Type
Description

X-Api-Key*

string

Your API key for authentication and authorization.

Request Params:

Name

Type

Description

page

integer

Specifies the current page of the paginated result. Example: ?page=1

per_page

integer

Defines the number of items to display per page. Example: ?per_page=100

status

string

Filters shops by their status. Example: ?status=Enable

created_at

string

Allows sorting of the results based on the shop's creation date. Accepts values such as asc (ascending) or desc (descending). Example: ?created_at=desc

Response:

Name

Type

Description

page_count*

integer

Total number of pages for the current request.

page*

integer

Current page number.

previous_page*

integer

Previous page number.

next_page*

integer

Next page number.

name*

string

Name of the shop (e.g., "Petshop").

is_sandbox*

bool

Indicates whether the shop is in sandbox mode (test mode).

status*

string

Status of the shop (whether it is Enable or Disable).

shop_id*

string

Unique identifier (UUID) of the shop.

website

string

Website of the shop (can be null if not provided).

logo_url

string

URL of the shop's logo (can be null if not provided).

pos_url

string

URL for create pos invoice.

An example of response:

{
    "error": false,
    "number": 0,
    "message": {
        "page_count": 1,
        "page": 1,
        "previous_page": 0,
        "next_page": 1,
        "shops": [
            {
                 "name": "Amazon",
                 "website": "https://www.amazon.com/",
                 "shop_id": "019242e7-d18f-788f-813e-a2c72177e172",
                 "transfer_fee_by": "Customer",
                 "service_fee_by": "Merchant",
                 "logo_url": null,
                 "pos_url": "https://payhubix.com/pos/019242e7-d18f-788f-813e-a2c72177e172"
            }
        ]
    }
}

Example codes:

curl --location 'https://api.payhubix.com/v1/payment/shops/?per_page=100&page=1&created_at=desc&status=Enable' \
--header 'X-Api-Key: YOUR_API_KEY'

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

Last updated