These docs are for v4. Click to read the latest docs for v5.

Criando um recebedor

Com essa rota você consegue criar um recebedor, definindo o período que ele irá receber os pagamentos e qual a conta bancária que será utilizada para envio dos pagamentos.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

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 [email protected] 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.

❗️

Recebedores inativos

Todos os recebedores que foram criados a mais de 60 dias, não possuem valores a receber e nos últimos 60 dias não transacionaram ou realizaram transferências terão a transferência automática desabilitada. Mesmo que esse recebedor volte a transacionar eventualmente, a transferência automática precisa ser reabilitada manualmente nesses casos.

🚧

Rate Limit

Essa rota possui um limite de requisições.
Caso você ultrapasse esse valor será retornado o erro “StatusCode 429” por nossa API.

Para saber qual o limite dessa e demais rotas acesse : Rate Limit

Body Params
string

Identificador externo do recebedor

string
required

Frequência na qual o recebedor irá ser pago. Valores possíveis: daily, weekly, monthly

string
required

Dia no qual o recebedor vai ser pago. Depende do transfer_interval. Se for daily, não é necessário. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31.

boolean
required

Variável que indica se o recebedor pode receber os pagamentos automaticamente

string
required

Identificador de uma conta bancária previamente criada. Você também pode passar todos parâmetros necessários para criação de uma conta bancária.

string

URL (endpoint) de seu sistema que recebe notificações a cada mudança no status do recebedor.

bank_account
object
string

Porcentagem do valor passível de antecipação para este recebedor.

string

Se o recebedor está habilitado para receber automaticamente ou não o valor disponível para antecipação.

string

Configuração de como devemos criar as antecipações automáticas do recebedor. Valor full para criarmos antecipações seguindo a regra de volume máximo antecipável. Valor 1025, para criarmos antecipações de vendas inteiras, modelos D+X e 10/25.

string

Lista de dias em que devemos criar as antecipações automáticas.

string

Parâmetro de quantos dias, contados do dia da antecipação para trás, devemos desconsiderar na criação desta antecipação.

json
required

Campo usado para receber informações cadastrais de um recebedor. Este recebedor pode ser pessoal física ou pessoa jurídica, onde cada um tem formato especifico.

json

Objeto com dados adicionais do recebedor.

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json