Um `recipient` é um recebedor — isto é, um vendedor ou empresa que expõe os seus produtos dentro do seu Marketplace. Dentro do ambiente Pagar.me é atribuido um saldo a esse recebedor, de acordo com as transações que tenham sido criadas através da loja. Para isso, você precisa criar o objeto `recipient` pela API.
É através de um `recipient` que você especifica as suas regras de split, para que os valores a receber sejam automaticamente atribuídos a cada um dos sellers envolvidos na transação.
## Criando um recebedor
Vamos aprender a criar um novo recipient, e em seguida entender cada parâmetro passado. Veja este exemplo:
Quando for necessário criar um novo recebedor, podemos criá-lo sem dependências de outros recursos.
É possível, porém, quebrar a criação do recebedor em múltiplas etapas:
Dessa maneira é possível criar um recebedor com uma conta bancária já existente.
## Parâmetros de um recebedor
Veja a tabela a seguir para entender cada parâmetro:
| Campos | Definição |
transfer_enabled
Default: `false` | Essa propriedade define se o recebedor pode receber seus pagamentos automaticamente, no dia e no intervalo que forem definidos. |
transfer_interval
Default: `daily` | Essa propriedade define com qual frequência os valores disponíveis no Pagar.me são transferidos automaticamente para a conta bancária do recebedor. Os valores são: `daily`, `weekly`, `monthly`, que respectivamente significam diário, semanal e mensal. |
transfer_day
Default: `0` | Essa propriedade define em qual dia as transferências automáticas são feitas para o recebedor, dado o transfer_interval escolhido.
Os valores possíveis são:
1 a 5 se transfer_interval for igual a `weekly`
1 a 31 se transfer_interval for igual a `monthly`
0 se transfer_interval for igual `daily` |
anticipatable_volume_percentage
Default: `0` | Essa propriedade define a porcentagem referente ao valor `a receber` que o recebedor pode antecipar junto ao Pagar.me. Por padrão, novos recebedores possuem essa propriedade com valor 0. |
automatic_anticipation_enabled
Default: `false` | Define se o recebedor pode receber antecipações automáticas. |
| bank_account_id **obrigatório** | Essa propriedade deverá conter o id de uma conta bancária previamente criada. Mais em: [Criando uma conta bancária](🔗) |
| postback_url | URL (endpoint) de seu sistema que recebe notificações a cada mudança no status do recebedor. |
| register_information | 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. |
| metadata | Objeto com dados adicionais do recebedor. |
## Observações
Atenção
Quando o parâmetro `
transfer_interval` possui o valor `daily`, não é necessário informar o parâmetro `transfer_day`
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.
Alterando um recebedor
Ao atrelar uma conta bancária a um recebedor, somente será possível trocar a conta se a nova tiver o mesmo número de documento (seja ele CPF ou CNPJ). Caso contrário, essa ação não é possível.
Para aprender como atualizar um recebedor, leia mais em: [Atualizando um recebedor](🔗)
## Campo register_information para pessoa física
O campo register_information recebe informações cadastrais do seller. Este recebedor pode ser pessoa física (utilizar "individual" em "type").
| Column Title | Column Title |
| type **obrigatório** | Utilizar "individual". |
| document_number **obrigatório** | Número do CPF. |
| name **obrigatório** | Nome do seller. |
| site_url | Site do seller. |
| email **obrigatório** | Email do seller |
| phone_numbers | Número de telefone do seller. Deve-se informar o DDD, número e o tipo. |
## Campo register_information para pessoa jurídica
O campo register_information recebe informações cadastrais do seller. Este recebedor pode ser pessoa jurídica (utilizar "corporation" em "type").
| Column Title | Column Title |
| type **obrigatório** | Utilizar "corporation". |
| document_number **obrigatório** | Número do CNPJ. |
| company_name **obrigatório** | Nome fantasia do seller. |
| Email do seller | |
| site_url | Site do seller. |
| phone_numbers | Número de telefone do seller. Deve-se informar o DDD, número e o tipo. |
| managing_partners **obrigatório** | Dados dos sócios listados neste CNPJ. |