Objeto recebedor

Objeto de resposta da criação de recipient

PropriedadeDescriçã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-feira
monthly: 1 a 31
daily: 1

OBS: 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.
automatic_anticipation_type
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.
automatic_anticipation_days
String
Lista de dias em que devemos criar as antecipações automáticas.
automatic_anticipation_1025_delay
Integer
Parâmetro de quantos dias, contados do dia da antecipação para trás, devemos desconsiderar na criação desta antecipação.
date_created
Datetime
Data de criação do recebedor (ISODate)
date_updated
Datetime
Data de atualização do recebedor
postback_url
String
URL (endpoint) de seu sistema que recebe notificações a cada mudança no status do recebedor.
status
String
Status em que o recebedor se encontra naquele momento. Valores possíveis: registration, affiliation, active, refused, suspended, blocked, inactive
status_reason
String
Motivo pelo qual o recebedor se encontra no respectivo status.
metadata
Json
Objeto com dados adicionais do recebedor.
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,
  "metadata": 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"
  }
}

Observações sobre status dos recebedores:

registration: estágio no qual o recebedor já passou pelo pré-credenciamento, e está com o auto credenciamento pendente. Aqui ele pode transacionar, mas não pode sacar o valor.

affiliation: estágio no qual o recebedor já passou pelo auto credenciamento, e está esperando a afiliação por parte do Pagar.me. Ele continua podendo transacionar, mas sem sacar o valor.

active: estágio no qual já passou por todos os estágios do credenciamento, e já pode sacar os valores não bloqueados de sua conta de pagamento.

refused: estágio no qual o recebedor foi recusado no pré-credenciamento ou na afiliação. Neste ponto, avisamos o marketplace, e depois de um período estornamos as vendas feitas.

suspended: estágio no qual o recebedor não se auto credenciou após um período de dias, ou teve pendências no estágio de afiliação. Tem o transacional e saques travados, mas as transações ainda não serão estornadas. Pode voltar para o fluxo de credenciamento/afiliação.

blocked: estágio no qual após ativo, mostrou comportamento suspeito. Tem o transacional e saques travados, mas as transações ainda não serão estornadas. Pode voltar para ativo.

inactive: estágio no qual após ser monitorado, mostrou comportamento suspeito, e comprovamos algo de errado. Quando ele atinge esse estágio, não é possível voltar para ativo.

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": "92545278157",
    "name": "Someone",
    "site_url":"http://www.site.com",
    "email": "[email protected]",
    "phone_numbers": [{
        "ddd": "11",
        "number": "11987654321",
        "type": "mobile"
    }]
}
Nome do parâmetroEspecificação do parâmetro
type
obrigatório
Utilizar "individual".
document_number
obrigatóri
Número do CPF.
name
obrigatório
Nome do seller.
site_urlSite do seller.
email
obrigatório
Email do seller
phone_numbersNú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",
    "email": "[email protected]",
    "site_url":"http://www.site.com",
    "phone_numbers":  [{
        "ddd": "11",
        "number": "11987654321",
        "type": "mobile"
    }],
    "managing_partners": [{
        "type": "individual",
        "document_number": "925452787",
        "email": "[email protected]",
        "name": "Someone"
    }]
Nome do parâmetroEspecificaçã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.
emailEmail do seller
site_urlSite do seller.
phone_numbersNú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.