❗️
Atenção: Essa versão de API será descontinuada
Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.
No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.
Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.
Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para relacionamento@pagar.me e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

📘
O BCB pede que os comandos contidos nos artigos 13 da resolução 264 estejam implementados até o dia ~~6 de novembro de 2023~~ 01 de abril de 2024, adiamento conforme a resolução 349.

De acordo com a Resolução 264/349, Artigo 13, do Banco Central, a partir de 1 de abril de 2024, torna-se necessário fornecer uma interface eletrônica aos proprietários dos recebíveis, neste caso, os recebedores. Essa interface deverá conter informações sobre agenda, contratos e a possibilidade de contestação de contrato. Abaixo iremos detalhar.

Abaixo uma ilustração de como essas informações se convergem

Como consumir os dados via API

Valor Bruto

Valor bruto total das transações que compõem cada unidade de recebível da agenda.

[V1]Retornando URs de um Recebedor

[V2] Retornando URs de um Recebedor

[V3] Retornando URs de um Recebedor

[V4] Retornando URs de um Recebedor

[V5] Retornando URs de um Recebedor

Deduções

Deduções aplicáveis a cada unidade de recebível, discriminadas nas categorias abaixo, conforme o caso:
(i) Taxas administrativas ou de remuneração, cobradas pela instituição credenciadora ou pelo subcredenciador, que incidam sobre o valor das transações que compõem essa unidade;
(ii) Estornos decorrentes de cancelamentos, contestações ou fraudes, no âmbito do arranjo de pagamento, de transações que compõem essa unidade;
(iii) Liquidações de valores de recebíveis constituídos associados à unidade de recebíveis, inclusive decorrentes de antecipações pós-contratadas; e
(iv) Valores bloqueados nos termos do art. 8º da Resolução.

[V1]Retornando Dados de Contrato

[V2]Retornando URs de um Recebedor

[V3]Retornando URs de um Recebedor

[V4] Retornando URs de um Recebedor

[V5]Retornando URs de um Recebedor

Recebíveis Constituídos

Valor de recebíveis constituídos de cada unidade de recebível da agenda, discriminados em valor livre e valores alocados para cada efeito de contrato sobre a unidade.

[V1]Retornando Dados de Contrato

[V2]Retornando Dados de Contrato

[V3]Retornando Dados de Contrato

[V4]Retornando Dados de Contrato

[V5] Retornando Dados de Contrato

Especificações dos Contratos

As especificações dos contratos com efeitos sobre a agenda, no que tange a identificação da contraparte, unidades de recebíveis alcançadas, natureza do contrato e tipo e valor do efeito (percentual ou valor fixo).

[V1]Retornando Dados de Contrato

[V2]Retornando Dados de Contrato

[V3]Retornando Dados de Contrato

[V4]Retornando Dados de Contrato

[V5] Retornando Dados de Contrato

Contestação de Contrato

Disponibilização de ferramenta que permita a realização, pelo usuário final recebedor, de contestações de efeitos de contratos sobre suas agendas de recebíveis registradas de responsabilidade da instituição credenciadora, a serem direcionadas aos sistemas de registro.

[V1]Criando uma Contestação

[V2]Criando uma Contestação

[V3]Criando uma Contestação

[V4]Criando uma Contestação

[V5] Criando uma Contestação

FAQ

Por que devo fornecer essas informações aos meus recebedores?

Compreendemos que, na prática, seus recebedores muitas vezes não estão familiarizados com a Pagar.me. Por isso, pensando em garantir a melhor experiência para eles, é fundamental que vocês atuem como intermediários, fornecendo as informações obrigatórias de acordo com as normas para os recebedores.

Onde devo exibir essas informações?

A norma não especifica um local exato, como acontece no caso do PIX. Portanto, a decisão sobre onde exibir essas informações, em qual tela e formato fica a seu critério. A única exigência é que as informações estejam acessíveis caso o cliente solicite.

Preciso disponibilizar isso para todos os meus recebedores?

Se considerarem mais apropriado para o seu negócio, vocês podem executar esse processo sob demanda, liberando as informações mediante solicitação do recebedor. O aspecto crítico a ser garantido é que, quando o recebedor solicitar essas informações, todas elas sejam prontamente disponibilizadas dentro do prazo razoável acordado com eles.

Como será a autenticação dos endpoints?

Sempre que a sua aplicação chama algum de nossos endpoints, você deve passar como forma de autenticação a sua API Key, chave que pode ser encontrada na sua Dashboard. Saiba mais aqui

Utilizo uma aplicação terceira, como um Seller Center. Devo me preocupar?

Se estiver utilizando um terceiro como interface (como um Seller Center) não tem problema. Você deve solicitar que este terceiro se responsabilize pelas implementações necessárias. No entanto, nesses casos, é importante ressaltar que contamos com vocês para garantir que essas implementações sejam cumpridas corretamente por eles.

É possível obter um relatório com esses dados?

Por enquanto, os dados serão fornecidos pelo Pagar.me exclusivamente por meio da API.

Como um recebedor pode contestar um contrato?

Para contestar um contrato, o recebedor precisará entrar em contato com você ou através da sua interface para solicitar a contestação.

E se meu recebedor opera em outro marketplace no pagar.me?

Para os recebedores que têm documentos exclusivamente vinculados à sua company, iremos disponibilizar as informações de Agenda e Contratos normalmente via API.

No entanto, é importante destacar que o seu recebedor não terá visibilidade dos dados de outros marketplaces em sua interface. Isso significa que eles terão acesso às informações relacionadas apenas à sua própria company.

Para os casos em que os recebedores possuem documentos vinculados a mais de uma company (marketplace), nossa API retornará apenas a visualização das Agendas (URs) dentro do seu marketplace, e não retornará nenhum dado nas rotas de Contrato. Essa medida visa garantir a confidencialidade das informações, uma vez que, atualmente, não é possível operacionalmente segmentar as agendas por marketplace. Dessa forma, cada recebedor terá acesso apenas aos dados relevantes à sua operação, preservando a privacidade das demais companies.

O que é uma UR

Uma Unidade de Recebíveis (UR) é um ativo financeiro criado a partir do registro em uma Entidade Registradora, no caso da Pagar.me, a TAG. Ela é composta por todas as transações de Arranjo de Pagamentos que possuem, em comum, o mesmo : Titular/Credor original da transação (sua empresa ou seu recebedor), Credenciador(Stone) ou Subcredenciador(Pagar.me), Arranjo de Pagamentos(Ex. Visa Crédito, Master Débito, Etc.) e a Data de Liquidação. Para saber mais, acesse aqui.

O que é uma Agenda de Recebíveis

Uma Agenda de Recebíveis é o somatório de todas as URs. Para saber mais, acesse aqui.

O que são Contratos?

Contratos representam acordos bilaterais entre o titular da UR, como a sua empresa ou seu recebedor, e um Credor, que é a empresa/instituição financeira que adquire em definitivo ou em garantia os recebíveis por meio de um contrato, que será averbado no sistema de registro para produzir seus efeitos sobre uma ou mais URs (alteração de titularidade ou constituição de garantia). Para saber mais, acesse aqui.