Latam Payments API Docs
  • Welcome!
  • Quick Start
  • Reference
    • API Reference
      • Authentication
      • Merchant Onboarding and Payment Flow
        • Collectors
        • Point of Sales
        • Store
      • QR
      • Callbacks
Powered by GitBook
On this page
  • Create a new Store for a Collector
  • Get an existing Store
  • Get all Stores
  • Update an existing Store
  • Disable Store
  • Disable a Store
  1. Reference
  2. API Reference
  3. Merchant Onboarding and Payment Flow

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://qrpayments.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.

{
    "response": {
        "message": "Error description",
    }
}
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://qrpayments.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

{
    "description": "Retail store specializing in electronics and gadgets",
    "external_reference": "electronics_store_12345",
    "address": "456 Gadget Lane, Techville",
    "phone": "321-654-0987",
    "manager": "Alice Smith",
    "uuid": "362f9b3f-39b0-4183-9b1a-f4e98287a1b4",
    "collector": {
        "description": "Electronics distributor and supplier",
        "external_reference": "electronics_collector_001",
        "address": "987 Distribution Park, Tech City",
        "phone": "555-789-1234",
        "manager": "James Miller",
        "name": "TechSupply Co.",
        "email": "james@techsupply.com",
        "uuid": "176f9b3f-39b0-4183-1b2a-f4e98287a1b4",
    },
    "point_of_sales": [
        {
            "name": "Main Electronics POS",
            "description": "POS for general electronic item sales",
            "external_reference": "electronics_pos_1",
            "uuid": "671f9b3f-39b0-4183-9b1a-f4e98287a1b4",
            "enabled": true
        },
        {
            "name": "Gadget Zone POS",
            "description": "POS dedicated to gadgets and accessories",
            "external_reference": "gadget_pos_2",
            "uuid": "671f9b3f-39b0-4183-9b1a-f4e98287a1b5",
            "enabled": true
        }
    ]
}

Get all Stores

GET https://qrpayments.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

{[
    {
        "description": "Home electronics store focusing on appliances and entertainment systems",
        "external_reference": "electronics_store_6789",
        "address": "123 Appliance Avenue, HomeTown",
        "phone": "111-222-3333",
        "manager": "Tom Johnson",
        "collector": {
            "description": "Wholesale electronics distributor specializing in home appliances",
            "external_reference": "appliances_collector_002",
            "address": "345 Wholesale Blvd, Industry City",
            "phone": "555-333-2222",
            "manager": "Sarah Lee",
            "name": "HomeTech Distribution",
            "email": "sarah@hometech.com"
        },
        "point_of_sales": [
            {
                "name": "Appliance Sales POS",
                "description": "POS for appliance and white goods transactions",
                "external_reference": "appliance_pos_1",
                "uuid": "791f9b3f-49b0-4183-9b1a-f4e98287a1c4",
                "enabled": true
            },
            {
                "name": "Entertainment Systems POS",
                "description": "POS for TVs, sound systems, and related products",
                "external_reference": "entertainment_pos_2",
                "uuid": "791f9b3f-49b0-4183-9b1a-f4e98287a1c5",
                "enabled": true
            }
        ]
    },{
        "description": "Gadget store specializing in smartphones and smart devices",
        "external_reference": "gadget_store_5678",
        "address": "789 Innovation Drive, TechPark",
        "phone": "444-555-6666",
        "manager": "Emily Brown",
        "collector": {
            "description": "Supplier of mobile and smart devices for retail",
            "external_reference": "mobile_collector_003",
            "address": "890 Supplier Street, Distributor Town",
            "phone": "555-888-7777",
            "manager": "Michael Green",
            "name": "SmartDevice Supply Co.",
            "email": "michael@smartdevicesupply.com"
        },
        "point_of_sales": [
            {
                "name": "Mobile Devices POS",
                "description": "POS for smartphones and mobile accessories",
                "external_reference": "mobile_pos_1",
                "uuid": "881f9b3f-49b0-4183-9b1a-f4e98287a1d4",
                "enabled": true
            },
            {
                "name": "Smart Gadgets POS",
                "description": "POS for smart home devices and wearables",
                "external_reference": "gadgets_pos_2",
                "uuid": "881f9b3f-49b0-4183-9b1a-f4e98287a1d5",
                "enabled": true
            }
        ]
    }
]}

Update an existing Store

PATCH https://qrpayments.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 Store

Disable a Store

PUT https://qrpayments.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

PreviousPoint of SalesNextQR

Last updated 5 months ago