Listar Checkouts de pagamento

Esta seção explica como listar todos os checkouts de uma conta específica.

Visão Geral

O endpoint de listagem retorna todos os checkouts criados para uma conta, permitindo que você:

• Visualize o histórico de checkouts
• Acompanhe valores e descrições
• Verifique datas de criação e atualização

Endpoint

GET /account/{account_id}/checkouts/list

Retorna a lista de todos os checkouts de uma conta.

URL Completa:

https://app.finexis.com.br/api/v1/gateway/account/{account_id}/checkouts/list

Headers:

Authorization: Bearer {token}

Parâmetros da URL:

• account_id (obrigatório): ID da conta

Exemplo de Requisição:

curl -X GET \
  'https://app.finexis.com.br/api/v1/gateway/account/5/checkouts/list' \
  -H 'Authorization: Bearer {seu_token}'

Resposta de Sucesso (200):

{
  "status": "success",
  "message": "Account checkouts retrieved successfully",
  "data": [
    {
      "id": 17,
      "account_id": 25,
      "uuid": "1436ae21-49a6-45dc-9d93-4d5a8cafd3df",
      "amount": "0.25",
      "description": "Teste com checkout de pagamentos Crypto",
      "created_at": "2025-12-03 00:10:33",
      "updated_at": "2025-12-03 00:10:33",
      "callback": "https://mydomain.com/callback/success-page",
      "url": "https://app.finexis.com.br/pay/1436ae21-49a6-45dc-9d93-4d5a8cafd3df"
    },
  ]
}

Estrutura da Resposta

A resposta é um array de objetos, onde cada objeto representa uma cobrança com os seguintes campos:

Campo	Tipo	Descrição
id	integer	ID único da cobrança
account_id	integer	ID da conta
provider_id	integer	ID do provedor PIX
amount	string	Valor da cobrança (alta precisão)
description	string/null	Descrição da cobrança
url	string	URL do checkout de pagamento
created_at	string	Data de criação
updated_at	string	Data da última atualização

Casos de Uso

Este endpoint é útil para:

• Dashboard: Exibir lista de checouts em uma interface administrativa
• Relatórios: Gerar relatórios de checkouts criadas
• Histórico: Manter um histórico de todos os checkouts

Filtrando e Ordenando

Nota

Atualmente, o endpoint retorna todos os checkouts. Para filtrar por status ou data, você pode processar os resultados no lado do cliente.

Próximos Passos

• Criar Checkout