Point of Sales

In the context of Depay's ecosystem, a POS (Point of Sale) refers to a specific point, either digital or physical, where payment transactions are processed using interoperable QR codes. Each store, belonging to a customer (merchant), can operate multiple POS terminals, all integrated into the Depay system to handle cross-border payments seamlessly. These points allow merchants to accept payments from tourists or foreign customers using their local wallets, facilitating seamless cross-border sales.

Our API facilitates the comprehensive management of each POS, allowing Customers to add, update, retrieve, and manage multiple Points Of Sale under a single Store. This flexibility supports varied business models and operational scales, ensuring that whether a Store operates a single POS or several, each can be efficiently integrated and managed through Depay's system.

Create a new Point of Sales

POST https://stage.api.payments.depay.us/stores/{store_uuid}/pos

This endpoint allows you to create a new POS for the specified Store

Query Parameters

Name	Type	Description
store_uuid	String	Store identifier

Headers

Name	Type	Description
Authorization*	String	Bearer Token

Request Body

Name	Type	Description
name*	String	The name of the pos being registered.
external_reference*	String	An external identifier provided by the user that uniquely references the pos in their own system.
description	String	A brief description of the pos.

Request Body Example

{
    "name": "testing",
    "external_reference": "94c4631f-0480-4da3-8cc0-170a9ea402a1",
    "description": "Test collector"
}

201: Created POS created

401: Unauthorized

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

404: Not Found

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

Get an existing POS

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

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

Query Parameters

Name	Type	Description
uuid*	string	Branch identifier

Headers

Name	Type	Description
Authentication*	string	Bearer Token

200: OK Successful operation

{
    "uuid": "bc1b79ce-2528-4039-9c08-37836400ab80",
    "createdAt": "2025-06-06T18:11:24.111Z",
    "updatedAt": "2025-06-06T18:11:24.111Z",
    "externalReference": "f1609d5f-7a84-4f54-bb6d-c420bd630451",
    "description": "Test collector",
    "category": 0,
    "store": {
        "uuid": "eb3550e7-92ea-4a15-9990-13a95c52600e",
        "createdAt": "2025-06-06T17:56:37.642Z",
        "updatedAt": "2025-06-06T18:04:33.000Z",
        "description": "123",
        "externalReference": "5e5e18f6-d4b9-4f94-9f83-7877c859015c",
        "address": "Av. Siempreviva 432",
        "phone": "[e-mail]",
        "manager": "John Dou",
        "collector": {
            "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"
}

404: Not Found

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

Get All POS

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

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

Query Parameters

Name	Type	Description
store_uuid*	String	Store identifier

Headers

Name	Type	Description
Authorization*	String	Bearer Token

200: OK Successful operation

{[
    {
       "name": "POS Name",
       "description": "POS Description",
       "external_reference": "external_reference_pos",
       "uuid": "271f9b3f-49b0-4183-9b1a-f4e98287d2b4",
       "enabled": "true"
    },
    {
       "name": "POS Name"
       "description": "POS 2 Description",
       "external_reference": "external_reference_pos_2",
       "uuid": "271f9b3f-49b0-4183-9b1a-f4e98287d2b5",
       "enabled": "true"
    }
]}

401: Unauthorized Premission Denied

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

404: Not Found Branch Not Found

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

Update POS

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

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

Query Parameters

Name	Type	Description
uuid*	String	POS identifier

Request Body

Name	Type	Description
name*	String	The name of the pos being registered.
description*	String	A brief description of the pos
external_reference	String	An external identifier provided by the user that uniquely references the pos in their own system.

Request Body Example

{
    "name": "testing",
    "external_reference": "{{external_reference}}",
    "description": "Test collector2"
}

201: POS updated

{
    "status": 201,
    "message": "PointOfSales updated",
    "data": {
        "uuid": "bc1b79ce-2528-4039-9c08-37836400ab80",
        "createdAt": "2025-06-06T18:11:24.111Z",
        "updatedAt": "2025-06-06T18:30:38.000Z",
        "externalReference": "e32f7151-3bd2-42ad-a37c-be8668a6a3b5",
        "description": "Test collector2"
    }
}

401: Unauthorized

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

404: Not Found

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

Disable POS

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

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

Query Parameters

Name	Type	Description
uuid*	String	POS identifier

Headers

Name	Type	Description
Authorization*	String	Bearer Token

204: No Content POs disabled

401: Unauthorized

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

404: Not Found

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