Pagar.me
Guides
Suporte
API Reference
Bem-vindo à documentação Pagar.me
Aqui você vai encontrar guias e exemplos para te ajudar
a integrar com a melhor API de Pagamentos do Brasil!
Começar
Você também pode buscar ou navegar pelas categorias
v4
v1
(2013-03-01)
v2
(2017-07-17)
v3
(2017-08-28)
v4-Eng
(2019-09-01)
v4
beta
stable
(2019-09-01)
Home
Guides
Tutorials
API Reference
Reference
Novidades Pagar.Me
Suporte Pagar.Me
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Conhecendo o Pagar.me
Overview
Quickstart Pagar.me
Dashboard
Índice de conversão
Índice de chargeback
Chaves de acesso
Versionamento
Bibliotecas
Transação
Overview
Obtendo os dados do Cartão
Cartão de crédito
Boleto bancário
Score Pagar.me
Usando Metadata
Autorização e captura
Estorno
Chave de referência
Integração via Checkout Pagar.me
Overview
Inserindo o Checkout Pagar.me
Configurações do Checkout
Link de Pagamento
Overview
Criando um Link de Pagamento
Consultando links de pagamento criados
Personalizando o logo e a cor do link de pagamento
Marketplace
Overview
Dados bancários
Recebedores
Dividindo uma transação
Recorrência
Overview
Planos
Assinaturas
Conceitos de recorrência
Fluxos de cobrança
Gerenciamento de saldo
Overview
Saque
Recebíveis
Operações de saldo
Extrato
Antecipação
Overview
Criação
Consulta
Cancelamento
Recebendo Notificações (Postbacks)
Overview
Gerenciando postbacks
Integração com maquininha
Overview
iOS
Android
.NET
Tabela de Erros
Integração com Plataformas
Overview
Integração com Xtech
Instalando o módulo Pagar.me na Xtech
Configurando o módulo Pagar.me na Xtech
Fluxo de Migração de Cartões
Fluxo de Migração de Cartões
Inserindo regras de segurança
Inserindo regras de segurança
Deletando Regras de Segurança
Referência completa da API
Referência completa da API
Conhecendo o Pagar.me
Overview
Quickstart Pagar.me
Dashboard
Índice de conversão
Índice de chargeback
Chaves de acesso
Versionamento
Bibliotecas
Transação
Overview
Obtendo os dados do Cartão
Cartão de crédito
Boleto bancário
Score Pagar.me
Usando Metadata
Autorização e captura
Estorno
Chave de referência
Integração via Checkout Pagar.me
Overview
Inserindo o Checkout Pagar.me
Configurações do Checkout
Link de Pagamento
Overview
Criando um Link de Pagamento
Consultando links de pagamento criados
Personalizando o logo e a cor do link de pagamento
Marketplace
Overview
Dados bancários
Recebedores
Dividindo uma transação
Recorrência
Overview
Planos
Assinaturas
Conceitos de recorrência
Fluxos de cobrança
Gerenciamento de saldo
Overview
Saque
Recebíveis
Operações de saldo
Extrato
Antecipação
Overview
Criação
Consulta
Cancelamento
Recebendo Notificações (Postbacks)
Overview
Gerenciando postbacks
Integração com maquininha
Overview
iOS
Android
.NET
Tabela de Erros
Integração com Plataformas
Overview
Integração com Xtech
Instalando o módulo Pagar.me na Xtech
Configurando o módulo Pagar.me na Xtech
Fluxo de Migração de Cartões
Fluxo de Migração de Cartões
Inserindo regras de segurança
Inserindo regras de segurança
Deletando Regras de Segurança
Referência completa da API
Referência completa da API
Introdução
Princípios básicos
Ambientes de teste e produção
Códigos de resposta
Erros
Transactions
post
Criando uma transação
Objeto transaction (transação)
Objeto billing (dados de cobrança)
Objeto shipping (dados de envio)
Objeto items (itens)
Objeto address (endereço)
Objeto documents (documentos)
Status das transações
post
Capturando uma transação posteriormente
post
Estorno de transação
post
Estorno Parcial de uma transação
post
Estorno parcial com split
get
Retornando transações
get
Retornando uma transação
get
Retornando recebíveis de uma transação
get
Retornando um recebível da transação
get
Retornando histórico de uma transação
Tipos de operações
post
Notificando cliente sobre boleto a ser pago
get
Retornando eventos de uma transação
get
Calculando Pagamentos Parcelados
put
Atualizando uma transação de teste
get
Gerando uma nova chave para encriptação do card_hash
Gerando card_hash manualmente
Estornos
get
Retornando estornos
Objeto de resposta
post
Cancelando estorno de boleto
Cartões
post
Criando um cartão
Objeto cartão
Cobrança de R$1,23
get
Retornando cartões
get
Retornando um cartão salvo
Planos
post
Criando Planos
Objeto Plano
get
Retornando planos
get
Retornando um plano
put
Atualizando um plano
Assinaturas
post
Criando assinaturas
Objeto Assinatura
post
Split com assinatura
get
Retornando uma assinatura
get
Retornando assinaturas
put
Atualizando uma assinatura
post
Cancelando uma assinatura
get
Transações de assinatura
post
Pulando cobranças
Postback
Objeto-resposta Postback
post
Reenvio de postback
get
Lista de postbacks
get
Retornando um postback
Validando um postback
Formato do payload de um postback
Saldo
Objeto Saldo
get
Saldo do recebedor principal
Operações de saldo
Objeto-resposta Balance operation
Status das operações de saldo
get
Histórico das operações
get
Histórico específico de uma operação
Recebível
Objeto-resposta Recebível
Status dos recebíveis (payables)
get
Retornando recebíveis
get
Retornando um recebível
Transferências
post
Criando uma transferência
Objeto Transferência
get
Retornando transferências
get
Retornando uma transferência
post
Cancelando uma transferência
Antecipações
post
Criando uma antecipação
Objeto antecipação
get
Obtendo os limites de antecipação
post
Confirmando uma antecipação building
post
Cancelando uma antecipação pending
delete
Deletando uma antecipação building
get
Retornando antecipações
Contas Bancárias
post
Criando uma conta bancária
Objeto conta bancária
get
Retornando uma conta bancária
get
Retornando contas bancárias
Recebedores
post
Criando um recebedor
Objeto recebedor
get
Retornando recebedores
get
Retornando um recebedor
put
Atualizando um recebedor
get
Saldo de um recebedor
get
Operações de saldo de um recebedor
get
Operação de saldo específica de um recebedor
Customer
post
Criando um customer
Objeto customer
get
Retornando um customer
get
Retornando mais de um customer
put
Atualizando um customer
Análise antifraude
get
Retornando análises antifraude
get
Retornando uma análise antifraude
Análise manual pelo antifraude
Códigos postais
get
Consulta de CEP
Buscas avançadas
get
ElasticSearch
Regras de split
get
Retornando uma regra de divisão específica
get
Retornando as regras de divisão de uma transação
Chargebacks
get
Retornando chargebacks
Objeto de Resposta
Links de Pagamento
post
Criando um Link de Pagamento
Objeto de Link de Pagamento (PaymentLink)
Objeto de Configuração de Pagamento (PaymentConfig)
Objeto de Configuração de Pagamento - Boleto
Objeto de Configuração de Pagamento - Cartão de Crédito
Objeto de Configuração de Postback
get
Retornando Links de Pagamento
get
Retornando um Link de Pagamento
post
Cancelando um Link de Pagamento
get
Retornando um objeto Order
Regras de segurança
post
Criando novas regras de segurança
get
Retornando regras de segurança
delete
Deletando uma regra de segurança
Configurações da conta
get
Configurações da conta
Integrando Maquininha
SDK iOS
SDK Android
SDK .Net