> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Consultar cobrança
> Consulta a visão financeira de um pagamento: quanto foi pago, estornado e ainda pode ser estornado. O `id` é o mesmo `id` do pagamento (`payments[].id`) no pedido ou na fatura.
O `id` da cobrança é o mesmo `id` do pagamento (`payment_intent`) dentro do pedido ou da fatura.
Uma cobrança de outra conta retorna `404` (`resource_missing`).
Use `amount_refundable` para saber quanto ainda pode ser estornado antes de chamar o [estorno](/pages/v2/cobrancas/refund).
## OpenAPI
````yaml GET /v2/charges/{id}
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Cartões
description: Cadastro e gerenciamento dos cartões salvos de um cliente
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
- name: Análise de Fraude
description: >-
API de Risco — consulta o risco de fraude de uma transação (autenticada
por chave de API)
- name: Pedidos (v2)
description: >-
API v2 — pedidos com um ou mais meios de pagamento, captura, cancelamento
e verificação por código
- name: Cobranças (v2)
description: API v2 — consulta e estorno de cobranças
- name: Cartões (v2)
description: API v2 — cadastro e consulta de cartões salvos
- name: Assinaturas (v2)
description: API v2 — criação e gerenciamento de assinaturas recorrentes
- name: Faturas (v2)
description: >-
API v2 — consulta, pagamento e verificação por código das faturas de
assinaturas
paths:
/v2/charges/{id}:
get:
tags:
- Cobranças (v2)
summary: Consultar cobrança
description: >
Consulta a visão financeira de um pagamento: quanto foi pago, estornado
e ainda pode ser estornado. O `id` é o mesmo `id` do pagamento
(`payments[].id`) no pedido ou na fatura.
operationId: v2RetrieveCharge
parameters:
- $ref: '#/components/parameters/V2Id'
responses:
'200':
description: Cobrança encontrada
content:
application/json:
schema:
$ref: '#/components/schemas/V2Charge'
example:
id: cha_8Kq2Lm9XvB3nT7pZ
object: charge
amount: 10000
currency: brl
status: paid
paid: true
captured: true
amount_refunded: 0
amount_refundable: 10000
payment_method_details:
type: card
payment_intent: cha_8Kq2Lm9XvB3nT7pZ
'401':
$ref: '#/components/responses/V2Unauthorized'
'403':
$ref: '#/components/responses/V2AccountBlocked'
'404':
$ref: '#/components/responses/V2ChargeNotFound'
'429':
$ref: '#/components/responses/V2ThrottleExceeded'
security:
- secretKeyAuth: []
components:
parameters:
V2Id:
name: id
in: path
required: true
description: Identificador do recurso (o campo `id` devolvido pela API)
schema:
type: string
schemas:
V2Charge:
type: object
description: Visão financeira de um pagamento
properties:
id:
type: string
example: cha_8Kq2Lm9XvB3nT7pZ
object:
type: string
enum:
- charge
amount:
type: integer
description: Valor em centavos
example: 10000
currency:
type: string
example: brl
status:
type: string
enum:
- pending
- paid
- refund_processing
- partially_refunded
- refunded
- chargeback
- failed
description: >
`failed` também cobre cobranças canceladas e expiradas.
`refund_processing`: um estorno foi pedido e aguarda confirmação.
paid:
type: boolean
description: A cobrança foi paga (inclusive se depois foi estornada)
captured:
type: boolean
description: A cobrança foi capturada (mesmo valor de `paid`)
amount_refunded:
type: integer
description: Valor já estornado, em centavos
example: 0
amount_refundable:
type: integer
description: Valor que ainda pode ser estornado, em centavos
example: 10000
payment_method_details:
type: object
properties:
type:
type: string
enum:
- card
- pix
- boleto
payment_intent:
type: string
description: O `id` do pagamento correspondente no pedido ou na fatura
example: cha_8Kq2Lm9XvB3nT7pZ
V2Error:
type: object
description: Envelope de erro da API v2
required:
- error
properties:
error:
type: object
required:
- type
- code
- message
properties:
type:
type: string
enum:
- invalid_request_error
- idempotency_error
- authentication_error
- api_error
description: Categoria do erro
code:
type: string
description: Código estável do erro. Use este campo na sua lógica
example: validation_error
message:
type: string
description: Texto técnico, para log e depuração. Não exiba ao pagador
example: The payments field is required.
param:
type: string
description: >-
Campo que causou o erro, em notação de ponto. Presente só quando
se aplica
example: payments
customer_message:
type: string
description: Texto para exibir ao pagador. Presente só quando se aplica
V2ThrottleError:
type: object
description: >
Corpo padrão, fora do envelope `error`, do limite geral de requisições e
do limite de reenvio do código de verificação
properties:
message:
type: string
example: Too Many Attempts.
responses:
V2Unauthorized:
description: Chave de API ausente, inválida, revogada ou de outro ambiente
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
example:
error:
type: authentication_error
code: invalid_api_secret
message: Invalid API secret.
V2AccountBlocked:
description: >-
As requisições da conta estão bloqueadas. A resposta traz
`customer_message`
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
example:
error:
type: invalid_request_error
code: account_requests_blocked
message: As requisições desta conta estão bloqueadas.
customer_message: >-
Não foi possível concluir sua transação. Tente novamente mais
tarde.
V2ChargeNotFound:
description: Cobrança não encontrada nesta conta
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
example:
error:
type: invalid_request_error
code: resource_missing
message: Recurso "charge" não encontrado.
V2ThrottleExceeded:
description: >
Limite geral de requisições excedido (120 por minuto por chave de API e
por conta). Esta resposta não usa o envelope `error` da API v2.
headers:
X-RateLimit-Limit:
description: Limite de requisições da janela
schema:
type: integer
X-RateLimit-Remaining:
description: Requisições restantes na janela
schema:
type: integer
Retry-After:
description: Segundos até a próxima tentativa
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/V2ThrottleError'
example:
message: Too Many Attempts.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
secretKeyAuth:
type: http
scheme: bearer
description: >
Chave de API (secret key) da conta, no formato `sk_live_...` (produção)
ou `sk_test_...` (Dev mode). Envie no header `Authorization: Bearer
`. Autentica todas as rotas da API v2 e as rotas de Análise de
Fraude. A chave identifica a conta, então a API v2 não usa o header
`account`. Uma chave só é aceita no ambiente em que foi criada. Gere a
sua no dashboard em Configurações → Chaves de API.
````