> ## 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
> Retorna os detalhes completos de uma cobrança específica pelo seu código. Os dados são cacheados para melhor performance.
Requer o header `account` com o código da conta.
## OpenAPI
````yaml GET /v1/charge/{code}
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: 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
paths:
/v1/charge/{code}:
get:
tags:
- Cobranças
summary: Consultar cobrança
description: >
Retorna os detalhes completos de uma cobrança específica pelo seu
código. Os dados são cacheados para melhor performance.
operationId: getCharge
parameters:
- $ref: '#/components/parameters/AccountHeader'
- name: code
in: path
required: true
description: Código único da cobrança
schema:
type: string
example: chg_abc123
responses:
'200':
description: Dados da cobrança retornados com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/ChargeConsultResponse'
example:
mensagem: Charge found
erro: false
mensagenserro: []
codigoretorno: 200
id: 00000000-0000-0000-0000-000000000000
data:
charge_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
charge_created_at: 11/03/2026 10:00:00
account_id: 1
code: pur_abc123xyz
value: 199.8
charge_value: 199.8
coin: BRL
status: Approved
client:
code: cli_abc123
name: João Silva
email: joao@exemplo.com.br
documents:
- type: CPF
number: 123.456.789-09
default: true
phone:
- ddi: '55'
ddd: '11'
number: '999999999'
default: true
addresss:
- zipcode: 01310-100
street: Avenida Paulista
number: '1000'
neighborhood: Bela Vista
city: São Paulo
state: SP
orders:
- code: ord_abc123xyz
status: Approved
value: 199.8
error_message: null
items:
- code: produto_001
name: Camiseta Premium
unitary_value: 99.9
quantity: 2
charges:
- code: chg_abc123
status: Approved
value: 199.8
canceled_amount: 0
nsu: '123456789'
installments: 1
attempts: 1
payment:
code: null
copy_paste: null
expiration: null
payment_type: CreditCard
installments: 1
last_transaction:
transaction_id: txn_abc123
type: Authorization
status_code: '00'
nsu: '123456789'
event_date: '2026-03-11T10:00:00.000000Z'
message_acquisition: Transação autorizada
historics: []
card:
id: card_abc123
name: JOAO SILVA
type: credit
number: 411111****1111
flag: visa
confirmation_codes: []
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
ChargeConsultResponse:
type: object
description: >-
Resposta da consulta de cobrança (envelope APIReturnUtil + dados
ConsultCharge)
properties:
mensagem:
type: string
example: Charge found
erro:
type: boolean
example: false
mensagenserro:
type: array
items:
type: string
example: []
codigoretorno:
type: integer
example: 200
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
$ref: '#/components/schemas/ChargeConsultData'
ChargeConsultData:
type: object
description: Dados completos de uma cobrança retornados pelo ConsultCharge
properties:
charge_id:
type: string
format: uuid
description: ID interno da cobrança
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
charge_created_at:
type: string
description: Data de criação da cobrança (formatada)
example: 11/03/2026 10:00:00
account_id:
type: integer
description: ID interno da conta
example: 1
code:
type: string
description: Código da compra (purchase code)
example: pur_abc123xyz
value:
type: number
format: float
description: Valor total da compra
example: 199.8
charge_value:
type: number
format: float
description: Valor da cobrança
example: 199.8
coin:
type: string
description: Moeda da transação
example: BRL
status:
type: string
description: Status da compra
enum:
- Pending
- Challenged
- Approved
- Declined
- Refunded
- Canceled
example: Approved
client:
$ref: '#/components/schemas/ChargeClientData'
orders:
type: array
items:
$ref: '#/components/schemas/ChargeOrderData'
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
ChargeClientData:
type: object
description: Dados do cliente associado à cobrança
properties:
code:
type: string
description: Código do cliente
example: cli_abc123
name:
type: string
description: Nome do cliente
example: João Silva
email:
type: string
format: email
description: E-mail do cliente
example: joao@exemplo.com.br
documents:
type: array
description: Documentos do cliente (filtrado pelo documento padrão)
items:
type: object
properties:
type:
type: string
example: CPF
number:
type: string
example: 123.456.789-09
default:
type: boolean
example: true
phone:
type: array
description: Telefones do cliente (filtrado pelo telefone padrão)
items:
type: object
properties:
ddi:
type: string
example: '55'
ddd:
type: string
example: '11'
number:
type: string
example: '999999999'
default:
type: boolean
example: true
addresss:
type: array
description: Endereços do cliente (filtrado pelo endereço padrão)
items:
type: object
properties:
zipcode:
type: string
example: 01310-100
street:
type: string
example: Avenida Paulista
number:
type: string
example: '1000'
neighborhood:
type: string
example: Bela Vista
city:
type: string
example: São Paulo
state:
type: string
example: SP
ChargeOrderData:
type: object
description: Dados do pedido associado à cobrança
properties:
code:
type: string
description: Código do pedido
example: ord_abc123xyz
status:
type: string
description: Status do pedido
enum:
- Pending
- Challenged
- Approved
- Declined
- Refunded
- Canceled
example: Approved
value:
type: number
format: float
description: Valor do pedido
example: 199.8
error_message:
type: string
nullable: true
description: Mensagem de erro do gateway (null se não houver)
example: null
items:
type: array
description: Itens do pedido
items:
type: object
properties:
code:
type: string
description: Código do item
example: produto_001
name:
type: string
description: Nome do item
example: Camiseta Premium
unitary_value:
type: number
format: float
description: Valor unitário do item
example: 99.9
quantity:
type: integer
description: Quantidade
example: 2
charges:
type: array
description: Cobranças associadas ao pedido
items:
$ref: '#/components/schemas/ChargeDetailData'
confirmation_codes:
type: array
description: >-
Códigos de confirmação pendentes (para pedidos com status
Challenged)
items:
type: object
properties:
id:
type: string
format: uuid
example: conf_xyz789
type:
type: string
example: OTP
status:
type: string
example: Pending
expires_at:
type: string
format: date-time
example: '2026-03-11T10:15:00.000000Z'
ChargeDetailData:
type: object
description: Dados detalhados de uma cobrança dentro de um pedido
properties:
code:
type: string
description: Código da cobrança
example: chg_abc123
status:
type: string
description: Status da cobrança
enum:
- Pending
- Challenged
- Approved
- Declined
- Refunded
- Canceled
example: Approved
value:
type: number
format: float
description: Valor cobrado
example: 199.8
canceled_amount:
type: number
format: float
nullable: true
description: Valor já estornado
example: 0
nsu:
type: string
nullable: true
description: NSU (Número Sequencial Único) da transação
example: '123456789'
installments:
type: integer
description: Número de parcelas
example: 1
attempts:
type: integer
description: Número de tentativas de cobrança
example: 1
payment:
type: object
description: Dados do pagamento
properties:
code:
type: string
nullable: true
description: Código do pagamento (ex. código PIX)
example: null
copy_paste:
type: string
nullable: true
description: Código copia e cola do PIX
example: null
expiration:
type: string
nullable: true
description: Data/hora de expiração do pagamento
example: null
payment_type:
type: string
description: Tipo de pagamento utilizado
enum:
- CreditCard
- PIX
example: CreditCard
installments:
type: integer
description: Número de parcelas
example: 1
last_transaction:
type: object
nullable: true
description: Dados da última transação no gateway
properties:
transaction_id:
type: string
example: txn_abc123
type:
type: string
example: Authorization
status_code:
type: string
example: '00'
nsu:
type: string
example: '123456789'
tid:
type: string
example: tid_abc123
event_date:
type: string
format: date-time
example: '2026-03-11T10:00:00.000000Z'
order_code:
type: string
example: ord_abc123xyz
message_acquisition:
type: string
example: Transação autorizada
return_code:
type: string
example: '00'
return_message:
type: string
example: Sucesso
amount:
type: number
nullable: true
example: 19980
historics:
type: array
description: Histórico de transações da cobrança
items:
type: object
properties:
transaction_id:
type: string
type:
type: string
status_code:
type: string
nsu:
type: string
tid:
type: string
event_date:
type: string
format: date-time
order_code:
type: string
message_acquisition:
type: string
return_code:
type: string
return_message:
type: string
operation_type:
type: string
amount:
type: number
nullable: true
card:
type: object
nullable: true
description: Dados do cartão utilizado (mascarado)
properties:
id:
type: string
format: uuid
example: card_abc123
name:
type: string
description: Nome no cartão
example: JOAO SILVA
type:
type: string
description: Tipo do cartão
example: credit
number:
type: string
description: Número mascarado do cartão
example: 411111****1111
flag:
type: string
description: Bandeira do cartão
example: visa
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
NotFound:
description: Recurso não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: The charge code does not match any charge
erro: true
mensagenserro: []
codigoretorno: 404
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````