Merchants

Overview

The Merchants resources in the POS Portal API are essential for handling all aspects of merchant accounts, including creating, updating, and managing merchants within your system. This guide will walk you through how to effectively use the merchant resources to manage your merchant accounts. In the context of POS Portal, a merchant refers to a single location under a client. Each merchant operates as an individual entity within the broader client organization, representing a specific business location or branch that is serviced or supported through our platform.

Managing Merchants

Managing merchants involves a variety of tasks, from setting up new merchant accounts to updating existing ones and retrieving merchant details. Below are the key steps for using the merchant resources in the POS Portal API.

Step 1: Create a New Merchant

The first step in managing merchants is to create new merchant accounts as needed.

• Create Merchant
  Use this endpoint to create a new merchant account within the system. This involves providing necessary details such as the merchant's name, address, and contact information. This will create a new merchant account and return the details of the newly created merchant.

  POST /v2/merchants
  

Sample Request:

{
  "merchantName": "New Merchant",
  "address": {
    "line1": "123 Main St",
    "city": "Anytown",
    "region": "CA",
    "postalCode": "90210",
    "country": "US"
  },
  "contact": {
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "555-1234"
  }
}

Step 2: Retrieve Merchant Details

Once a merchant account is created, you may need to retrieve the details of the merchant for various purposes.

• Get Merchant Details
  Use this endpoint to retrieve detailed information about a specific merchant, including their address, contact information, and account status. This will return comprehensive details about the merchant, allowing you to manage the account effectively.

  GET /v2/merchants/{id}
  

Step 3: Update Merchant Information

As merchants grow and change, you may need to update their account information to keep records accurate and up-to-date.

• Update Merchant Information
  Use this endpoint to update the details of an existing merchant. This could involve changing the address, updating contact details, or modifying account settings. This ensures that the merchant’s account information is current and accurate.

  PATCH /v2/merchants/{id}
  

Sample Request:

{
  "address": {
    "line1": "456 New St",
    "city": "Newtown",
    "region": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contact": {
    "name": "Jane Doe",
    "email": "janedoe@example.com",
    "phone": "555-5678"
  }
}

Step 4: Delete a Merchant

In some cases, you may need to remove a merchant from the system, either due to account closure or other reasons.

• Delete Merchant
  Use this endpoint to delete a merchant from the system. This action is typically irreversible, so it should be used with caution. This will remove the merchant from the system, freeing up resources and ensuring that only active accounts are maintained.

  DELETE /merchants/{id}
  

Summary

Effective merchant management is crucial for maintaining accurate records and ensuring smooth operations. By using the merchant resources in the POS Portal API, you can create, update, retrieve, and delete merchant accounts as needed, keeping your system organized and efficient.

For more detailed information on the Merchant endpoint and its parameters, please refer to the POS Portal API Documentation.