Docs
get https://gateway.iugu.com/api/v1/merchants

Listar estabelecimentos (merchants)

Lista os estabelecimentos comerciais (ECs) do workspace, do mais recente para o mais antigo.

Sem ações implementadas definidas

Request

Query params

acquirer

Type: string

Filtra pelo adquirente

Allowed values: cielo, getnet, rede

active

Type: boolean

Filtra por estabelecimentos ativos (`true`) ou inativos (`false`)

Headers

Workspace-Id

Type: string

ID do workspace. Quando ausente, é usado o workspace padrão do Gateway.

Ex: 1D81KhKbYuVq9505Bz4Nk9

Response

200

Lista de estabelecimentos

merchants
Array of objects

id
String

number
String

Número do estabelecimento no adquirente

name
String

legacy_name
String

acquirer
String
Enum: `cielo`, `getnet`, `rede`

active
Boolean

facilitator
Boolean

zero_auth
Boolean

Indica se o estabelecimento é usado para autorização zero

mcc
Object

code
String

description
String

created_at
String

updated_at
String

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "merchants": [
    {
      "id": "<ID>",
      "number": "<NUMBER>",
      "name": "<NAME>",
      "legacy_name": "<LEGACY_NAME>",
      "acquirer": "<ACQUIRER>",
      "active": "<ACTIVE>",
      "facilitator": "<FACILITATOR>",
      "zero_auth": "<ZERO_AUTH>",
      "mcc": {
        "code": "<CODE>",
        "description": "<DESCRIPTION>"
      },
      "created_at": "<CREATED_AT>",
      "updated_at": "<UPDATED_AT>"
    }
  ]
}

400

Parâmetro obrigatório ausente, com tipo/formato inválido ou não documentado

error
String
Enum: `invalid_parameter_error`

error_code
String

`invalid_`

Ex: invalid_sub_merchant_postal_code

details
Object

message
String

Ex: sub_merchant.postal_code format is invalid

Example
1
2
3
4
5
6
7
{
  "error": "<ERROR>",
  "error_code": "invalid_sub_merchant_postal_code",
  "details": {
    "message": "sub_merchant.postal_code format is invalid"
  }
}

401

Não autorizado - Token de autenticação inválido ou ausente

message
String
Enum: `Requires authentication`, `Bad credentials`

Example
1
2
3
{
  "message": "<MESSAGE>"
}