GET/api/v2/partners/requests

Listar Solicitações

Lista todas as solicitações realizadas pelo parceiro autenticado.

Parâmetros

AuthorizationObrigatório
header

Token de autenticação obtido no login do parceiro.

Tipo:string

Cabeçalhos obrigatórios:

CabeçalhoValorDescrição
AuthorizationBearer {{ access_token }}Token de autenticação obtido no login do parceiro.

Campos principais

CampoTipoDescrição
dataarrayLista de solicitações cadastradas.
partnerobjectDados do parceiro que fez a solicitação.
applicationobjectDados da aplicação associada à solicitação.
statusstringStatus da solicitação (pending, approved, etc).
originstringOrigem da solicitação (partner, api, etc).
namestringNome do usuário solicitante.
documentstringDocumento do usuário solicitante.
emailstringE-mail do usuário solicitante.
phonestringTelefone do usuário solicitante.
webhook_urlstringURL para receber notificações de alterações de status.
metadataarrayInformações adicionais associadas à solicitação.
created_atstringData de criação da solicitação (ISO8601).
updated_atstringData da última atualização da solicitação (ISO8601).
links / metaobjectInformações de paginação.

Status das Solicitações

StatusDescrição
pendingSolicitação aguardando aprovação do cliente.
approvedSolicitação aprovada pelo cliente.
rejectedSolicitação rejeitada pelo cliente.
expiredSolicitação expirada.
cancelledSolicitação cancelada pelo parceiro.

Origem das Solicitações

OrigemDescrição
partnerSolicitação criada pelo parceiro via API.
apiSolicitação criada via integração direta.
webSolicitação criada via interface web.

Observações

  • O token {{ access_token }} deve ser válido e obtido via login do parceiro.
  • As solicitações listadas podem ter diferentes status (pending, approved, rejected) de acordo com o fluxo de aprovação.
  • Utilize os parâmetros de paginação (page) conforme necessário para percorrer todas as solicitações.
  • Apenas solicitações do parceiro autenticado são retornadas.
  • O campo decision_at indica quando o cliente tomou a decisão (se aplicável).

Códigos de Resposta

CódigoSignificadoDescrição
200OKLista de solicitações retornada com sucesso.
401UnauthorizedToken de autenticação inválido ou expirado.
500Internal Server ErrorErro interno do servidor.

Filtros Disponíveis

Você pode usar os seguintes parâmetros de query para filtrar os resultados:

ParâmetroTipoDescrição
statusstringFiltrar por status da solicitação.
application_idstringFiltrar por ID da aplicação.
originstringFiltrar por origem da solicitação.
pageintegerNúmero da página para paginação.
per_pageintegerNúmero de itens por página (máximo 100).

Exemplo com filtros:

curl --location 'https://dominio-ambiente.com.br/api/v2/partners/requests?status=pending&page=1&per_page=20' \
--header 'Authorization: Bearer {{ access_token }}'

Observações Importantes

  • O token {{ access_token }} deve ser válido e obtido via login do parceiro.
  • As solicitações listadas podem ter diferentes status (pending, approved, rejected) de acordo com o fluxo de aprovação.
curl --location 'https://dominio-ambiente.com.br/api/v2/partners/requests' \
--header 'Authorization: Bearer {{ access_token }}'
const listRequests = async (token) => {
  try {
    const response = await fetch('https://dominio-ambiente.com.br/api/v2/partners/requests', {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });

    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }

    const data = await response.json();
    
    console.log('Solicitações encontradas:', data.data.length);
    data.data.forEach(request => {
      console.log(`- ${request.name} (${request.status})`);
    });
    
    return data;
  } catch (error) {
    console.error('Erro ao listar solicitações:', error);
    return null;
  }
};

// Uso
const token = '{{ access_token }}';
listRequests(token);
import requests

