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.

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
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json