GET/api/v1/pagamentos/merchants

Listar

Esta API retorna uma lista de comerciantes, possivelmente paginada.

Parâmetros

AcceptObrigatório
header

application/json

Tipo:string
AuthorizationObrigatório
header

Bearer {{TOKEN}}

Tipo:string
pageOpcional
query

Número da página a ser retornada

Tipo:integer

Parâmetros de Query (Opcionais)

Esta API suporta paginação. Os seguintes parâmetros de query podem ser usados:

  • page: Número da página a ser retornada
  • Outros parâmetros de filtragem ou ordenação, se aplicáveis

Descrição dos Campos da Resposta

Campo data

Um array de objetos, onde cada objeto representa um comerciante:

  • id: ID único do comerciante (UUID)
  • pix_integration: Tipo de integração Pix
  • code: Código do comerciante
  • name: Nome do comerciante
  • document: Documento do comerciante (ex: CNPJ, CPF)
  • account_id: ID da conta
  • pix_key: Chave Pix
  • account_token: Token da conta (pode ser null)
  • external_id: ID externo
  • channel_id: ID do canal
  • created_at: Data e hora de criação (formato ISO 8601)
  • updated_at: Data e hora da última atualização (formato ISO 8601)

Objeto contendo links para paginação.

Campo meta

Metadados sobre a paginação.

curl --location 'https://api-h.nuvende.com.br/api/v1/pagamentos/merchants' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{TOKEN}}'
const axios = require("axios");

const config = {
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v1/pagamentos/merchants",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{TOKEN}}",
  },
};

axios(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });
import requests

url = "https://api-h.nuvende.com.br/api/v1/pagamentos/merchants"

headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {{TOKEN}}'
}

response = requests.get(url, headers=headers)

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v1/pagamentos/merchants',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer {{TOKEN}}'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
{
  "data": [
    {
      "id": "9dd1b184-a167-4131-b68a-27be0c20c2b9",
      "pix_integration": "external",
      "code": "423c56d4-07c1-4bcd-bf2a-fa7b0b29e46b",
      "name": "Vandervort LLC",
      "document": "11222333000181",
      "account_id": "c29d3752-cf26-41a2-a108-bc03209aa825",
      "pix_key": "20125aa5-aabf-4fa0-b5bc-d81d519c5da7",
      "account_token": null,
      "external_id": "ab62b6dc-3fc4-4434-a679-5c64fb58d6d7",
      "channel_id": "0591d83c-03a3-4fc6-8812-9baabb170843",
      "created_at": "2024-12-26T18:58:39+00:00",
      "updated_at": "2024-12-26T18:58:39+00:00"
    },
    {
      "id": "9dd1b195-95f5-4a3c-8b94-e213d644b8b6",
      "pix_integration": "external",
      "code": "78ea7ba3-ff2f-492a-b575-6b199d398159",
      "name": "Kulas - Auer",
      "document": "11222333000181",
      "account_id": "105c75bd-da87-48b4-9208-7d977bbaa715",
      "pix_key": "6a6b5407-9d07-4996-86e6-7099c7dafa08",
      "account_token": null,
      "external_id": "b441df31-92a4-46d5-b8b0-4fabc3925f2c",
      "channel_id": "0591d83c-03a3-4fc6-8812-9baabb170843",
      "created_at": "2024-12-26T18:58:50+00:00",
      "updated_at": "2024-12-26T18:58:50+00:00"
    }
  ],
  "links": {
    "first": "http://localhost:8082/api/merchants?page=1",
    "last": "http://localhost:8082/api/merchants?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://localhost:8082/api/merchants?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http://localhost:8082/api/merchants",
    "per_page": 50,
    "to": 2,
    "total": 2
  }
}