Latam Payments API Docs
  • Welcome!
  • Quick Start
  • Reference
    • API Reference
      • Authentication
      • Merchant Onboarding and Payment Flow
        • Collectors
        • Point of Sales
        • Store
      • QR
      • Callbacks
Powered by GitBook
On this page
  • Create a new Collector
  • Get an existing Collector
  • Get all Collectors
  • Update a Collector
  • Disable a Collector
  1. Reference
  2. API Reference
  3. Merchant Onboarding and Payment Flow

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

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.

phone

String

Contact phone number for the collector or business.

manager

String

The person in charge of the business location.

{
    "statusCode": 401,
    "message": "Unauthorized"
}
{
    "statusCode": 409,
    "message": "Conflict"
}
Request Body Example
{
    "description": "Electronics wholesaler specializing in consumer devices",
    "external_reference": "electronics_wholesaler_001",
    "address": "1456 Tech Park Drive, Innovation City",
    "phone": "789-123-4567",
    "manager": "Emily Davis",
    "name": "TechSupply Hub",
    "email": "emily.davis@techsupplyhub.com"
}

Get an existing Collector

GET https://qrpayments.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

{
    "description": "Electronics wholesaler specializing in consumer devices",
    "external_reference": "electronics_wholesaler_001",
    "address": "1456 Tech Park Drive, Innovation City",
    "phone": "789-123-4567",
    "manager": "Emily Davis",
    "name": "TechSupply Hub",
    "email": "emily.davis@techsupplyhub.com"
}

Get all Collectors

GET https://qrpayments.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

{[
    {
        "description": "Local bookstore",
        "external_reference": "bookstore_xyz",
        "address": "789 Book Avenue",
        "phone": "987-6543",
        "manager": "Bob",
        "name": "The Book Nook",
        "email": "bob@booknook.com"
    },
    {
        "description": "Bakery located downtown",
        "external_reference": "bakery_001",
        "address": "456 Main Street",
        "phone": "123-4567",
        "manager": "Alice",
        "name": "Downtown Bakery",
        "email": "alice@downtownbakery.com"
    }
]}

Update a Collector

PATCH https://qrpayments.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.

Disable a Collector

PUT https://qrpayments.depay.us/collectors/disable/{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

PreviousMerchant Onboarding and Payment FlowNextPoint of Sales

Last updated 2 months ago