> For the complete documentation index, see [llms.txt](https://docs.latam-payments.depay.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.latam-payments.depay.us/reference/api-reference/merchant-onboarding-and-payment-flow/store.md).

# 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 i**nteroperable 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

<mark style="color:green;">`POST`</mark> `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

<table><thead><tr><th width="217">Name</th><th width="140">Type</th><th>Description</th></tr></thead><tbody><tr><td>collector_uuid</td><td>String</td><td>collector identifiier</td></tr></tbody></table>

#### Headers

<table><thead><tr><th width="220">Name</th><th width="144">Type</th><th>Description</th></tr></thead><tbody><tr><td>Authorization<mark style="color:red;">*</mark></td><td>String</td><td>Bearer Token</td></tr></tbody></table>

#### Request Body

<table><thead><tr><th width="229">Name</th><th width="142">Type</th><th>Description</th></tr></thead><tbody><tr><td>description<mark style="color:red;">*</mark></td><td>String</td><td>A brief description of the store being registered</td></tr><tr><td>external_reference<mark style="color:red;">*</mark></td><td>String</td><td>An external identifier provided by the user to uniquely reference the store in their own system.</td></tr><tr><td>address<mark style="color:red;">*</mark></td><td>String</td><td>The physical address of the store, used for reference and location purposes.</td></tr><tr><td>phone<mark style="color:red;">*</mark></td><td>String</td><td>The contact phone number for the store, useful for communications and inquiries.</td></tr><tr><td>manager<mark style="color:red;">*</mark></td><td>String</td><td>The name of the person responsible for managing the store.</td></tr></tbody></table>

<details>

<summary>Request Body Example</summary>

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

</details>

{% tabs %}
{% tab title="201: Created Store created" %}

```json
{
    "status": 201,
    "message": "Store created",
    "uuid": "16146fd1-aee2-444e-916d-586e7debb9e7"
}
```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "statusCode": 401,
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="404: Not Found" %}

```json
{
    "statusCode": 404,
    "message": "Error creating the store. Collector not found"
}
```

{% endtab %}

{% tab title="409: Conflict Error creating Branch" %}

```json
{
    "response": {
        "message": "Error description",
    }
}
```

{% endtab %}
{% endtabs %}

## Get an existing Store

<mark style="color:blue;">`GET`</mark> `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<mark style="color:red;">\*</mark> | string | Store identifier |

#### Headers

| Name                                             | Type   | Description  |
| ------------------------------------------------ | ------ | ------------ |
| Authentication<mark style="color:red;">\*</mark> | string | Bearer Token |

{% tabs %}
{% tab title="200: OK Successful operation" %}

```json
{
    "uuid": "eb3550e7-92ea-4a15-9990-13a95c52600e",
    "createdAt": "2025-06-06T17:56:37.642Z",
    "updatedAt": "2025-06-06T17:56:37.642Z",
    "description": "123",
    "externalReference": "d97c884a-aebc-451f-a375-b6061afcf582",
    "address": "Av. Siempreviva 432",
    "phone": "test1@depay.us",
    "manager": "John Doe",
    "point_of_sales": []
}

```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "statusCode": 401,
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="404: Not Found" %}

```json
{
    "statusCode": 404,
    "message": "Store not found"
}
```

{% endtab %}
{% endtabs %}

## Get all Stores

<mark style="color:blue;">`GET`</mark> `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<mark style="color:red;">\*</mark> | String | Bearer Token |

{% tabs %}
{% tab title="200: OK Successful operation" %}

```json
[
    {
        "uuid": "fa036507-ca23-4426-94a4-746ca3bc18cb",
        "createdAt": "2025-06-06T17:50:16.551Z",
        "updatedAt": "2025-06-06T17:50:16.551Z",
        "description": "123",
        "externalReference": "09124d3a-3f46-40a1-9aee-d41f9623dd31",
        "address": "Av. Siempreviva 432",
        "phone": "test8@depay.us",
        "manager": "John Doe"
    },
    {
        "uuid": "eb3550e7-92ea-4a15-9990-13a95c52600e",
        "createdAt": "2025-06-06T17:56:37.642Z",
        "updatedAt": "2025-06-06T17:56:37.642Z",
        "description": "123",
        "externalReference": "d97c884a-aebc-451f-a375-b6061afcf582",
        "address": "Av. Siempreviva 432",
        "phone": "test1@depay.us",
        "manager": "John Doe"
    }
]
```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "statusCode": 401,
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="404: Not found" %}

```json
{
    "statusCode": 404,
    "message": "Collector not found"
}
```

{% endtab %}
{% endtabs %}

## Update an existing Store

<mark style="color:purple;">`PATCH`</mark> `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<mark style="color:red;">\*</mark> | String | Store identifier |

#### Request Body

<table><thead><tr><th width="229">Name</th><th width="142">Type</th><th>Description</th></tr></thead><tbody><tr><td>description<mark style="color:red;">*</mark></td><td>String</td><td>A brief description of the store being registered</td></tr><tr><td>external_reference<mark style="color:red;">*</mark></td><td>String</td><td>An external identifier provided by the user to uniquely reference the store in their own system.</td></tr><tr><td>address<mark style="color:red;">*</mark></td><td>String</td><td>The physical address of the store, used for reference and location purposes.</td></tr><tr><td>phone<mark style="color:red;">*</mark></td><td>String</td><td>The contact phone number for the store, useful for communications and inquiries.</td></tr><tr><td>manager<mark style="color:red;">*</mark></td><td>String</td><td>The name of the person responsible for managing the store.</td></tr></tbody></table>

{% tabs %}
{% tab title="201: Store updated" %}

```json
{
    "status": 201,
    "message": "Store updated"
}
```

{% endtab %}

{% tab title="401: Unauthorized" %}

```json
{
    "statusCode": 401,
    "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="404: Not Found" %}

```json
{
    "statusCode": 404,
    "message": "Store not found"
}
```

{% endtab %}
{% endtabs %}

## Disable a Store

<mark style="color:orange;">`PUT`</mark> `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<mark style="color:red;">\*</mark> | String | Branch identifier |

#### Headers

| Name                                            | Type   | Description  |
| ----------------------------------------------- | ------ | ------------ |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer Token |

{% tabs %}
{% tab title="204: No Content Branch disabled" %}

{% endtab %}

{% tab title="401: Unauthorized Permision denied" %}

{% endtab %}

{% tab title="404: Not Found Branch not found" %}

{% endtab %}

{% tab title="409: Conflict Error disabling Branch" %}

{% endtab %}
{% endtabs %}