Buscar Pagamentos

​

📌 Endpoint

​

🔐 Autenticação

• Rota privada.
• Requer header Authorization com sua API key e plano ativo.

{
	"Authorization": "SUA_API_KEY_AQUI"
}

​

🧾 Parâmetros de rota

​

✅ Exemplo de requisição

curl -X GET "https://api.cabrapi.com.br/stores/STORE_ID/payments?page=1&limit=20" \
	-H "Authorization: SUA_API_KEY_AQUI"

​

🔎 Query params

​

🔄 Paginação por cursor

1. Faça a primeira chamada sem cursor.
2. Se hasMore for true, a resposta traz o campo nextCursor.
3. Envie esse nextCursor no parâmetro cursor da próxima requisição para buscar a página seguinte.

curl -X GET "https://api.cabrapi.com.br/stores/STORE_ID/payments?cursor=v1:SEU_CURSOR_AQUI&limit=20" \
	-H "Authorization: SUA_API_KEY_AQUI"

{
	"status": true,
	"code": "PAYMENTS_RETRIEVED",
	"payments": [ /* ... */ ],
	"pagination": {
		"nextCursor": "v1:e2xFn...",
		"hasMore": true,
		"limit": 20
	}
}

• cursor e page não podem ser usados juntos (400 INVALID_PAGINATION).
• nextCursor: null com hasMore: false indicam o fim da lista (a API responde 200 com array vazio).

​

Snippet padrao (cURL)

​

📦 Resposta de sucesso (200)

{
	"status": true,
	"code": "PAYMENTS_RETRIEVED",
	"payments": [
		{
			"id": "PAYMENT_ID",
			"uuid": "8cf7de6e-4c92-4baf-b978-2f9195f2e0e2",
			"status": "APPROVED",
			"shipment": "PENDING",
			"price": "49.9",
			"storeId": "STORE_ID"
		}
	],
	"pagination": {
		"page": 1,
		"limit": 20,
		"total": 1,
		"totalPages": 1,
		"nextCursor": null,
		"hasMore": false
	}
}

A primeira chamada (sem cursor) já retorna nextCursor e hasMore na paginação, permitindo iniciar a paginação por cursor sem chamadas extras.

​

⚠️ Possíveis erros

• 400 INVALID_DATA → parâmetros inválidos
• 400 INVALID_PAGINATION_LIMIT → limit fora do intervalo permitido (1 a 100)
• 400 INVALID_PAGINATION_PAGE → page inválida
• 400 INVALID_PAGINATION_CURSOR → cursor inválido ou malformado
• 400 INVALID_PAGINATION → page e cursor utilizados juntos
• 404 STORE_NOT_FOUND → loja não encontrada
• 500 INTERNAL_SERVER_ERROR → erro interno