Skip to main content
GET
/
v1
/
merchants
List merchants
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "name": "Example Company",
      "full_name": "Example Company LTDA",
      "document_number": "16525269000121",
      "document_type": "CNPJ",
      "contact": {
        "first_name": "John",
        "last_name": "Silva",
        "phone": "+551199999999",
        "email": "[email protected]",
        "mother_name": "Maria Silva",
        "birth_date": "15-08-1990",
        "document_number": "81146431023",
        "politically_exposed": false,
        "address": {
          "street": "Contact Street",
          "street_number": "456",
          "complement": "Apt 201",
          "neighborhood": "Contact Neighborhood",
          "zipcode": "87654321",
          "country": "076",
          "state": "RJ",
          "city": "Rio de Janeiro"
        }
      },
      "status": "ACTIVE",
      "address": {
        "street": "Example Street",
        "street_number": "123",
        "complement": "Suite 101",
        "neighborhood": "Downtown",
        "zipcode": "12345678",
        "country": "076",
        "state": "SP",
        "city": "São Paulo"
      },
      "transfer_configurations": {
        "automatic_transfer_enabled": true,
        "transfer_frequency": "DAILY",
        "rail": "PIX",
        "utc_hour_of_day": 12,
        "day_of_week": 1,
        "day_of_month": 1,
        "min_balance": 1000
      },
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "document_tax_type": "PJ",
      "company_logo_url": "https://example.com/logo.png",
      "website_url": "https://example.com",
      "webhook_enabled": false
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:20

Number of merchants per page

Required range: 1 <= x <= 100
​
status
enum<string>[]

Comma-separated list of statuses to filter by (e.g., inactive,blocked)

Available options:
pending_activation,
active,
inactive,
blocked
​
created_at_from
string<date-time>

Filter merchants created from this date (ISO 8601 format)

​
created_at_to
string<date-time>

Filter merchants created up to this date (ISO 8601 format)

​
document_type
enum<string>

Filter by document type

Available options:
cpf,
cnpj
​
document_number
string

Filter by document number (exact match)

​
name
string

Filter by merchant name (partial start match, case insensitive)

​
full_name
string

Filter by merchant full name (partial start match, case insensitive)

​
sort
enum<string>[]

Sort order (prefix with - for descending). Multiple fields separated by comma

Available options:
created_at,
name,
full_name,
-created_at,
-name,
-full_name

Response

Paginated list of merchants

​
data
object[]
​
pagination
object