Objeto de resposta da criação de recipient
| Propriedade | Descrição |
|---|---|
| object String | Nome do tipo do objeto criado/modificado. Valor retornado: recipient |
| id String | Identificador do recebedor. |
| bank_account Object | Objeto contendo os dados bancários do recebedor. |
| transfer_enabled Boolean | Se o recebedor está habilitado para receber transferências ou não. |
| last_transfer Datetime | Data da última transferência (ISODate). |
| transfer_interval String | Frequência na qual o recebedor irá ser pago. Valores possíveis: daily, weekly, monthly. |
| transfer_day Integer | Dia no qual o recebedor vai ser pago. Para cada transfer_day, existe uma faixa de pagamento possível.weekly: 1 a 5, onde 1 é segunda-feira e 5 é sexta-feiramonthly: 1 a 31daily: 1OBS: Para monthly=31 e meses com menos de 31 dias, a transferência acontece no primeiro dia útil do mês seguinte. |
| automatic_anticipation_enabled Boolean | Se o recebedor está habilitado para receber automaticamente ou não o valor disponível para antecipação |
| anticipatable_volume_percentage Integer | Porcentagem do valor passível de antecipação para este recebedor. |
| date_created Datetime | Data de criação do recebedor (ISODate) |
| date_updated Datetime | Data de atualização do recebedor |
| postback_url | URL (endpoint) de seu sistema que recebe notificações a cada mudança no status do recebedor. |
| status | Status em que o recebedor se encontra naquele momento. |
| status_reason | Motivo pelo qual o recebedor se encontra no respectivo status. |
| external_id String | Identificador externo do recebedor |
{
"object": "recipient",
"id": "re_cix7pnghi02wm196emgbthh8u",
"transfer_enabled": true,
"last_transfer": null,
"transfer_interval": "weekly",
"transfer_day": 5,
"automatic_anticipation_enabled": true,
"anticipatable_volume_percentage": 85,
"date_created": "2016-12-27T16:11:58.911Z",
"date_updated": "2016-12-27T16:11:58.911Z",
"postback_url": "https://requestb.in/tl0092tl",
"status": "active",
"status_reason": null,
"bank_account": {
"object": "bank_account",
"id": 17345188,
"bank_code": "33",
"agencia": "00000",
"agencia_dv": null,
"conta": "00000",
"conta_dv": "0",
"type": "conta_corrente",
"document_type": "cpf",
"document_number": "35965816804",
"legal_name": "Nome much legal",
"charge_transfer_fees": true,
"date_created": "2016-12-27T16:08:26.202Z"
}
}
Campo register_information
O campo register_information recebe informações cadastrais do seller. Abaixo você pode conferir as especificações do campo para pessoa física e jurídica
Campo register_information para pessoa física
Quando o recebedor é uma pessoa física, deve-se usar o valor individual no campo type.
{
"register_information": {
"type": "individual",
"document_number": "12345678910",
"name": "Someone",
"site_url": "",
"email": "[email protected]",
"mother_name": "Eliana das Neves",
"birthdate": "01/01/0001",
"monthly_income": "1000",
"professional_occupation": "Empresário",
"address": {
"street": null,
"complementary": "SN",
"street_number": null,
"neighborhood": null,
"city": null,
"state": null,
"zipcode": null,
"reference_point": null
},
"phone_numbers": [
{
"ddd": "27",
"number": "999992628",
"type": "primary"
}
]
}
| Nome do parâmetro | Especificação do parâmetro |
|---|---|
| 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 |
| mother_name | Nome da mãe |
| birthday obrigatório | Data de nascimento |
| monthly_income obrigatório | Renda mensal (disponível em Janeiro de 2024) |
| professional_occupation obrigatório | Ocupação profissional (disponível em Janeiro de 2024) |
| address obrigatório | Endereço completo |
| phone_numbers obrigatório | Número de telefone do seller. Deve-se informar o DDD, número e o tipo. |
Campo register_information para pessoa jurídica
Quando o recebedor é uma pessoa jurídica, deve-se usar o valor corporation no campo type.
{
"register_information": {
"type": "corporation",
"document_number": "43633675456",
"company_name": "Full Name Company",
"trading_name": "Full Name Company SA",
"annual_revenue": "1000",
"corporation_type": "",
"founding_date": "",
"cnae": "",
"email": "[email protected]",
"site_url":"http://www.site.com",
"phone_numbers": [{
"ddd": "11",
"number": "11987654321",
"type": "mobile"
}],
"main_address": {
"street": null,
"complementary": "SN",
"street_number": null,
"neighborhood": null,
"city": null,
"state": null,
"zipcode": null,
"reference_point": null
},
"managing_partners": [{
"type": "individual",
"name": "Teste Onboarding",
"document_number": "50107915014",
"mother_name": "Eliana das Neves",
"birthdate": "01/01/0001",
"email": "[email protected]",
"monthly_income": "1000",
"professional_occupation": "Empresário",
"self_declared_legal_representative": true,
"address": {
"street": null,
"complementary": "SN",
"street_number": null,
"neighborhood": null,
"city": null,
"state": null,
"zipcode": null,
"reference_point": null
},
"phone_numbers": [
{
"ddd": "27",
"number": "999992628",
"type": "primary"
}
]
}
| Nome do parâmetro | Especificação do parâmetro |
|---|---|
| type obrigatório | Utilizar "corporation" |
| document_number obrigatório | Número do CNPJ. |
| company_name obrigatório | Nome fantasia do seller. |
| trading_name obrigatório | Razão social |
| annual_revenue obrigatório | Faturamento anual (disponível em Janeiro de 2024) |
| corporation_type | Tipo da empresa |
| founding_date | Data de fundação |
| cnae | Classificação Nacional das Atividades Econômicas |
| email obrigatório | Email do seller |
| site_url obrigatório | Site do seller. |
| phone_numbers obrigatório | Número de telefone do seller. Deve-se informar o DDD, número e o tipo. |
| main_address obrigatório | Endereço completo |
| managing_partners obrigatório | Dados dos sócios listados neste CNPJ/Representante legal, seguir o mesmo padrão do recebedor com type individual. |