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

POST 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*	String	Bearer Token

Request Body

Name	Type	Description
code	String	Internal identifier generated by the system for the collector.
external_reference*	String	An external identifier provided by the user that uniquely references the collector in their own system.
name*	String	The name of the collector or business being registered.
fantasy_name	String	The trade name or informal name of the collector or business.
legal_address	String	The physical address of the collector or business.
regular_contact_email*	String	The email address of the collector or business, used for communication and notifications.
regular_contact_phone	String	Contact phone number for the collector or business.
country_code	String	ISO 3166-1 alpha-2 country code representing the business location (e.g., AR, BR, US).
description*	String	A brief description of the collector or business being registered.

Request Body Example

{
    "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": "[e-mail]",
    "regular_contact_phone": "12313123",
    "country_code": "AR",
    "description": "Collector de prueba"
}

201: Created Collector

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

401: Unauthorized Permission Denied

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

409: Conflict Error creating Collector

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

Get an existing Collector

GET 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*	string	Collector identifier

Headers

Name	Type	Description
Authentication*	string	Bearer Token

200: OK Successful operation

{
    "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": "[e-mail]",
    "regular_contact_phone": "12313123",
    "country_code": "AR",
    "address": "Av. Siempreviva 432",
    "code": "123",
    "company": null,
    "category": null,
    "color": null,
    "customer": {
        "uuid": "d9e5a7f6-8a56-4b49-b7f2-40a714fa30be",
        "createdAt": "2024-11-05T15:14:31.865Z",
        "updatedAt": "2024-12-05T16:21:31.082Z",
        "country_code": "AR",
        "tax_id": "30-123456798-6",
        "legal_name": "Customer",
        "fantasty_name": "CustomerTest",
        "legal_address": "Fake Street, 123",
        "regular_contact_email": "[e-mail]",
        "regular_contact_phone": "[phone]",
        "depayFee": "0.0400",
        "logo": null,
        "primaryColor": null,
        "secondaryColor": null
    },
    "store": []
}

401: Unauthorized

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

404: Not Found

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

Get all Collectors

GET 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*	String	Bearer Token

200: OK Successful operation

[
    {
        "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": "[e-mail]",
        "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": "[e-mail]",
        "regular_contact_phone": "12313123",
        "country_code": "AR",
        "address": "Av. Siempreviva 432",
        "code": "123",
        "company": null,
        "category": null,
        "color": null
    }
]

401: Unauthorized

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

Update a Collector

PATCH 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

Name	Type	Description
uuid*	String	Collector identifier

Request Body

Name	Type	Description
name	String	The name of the collector or business being registered.
email	String	The email address of the collector or business, used for communication and notifications.
description	String	A brief description of the collector or business being registered
external_reference	String	An external identifier provided by the user that uniquely references the collector in their own system.
address	String	The physical address of the collector or business, used for reference or notifications.
phone	String	Contact phone number for the collector or business.
manager	String	The person in charge of the business location.

204: No Content Customer updated

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

401: Unauthorized

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

404: Not Found

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

Disable a Collector

PUT 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*	String	Collector identifier

Headers

Name	Type	Description
Authorization*	String	Bearer Token

204: No Content Collector disabled

401: Unauthorized Permision denied

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

404: Not Found Collector not found

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

409: Conflict Error disabling Customer