> 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/collectors.md).

# Collectors

In the Depay ecosystem, a **Collector** refers to a merchant or business that utilizes our payment gateway services to process transactions. **Collector** integrate Depay's technology into their operations to offer seamless QR code-based payment options from different countries, simplifying and securing their sales processes. Essentially, **Collectors** are businesses looking to enhance the convenience of cross-border payments, ensuring that tourists or users from other regions can easily complete transactions using their local wallets.

Our API provides a suite of endpoints designed to manage **Collector** accounts efficiently, allowing for actions such as creating new **Collector** records, retrieving details about specific **Collectors**, listing all **Collectors**, and updating existing **Collector** information. 

## Create a new **Collector**

<mark style="color:green;">`POST`</mark> `https://stage.api.payments.depay.us/collectors`

This endpoint allows you to create a new Collector within the Depay ecosystem. A Collector represents a merchant or business that integrates our payment gateway to facilitate QR code-based cross-border payments. This is the first step in managing a Collector's payment operations and making them accessible for future transactions through our API.

#### Headers

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

#### Request Body

<table><thead><tr><th width="195">Name</th><th width="101">Type</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>Internal identifier generated by the system for the collector.</td></tr><tr><td>external_reference<mark style="color:red;">*</mark></td><td>String</td><td>An external identifier provided by the user that uniquely references the collector in their own system.</td></tr><tr><td>name<mark style="color:red;">*</mark></td><td>String</td><td>The name of the collector or business being registered.</td></tr><tr><td>fantasy_name</td><td>String</td><td>The trade name or informal name of the collector or business.</td></tr><tr><td>legal_address</td><td>String</td><td>The physical address of the collector or business.</td></tr><tr><td>regular_contact_email<mark style="color:red;">*</mark></td><td>String</td><td>The email address of the collector or business, used for communication and notifications.</td></tr><tr><td>regular_contact_phone</td><td>String</td><td>Contact phone number for the collector or business.</td></tr><tr><td>country_code</td><td>String</td><td>ISO 3166-1 alpha-2 country code representing the business location (e.g., AR, BR, US).</td></tr><tr><td>description<mark style="color:red;">*</mark></td><td>String</td><td>A brief description of the collector or business being registered.</td></tr></tbody></table>

<details>

<summary>Request Body Example</summary>

```json
{
    "code": "123",
    "external_reference": "7688391d-d967-4f61-93e6-13fb594dbc0f",
    "name": "Collector Test",
    "fantasy_name": "Collector Test",
    "tax_id": "213123123",
    "legal_address": "Fake Street 432",
    "regular_contact_email": "test1@depay.us",
    "regular_contact_phone": "12313123",
    "country_code": "AR",
    "description": "Collector de prueba"
}
```

</details>

{% tabs %}
{% tab title="201: Created Collector" %}

```json
{
    "collector_uuid": "188f08fc-80c6-4d62-b723-06008c55Ce"
}
```

{% endtab %}

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

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

{% endtab %}

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

```json
{
    "statusCode": 409,
    "message": "Conflict"
}
```

{% endtab %}
{% endtabs %}

## Get an existing Collector

<mark style="color:blue;">`GET`</mark> `https://stage.api.payments.depay.us/collectors/{uuid}`

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

#### Query Parameters

| Name                                   | Type   | Description          |
| -------------------------------------- | ------ | -------------------- |
| uuid<mark style="color:red;">\*</mark> | string | Collector identifier |

#### Headers

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

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

```json
{
    "uuid": "188f08fc-80c6-4d62-b723-06008c55Ce",
    "createdAt": "2025-06-06T15:37:16.358Z",
    "updatedAt": "2025-06-06T15:37:16.358Z",
    "externalReference": "c2594bb7-c27a-47b3-8a6b-29f7cf023886",
    "name": "Collector Test",
    "fantasty_name": "Collector Test",
    "description": "Collector de prueba",
    "tax_id": "213123123",
    "image": null,
    "regular_contact_email": "test0@depay.us",
    "regular_contact_phone": "12313123",
    "country_code": "AR",
    "address": "Av. Siempreviva 432",
    "code": "123",
    "company": null,
    "category": null,
    "color": null,
    "store": []
}
```

{% 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 %}

## Get all Collectors

<mark style="color:blue;">`GET`</mark> `https://stage.api.payments.depay.us/collectors`

This endpoint allows you to retrieve a list of all existing Collectors in the Depay ecosystem.

#### Headers

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

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

```json
[
    {
        "uuid": "763f5d43-0730-4c82-bc61-2958b589c8d6",
        "createdAt": "2025-04-28T14:06:58.329Z",
        "updatedAt": "2025-05-06T14:36:35.499Z",
        "externalReference": "892b2d92-ffd0-4c8f-9b74-8b42c5a3d5d7",
        "name": "Collector Test Endpoint",
        "fantasty_name": "Collector Test",
        "description": "Collector de prueba",
        "tax_id": "213123123",
        "image": null,
        "regular_contact_email": "test2@depay.us",
        "regular_contact_phone": "12313123",
        "country_code": "AR",
        "address": "Av. Siempreviva 432",
        "code": "123",
        "company": null,
        "category": null,
        "color": null
    },
    {
        "uuid": "188f08fc-80c6-4d62-b723-06007c974efe",
        "createdAt": "2025-06-06T15:37:16.358Z",
        "updatedAt": "2025-06-06T15:37:16.358Z",
        "externalReference": "c2594bb7-c27a-47b3-8a6b-29f7cf023886",
        "name": "Collector Test",
        "fantasty_name": "Collector Test",
        "description": "Collector de prueba",
        "tax_id": "213123123",
        "image": null,
        "regular_contact_email": "test60@depay.us",
        "regular_contact_phone": "12313123",
        "country_code": "AR",
        "address": "Av. Siempreviva 432",
        "code": "123",
        "company": null,
        "category": null,
        "color": null
    }
]
```

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

## Update a Collector

<mark style="color:purple;">`PATCH`</mark> `https://stage.api.payments.depay.us/collectors/{uuid}`

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

#### Query Parameters

<table><thead><tr><th width="232">Name</th><th width="139">Type</th><th>Description</th></tr></thead><tbody><tr><td>uuid<mark style="color:red;">*</mark></td><td>String</td><td>Collector identifier</td></tr></tbody></table>

#### Request Body

<table><thead><tr><th width="236">Name</th><th width="139">Type</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td>String</td><td>The name of the collector or business being registered.</td></tr><tr><td>email</td><td>String</td><td>The email address of the collector or business, used for communication and notifications.</td></tr><tr><td>description</td><td>String</td><td>A brief description of the collector or business being registered</td></tr><tr><td>external_reference</td><td>String</td><td>An external identifier provided by the user that uniquely references the collector in their own system.</td></tr><tr><td>address</td><td>String</td><td>The physical address of the collector or business, used for reference or notifications.</td></tr><tr><td>phone</td><td>String</td><td>Contact phone number for the collector or business.</td></tr><tr><td>manager</td><td>String</td><td>The person in charge of the business location.</td></tr></tbody></table>

{% tabs %}
{% tab title="204: No Content Customer updated" %}

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

{% 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 %}

## Disable a Collector

<mark style="color:orange;">`PUT`</mark> `https://stage.api.payments.depay.us/collectors/disable/{collector_uuid}`

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

#### Query Parameters

| Name                                   | Type   | Description          |
| -------------------------------------- | ------ | -------------------- |
| uuid<mark style="color:red;">\*</mark> | String | Collector identifier |

#### Headers

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

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

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}

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

{% endtab %}
{% endtabs %}