def list_requests(token):
    url = "https://dominio-ambiente.com.br/api/v2/partners/requests"
    
    headers = {
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()
        
        data = response.json()
        
        print(f"Solicitações encontradas: {len(data['data'])}")
        for request in data['data']:
            print(f"- {request['name']} ({request['status']})")
            print(f"  Documento: {request['document']}")
            print(f"  Escopos: {', '.join(request['scopes'])}")
        
        return data
        
    except requests.exceptions.RequestException as e:
        print(f"Erro na requisição: {e}")
        return None

# Uso
token = "{{ access_token }}"
result = list_requests(token)
<?php

function listRequests($token) {
    $url = 'https://dominio-ambiente.com.br/api/v2/partners/requests';
    
    // Configuração do cURL
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'
    ]);
    
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    $error = curl_error($ch);
    curl_close($ch);
    
    if ($error) {
        echo "Erro cURL: " . $error . "\n";
        return null;
    }
    
    if ($httpCode !== 200) {
        echo "Erro HTTP: " . $httpCode . "\n";
        echo "Resposta: " . $response . "\n";
        return null;
    }
    
    $data = json_decode($response, true);
    
    if (json_last_error() !== JSON_ERROR_NONE) {
        echo "Erro ao decodificar JSON: " . json_last_error_msg() . "\n";
        return null;
    }
    
    echo "Solicitações encontradas: " . count($data['data']) . "\n";
    
    foreach ($data['data'] as $request) {
        echo "- " . $request['name'] . " (" . $request['status'] . ")\n";
        echo "  Documento: " . $request['document'] . "\n";
        echo "  Escopos: " . implode(', ', $request['scopes']) . "\n";
    }
    
    return $data;
}

// Uso
$token = '{{ access_token }}';
listRequests($token);
?>
{
  "data": [
    {
      "id": "c3sdaa792-f8b6-4fe1-ad19-f8ea16a723c5",
      "partner": {
        "id": "650c723160-98d9-45d3-a1e0-eb24db30d22e",
        "name": "parceiro",
        "contact_email": "[email protected]",
        "contact_phone": "99999999999",
        "status": "pending",
        "scopes": [
          "dict.read",
          "webhooks.read",
          "terminals.read",
          "merchants.read",
          "merchants.write",
          "transactions.write",
          "transactions.read",
          "webhooks.write",
          "dict.write",
          "cob.write",
          "cob.read",
          "terminals.write"
        ]
      },
      "application": {
        "id": "2fdd5217-cb57-4ee3-a997-655fb5d0ea45",
        "partner": "650c7360-98d9-45d3-a1e0-eb24db30d22e",
        "name": "Torquefy",
        "description": "Aplicacao Torquefy",
        "briefing": "Pix é com a nuvende!",
        "category": "Categoria 1",
        "scopes": [
          "cob.read",
          "cob.write"
        ],
        "status": "pending",
        "created_at": "2025-07-07T14:25:57-03:00",
        "updated_at": "2025-07-07T14:25:57-03:00"
      },
      "status": "pending",
      "scopes": [
        "cob.read",
        "cob.write"
      ],
      "origin": "partner",
      "name": "Ana Parceira Exemplo",
      "document": "52998224725",
      "email": "[email protected]",
      "phone": "11999990001",
      "webhook_url": "https://webhook.site/xxxxxxx",
      "decision_at": null,
      "user_id": null,
      "account_id": null,
      "metadata": [
        "TESTE 1",
        "teste 2"
      ],
      "created_at": "2025-07-07T14:27:14-03:00",
      "updated_at": "2025-07-07T14:27:14-03:00"
    }
  ],
  "links": {
    "first": "https://dominio-ambiente.com.br/api/v1/partners/requests?page=1",
    "last": "https://dominio-ambiente.com.br/api/v1/partners/requests?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Anterior",
        "active": false
      },
      {
        "url": "https://dominio-ambiente.com.br/api/v1/partners/requests?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Próximo »",
        "active": false
      }
    ],
    "path": "https://dominio-ambiente.com.br/api/v1/partners/requests",
    "per_page": 10,
    "to": 1,
    "total": 1
  }
}