GET
/
v1
/
vendors
curl --request GET \
  --url https://api.malga.io/v1/vendors \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "items": [
    {
      "id": "db56bd6a-10d7-4039-9c68-fc4405a1a3e1",
      "referenceId": "12345",
      "identityType": "CNPJ",
      "identity": "12.345.678/0001-99",
      "mcc": "1234",
      "name": "Empresa Exemplo Ltda",
      "email": "contato@empresaexemplo.com",
      "phoneNumber": "5511999999999",
      "website": "https://www.empresaexemplo.com",
      "address": {
        "country": "BR",
        "state": "SP",
        "city": "São Paulo",
        "district": "Centro",
        "zipCode": "01001-000",
        "street": "Avenida Paulista",
        "number": "1000",
        "complement": "Apto 101"
      },
      "updatedAt": "2024-06-26T12:34:56Z",
      "createdAt": "2024-06-01T08:00:00Z"
    }
  ],
  "meta": {
    "totalItems": 16,
    "itemCount": 1,
    "itemsPerPage": 1,
    "totalPages": 2,
    "currentPage": 1
  }
}

Authorizations

X-Client-Id
string
headerrequired
X-Api-Key
string
headerrequired

Query Parameters

limit
number
default: 10

Limite de itens retornados na consulta

page
number
default: 1

Páginas da consulta

Response

200 - application/json
id
string

Identificador do vendedor na malga

referenceId
string

Identificador do vendedor no seu sistema

identityType
enum<string>

Tipo de documento

Available options:
CPF,
CNPJ
identity
string

Número do documento formato conforme tipo selecionado

mcc
string

Código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.

name
string

Nome Completo / Razão Social

email
string

Email do vendedor

phoneNumber
string

Telefone de contato do vendedor

website
string

identificação do merchant id a ser utilizado

address
object
updatedAt
string

Data de alteração do vendedor

createdAt
string

Data de criação do vendedor

Atualização de recebedor pelo IDCriação de um novo vendedor