Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Store

Within the Depay system, a Store represents the physical or digital retail outlet operated by a customer (merchant). It is where the customer’s transactions occur using interoperable QR codes and where our payment integration is implemented. Each Store is a unique entity under a customer account, enabling detailed management and analysis of transactions specific to that location. Whether a customer operates a single store or multiple shops across different locations, each is treated as a distinct Store within our platform, facilitating effective cross-border payment management.

Our API includes various endpoints to manage Stores effectively, facilitating operations such as adding new Stores, retrieving information about specific Stores, and updating Store details. This allows customers to tailor their payment processing setup to each Store's needs, ensuring a seamless and efficient payment experience.

Create a new Store for a Collector

POST https://stage.api.payments.depay.us/collectors/{collector_uuid}/stores

This endpoint allows you to create a new Store, within the Depay ecosystem, for a specific Collector.

Query Parameters

Name
Type
Description

collector_uuid

String

collector identifiier

Headers

Name
Type
Description

Authorization*

String

Bearer Token

Request Body

Name
Type
Description

description*

String

A brief description of the store being registered

external_reference*

String

An external identifier provided by the user to uniquely reference the store in their own system.

address*

String

The physical address of the store, used for reference and location purposes.

phone*

String

The contact phone number for the store, useful for communications and inquiries.

manager*

String

The name of the person responsible for managing the store.

Request Body Example
{
    "description": "Retail store specializing in electronics",
    "external_reference": "store_12345",
    "address": "123 Tech Street, Cityville",
    "phone": "123-456-7890",
    "manager": "Jane Doe"
}

Get an existing Store

GET https://stage.api.payments.depay.us/stores/{uuid}

This endpoint allows you to retrieve the details of an existing Store using its unique identifier (UUID).

Query Parameters

Name
Type
Description

uuid*

string

Store identifier

Headers

Name
Type
Description

Authentication*

string

Bearer Token

Get all Stores

GET https://stage.api.payments.depay.us/collectors/{collector_uuid}/stores

This endpoint allows you to retrieve a list of all existing Stores in the Depay ecosystem, for a specific Collector.

Query Parameters

Name
Type
Description

collector_uuid

String

customer identifier

Headers

Name
Type
Description

Authorization*

String

Bearer Token

Update an existing Store

PATCH https://stage.api.payments.depay.us/stores/{uuid}

This endpoint allows you to update the details of an existing Store in the Depay ecosystem.

Query Parameters

Name
Type
Description

uuid*

String

Store identifier

Request Body

Name
Type
Description

description*

String

A brief description of the store being registered

external_reference*

String

An external identifier provided by the user to uniquely reference the store in their own system.

address*

String

The physical address of the store, used for reference and location purposes.

phone*

String

The contact phone number for the store, useful for communications and inquiries.

manager*

String

The name of the person responsible for managing the store.

Disable a Store

PUT https://stage.api.payments.depay.us/stores/{uuid}/disable

This endpoint allows you to disable an existing Store in the Depay ecosystem.

Query Parameters

Name
Type
Description

uuid*

String

Branch identifier

Headers

Name
Type
Description

Authorization*

String

Bearer Token

PreviousCollectorsNextPoint of Sales

Last updated