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://qrpayments.depay.us/stores/{store_uuid}/pos
This endpoint allows you to create a new POS for the specified Store
Query Parameters
store_uuid
String
Store identifier
Headers
Authorization*
String
Bearer Token
Request Body
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.
Get an existing POS
GET https://qrpayments.depay.us/pos/{uuid}
This endpoint allows you to retrieve the details of an existing POS using its unique identifier (UUID).
Query Parameters
uuid*
string
Branch identifier
Headers
Authentication*
string
Bearer Token
Get All POS
GET https://qrpayments.depay.us/stores/{store_uuid}/pos
This endpoint allows you to retrieve a list of all existing POS in the Depay ecosystem
Query Parameters
store_uuid*
String
Store identifier
Headers
Authorization*
String
Bearer Token
Update POS
PATCH https://qrpayments.depay.us/pos/{uuid}
This endpoint allows you to update the details of an existing POS in the Depay ecosystem.
Query Parameters
uuid*
String
POS identifier
Request Body
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.
Disable POS
PUT https://qrpayments.depay.us/pos/disable/{uuid}
This endpoint allows you to disable an existing Collector in the Depay ecosystem.
Query Parameters
uuid*
String
POS identifier
Headers
Authorization*
String
Bearer Token
Last updated