API Reference
Start typing to search…

Merchant API

What is a Merchant?

A merchant is an entity representing your customer within the Pix integration flow. It corresponds to the client registered in your system, based on the customer information you maintain on your side. A merchant is essentially a customer of your platform who offer Pix as a payment method for Brazilian Customers. Creating a merchant record enables our platform to link each transaction to a well-defined customer profile, ensuring data consistency, accurate identification and stronger compliance validation.

Merchant API – Overview

The Merchant API provides a complete set of endpoints for managing merchant records within the Pix integration flow.
These endpoints allow you to create, update, list, and delete merchants, ensuring full control and consistency of the merchant data used when generating Pix transactions.

A merchant is a required entity in the Pix flow, and its identifier (merchant_id) must be referenced when creating Pix orders.
Each merchant record contains essential attributes such as name, city, industry, and category, allowing for precise classification and operational consistency.

After registering a merchant, you can reference the corresponding merchant_id in Pix order creation requests.
By doing so, the transaction details become more complete, enabling enhanced compliance checks and improved customer protection across the entire payment flow.

Merchant Management Capabilities

  • Create Merchant – Register a new merchant and inform the merchant_id which will be used in Pix transactions.
  • List Merchants – Retrieve all merchants, sorted by creation date (most recent first), with optional filtering by name or industry.
  • Update Merchant – Modify merchant information using the merchant_id generated by our system.
  • Delete Merchant – Permanently remove a merchant and prevent its use in future Pix operations.

These endpoints ensure reliable synchronization between your system and Pix transaction generation, providing a robust, scalable, and compliant-ready foundation for merchant management, monitoring, and customer safety.