Jump to Content
Home
Guides
API Reference
v1
v2
v3
v4
v5
Guides
Suporte
API Reference
API Reference
Guides
Suporte
API Reference
V5 (2021-09-01)
API Reference
Obter cobrança
Search
JUMP TO
Pagar.me API
Introdução
Segurança
IP Allowlist
Rate Limit
Autenticação
Erros
Paginação
Metadata
Telefones
Entregas
Facilitadores de pagamento (Dados de Subadquirente)
Carteira de clientes
Clientes
Criar cliente
post
Obter cliente
get
Editar cliente
put
Listar clientes
get
Cartões
Criar cartão
post
Obter cartão
get
Listar cartão
get
Editar cartão
put
Excluir cartão
delete
Renovar cartão
post
Criar Token cartão
post
Endereços
Criar endereço
post
Obter endereço
get
Editar endereço
put
Listar endereços
get
Excluir endereço
delete
BIN
Obter informações do BIN
get
Pagamentos
Visão Geral sobre Pagamento
Cartão de crédito
Pix
Boleto
Voucher
Google Pay™
Cash
SafetyPay
Cartão private label
Cartão de débito
Pedidos
Criar pedido
post
Incluir cobrança no pedido
post
Criar pedido multimeios
post
Criar pedido multicompradores
post
Obter pedido
get
Fechar um pedido
patch
Listar pedidos
get
Item do pedido
Incluir item
post
Editar item do pedido
put
Deletar item
delete
Remover todos os itens
delete
Obter item do pedido
get
Cobranças
Capturar cobrança
post
Obter cobrança
get
Editar cartão de cobrança
patch
Editar data de vencimento da cobrança
patch
Editar método de pagamento
patch
Cancelar cobrança
delete
Listar cobranças
get
Retentar uma cobrança manualmente
post
Confirmar cobrança (cash)
post
Antifraude
Visão Geral sobre Antifraude
Criar pedido (com Antifraude)
post
Link de Pagamento
Link de Pagamento
Checkout Pagar.me
Criar link de pagamento
post
Obter link de pagamento
get
Obter links de pagamento
get
Ativar link de pagamento em construção
patch
Cancelar link de pagamento
patch
Recorrência
Precificação
Unidade
Pacote
Volume
Faixa
Planos
Criar plano
post
Obter plano
get
Editar metadados do plano
patch
Editar plano
put
Excluir plano
delete
Listar planos
get
Assinaturas
Criar assinatura avulsa
post
Criar assinatura de plano
post
Obter assinatura
get
Listar assinaturas
get
Cancelar assinatura
delete
Editar cartão da assinatura
patch
Editar metadados da assinatura
patch
Editar meio de pagamento da assinatura
patch
Editar data de início da assinatura
patch
Editar preço mínimo da assinatura
patch
Ativar faturamento manual
post
Desativar faturamento manual
delete
Item da assinatura
Incluir item
post
Listar itens de uma assinatura
get
Editar item
put
Remover item
delete
Uso de um item da assinatura
Incluir uso
post
Remover uso
delete
Listar uso
get
Item do plano
Incluir item
post
Editar item
put
Remover item
delete
Desconto
Incluir desconto
post
Obter desconto
get
Listar descontos
get
Remover desconto
delete
Incremento
Incluir incremento
post
Obter incremento
get
Listar incrementos
get
Remover incremento
delete
Faturas
Criar fatura
post
Obter fatura
get
Listar faturas
get
Editar metadados da fatura
patch
Cancelar fatura
delete
Ciclos
Renovar ciclo
post
Obter ciclo
get
Listar ciclos
get
Split
Editar regras do Split
patch
Recebedores
Recebedores
Criar recebedor
post
Criar link de de Prova de Vida (KYC)
post
Editar recebedor
put
Obter recebedor
get
Listar recebedores
get
Editar code de recebedor
patch
Conta bancária
Atualizar conta bancária do recebedor
patch
Saldo
Obter saldo
get
Saque
Cria saque
post
Obter saque
get
Listar saques
get
Configurações de transferência
Atualizar configurações de transferência
patch
Configurações de antecipação automática
Atualizar configurações de antecipação automática
patch
financeiro
Recebíveis
Obter recebíveis
get
Obter um recebível
get
Operações de Saldo
Obter histórico das operações
get
Obter histórico específico de uma operação
get
Marketplace
Visão Geral do Marketplace
Split
Criar pedido com split
post
Capturar cobrança com split
post
Cancelar cobrança com split
delete
Res.264/349: Interface Eletrônica para Sellers
Retornando URs de um Recebedor
get
Retornando Efeitos de Contratos
get
Retornando Contratos
get
Retornando Contestações
get
Contestando um Contrato
post
Tokenizecard JS
Tokenizecard JS
Alternativas ao Tokenizecard JS
Tokenização
Criar Token Cartão
Criar Checkout
Webhook
Visão geral sobre Webhooks
Exemplo de webhook
Eventos de webhook
Enviar webhook
post
Obter webhook
get
Listar webhooks
get
Pagar.me API - Register V5
Getting Started With Your API
Obter cobrança
get
https://api.pagar.me/core/v5/charges/
{charge_id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
base64
Basic
:
RESPONSE
Click
Try It!
to start a request and see the response here!
Transaction IDs
