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
v5
v1
(2013-03-01)
v2
(2017-07-17)
v3
(2017-08-28)
v4-Eng
(2019-09-01)
v4
(2019-09-01)
v5
stable
Home
Guides
Recipes
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
Bem-vindo ao Pagar.me!
Quickstart Pagar.me
Chaves de acesso
Segurança na Integração
IP Whitelist
Gestão de Clientes
Carteira de clientes
Wallets
Card Updater
Pagamentos
Pedido
Cobrança
Multimeios
Multicompradores
Pedidos abertos
Meios de pagamento
Cartão de crédito
Cartão de débito
Voucher
Cartão private label
Boleto Bancário
Transferência bancária
SafetyPay
Checkout
Cash
Pix
Mais funcionalidades
Cancelamento Garantido
Retentativa
Idempotência
Avisos
tokenizecard.js
Tokenizecard.js
Checkout
Checkout
Envio de Checkout
Recorrências
Overview Recorrência
Assinaturas
Planos
Esquemas de precificação dos itens
Faturas
Marketplace
Overview Marketplace
Split
Recebedores
Simuladores
O que é um simulador?
Simulador de Cartão de Crédito
Simulador de Cartão de Débito
Simulador de Voucher
Simulador de Boleto Bancário
Simulador de PIX
Simulador PSP
Webhooks
O que são?
SDKs
Bibliotecas
Integrações Pagar.me
Plataformas Overview
Magento 2
Instalando o módulo
Configurando o módulo
Configurando a Dashboard
Testando a integração
Shopify
Instalando o aplicativo
Nuvemshop
Instalando o aplicativo
Conhecendo o Pagar.me
Bem-vindo ao Pagar.me!
Quickstart Pagar.me
Chaves de acesso
Segurança na Integração
IP Whitelist
Gestão de Clientes
Carteira de clientes
Wallets
Card Updater
Pagamentos
Pedido
Cobrança
Multimeios
Multicompradores
Pedidos abertos
Meios de pagamento
Cartão de crédito
Cartão de débito
Voucher
Cartão private label
Boleto Bancário
Transferência bancária
SafetyPay
Checkout
Cash
Pix
Mais funcionalidades
Cancelamento Garantido
Retentativa
Idempotência
Avisos
tokenizecard.js
Tokenizecard.js
Checkout
Checkout
Envio de Checkout
Recorrências
Overview Recorrência
Assinaturas
Planos
Esquemas de precificação dos itens
Faturas
Marketplace
Overview Marketplace
Split
Recebedores
Simuladores
O que é um simulador?
Simulador de Cartão de Crédito
Simulador de Cartão de Débito
Simulador de Voucher
Simulador de Boleto Bancário
Simulador de PIX
Simulador PSP
Webhooks
O que são?
SDKs
Bibliotecas
Integrações Pagar.me
Plataformas Overview
Magento 2
Instalando o módulo
Configurando o módulo
Configurando a Dashboard
Testando a integração
Shopify
Instalando o aplicativo
Nuvemshop
Instalando o aplicativo
Pagar.me API
Introdução
Segurança
Autenticação
Erros
Paginação
Metadata
Telefones
Entregas
Facilitadores de pagamento (Dados de Subadquirente)
Carteira de clientes
Clientes
post
Criar cliente
get
Obter cliente
put
Editar cliente
get
Listar clientes
Cartões
post
Criar cartão
get
Obter cartão
put
Editar cartão
delete
Excluir cartão
post
Renovar cartão
post
Criar Token Cartão
Endereços
post
Criar endereço
get
Obter endereço
put
Editar endereço
get
Listar endereços
delete
Excluir endereço
BIN
get
Obter informações do BIN
Pagamentos
Visão Geral sobre Pagamento
Cartão de crédito
Cartão de débito
Cartão private label
Voucher
Boleto
Transferência bancária
SafetyPay
Cash
Checkout
Pix
Pedidos
post
Criar pedido
post
Incluir cobrança no pedido
post
Criar pedido multimeios
post
Criar pedido multicompradores
get
Obter pedido
patch
Fechar um pedido
get
Listar pedidos
post
Criar pedido com meio de pagamento Checkout
post
Criar pedido com meio de pagamento Checkout multimeios
Item do pedido
post
Incluir item
put
Editar item do pedido
delete
Deletar item
delete
Remover todos os itens
get
Obter item do pedido
Cobranças
post
Capturar cobrança
get
Obter cobrança
patch
Editar cartão de cobrança
patch
Editar data de vencimento da cobrança
patch
Editar método de pagamento
delete
Cancelar cobrança
get
Listar cobranças
post
Retentar uma cobrança manualmente
post
Confirmar cobrança (cash)
Antifraude
Visão Geral sobre Antifraude
post
Criar pedido (com Antifraude)
Checkout
Checkout Pagar.Me
Envio de Checkout
Recorrência
Visão Geral da Recorrência
Precificação
Unidade
Pacote
Volume
Faixa
Planos
post
Criar plano
get
Obter plano
patch
Editar metadados do plano
put
Editar plano
delete
Excluir plano
get
Listar planos
Assinaturas
post
Criar assinatura avulsa
post
Criar assinatura de plano
get
Obter assinatura
patch
Editar cartão da assinatura
patch
Editar data de faturamento da assinatura
patch
Editar metadados da assinatura
patch
Editar afiliação da assinatura no gateway
delete
Cancelar assinatura
get
Listar assinaturas
patch
Editar data de início da assinatura
post
Ativar faturamento manual
delete
Desativar faturamento manual
patch
Editar meio de pagamento da assinatura
Item da assinatura
post
Incluir item
get
Listar itens de uma assinatura
put
Editar item
delete
Remover item
Uso de um item da assinatura
post
Incluir uso
delete
Remover uso
get
Listar uso
Item do plano
post
Incluir item
put
Editar item
delete
Remover item
Desconto
post
Incluir desconto
get
Obter desconto
get
Listar descontos
delete
Remover desconto
Incremento
post
Incluir incremento
get
Obter incremento
get
Listar incrementos
delete
Remover incremento
Faturas
post
Criar fatura
get
Obter fatura
get
Listar faturas
patch
Editar metadados da fatura
delete
Cancelar fatura
Ciclos
post
Renovar ciclo
get
Obter ciclo
get
Listar ciclos
Recebedores
Recebedores
post
Criar recebedor
put
Editar recebedor
get
Obter recebedor
get
Listar recebedores
Conta bancária
patch
Atualizar conta bancária do recebedor
Saldo
get
Obter saldo
Saque
post
Cria saque
get
Obter saque
get
Listar saques
Informações de transferência
patch
Atualizar informações de transferência
Informações de antecipação automática
patch
Atualizar informações de antecipação automática
Marketplace
Visão Geral do Marketplace
Split
post
Criar pedido com split
post
Capturar cobrança com split
delete
Cancelar cobrança com split
Tokenizacard 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
post
Enviar webhook
get
Obter webhook
get
Listar webhooks