GuidesSuporteAPI Reference

API v5 - Mudanças de contrato na criação de Recebedores

Adição do novo objeto register_information

Para refletir as exigências da Circular 3.978/20, serão implementadas atualizações no contrato de recebedores na API v5.

A mudança principal é a adição do novo objeto register_information que será utilizado para informar os dados cadastrais do recebedor, com isso alguns campos previamente associados a raiz do recebedor passarão a ser enviados dento do register_information, são eles:

  • name
  • email
  • document
  • type

Outro ponto importante da mudança são os campos necessários para o cadastro de recebedores vinculados a pessoas jurídicas e físicas. O tipo do recebedor será indicado no campo register_information.type.

📘

Recebedores já existentes

Não será necessário atualizar a base atual de recebedores com os dados mínimos

🚧

Atenção - Datas de lançamento e descontinuação

O novo contrato será disponibilizado no dia 29 de fevereiro de 2024. Somente será possível criar recebedores com o contrato antigo da v5 até o dia 03 de junho 2024.

A partir do dia 03 de junho 2024, para realizar a atualização de recebedores também será necessário seguir o novo contrato.

Campos para Recebedores Pessoa Jurídica (register_information.type: corporation)

Especificação do objeto register_informationTipoConteúdo
company_namestringNome fantasia do recebedor
Obrigatório
trading_namestringRazão social
Obrigatório
emailstringE-mail do recebedor
Obrigatório
documentstringNúmero do CNPJ
Obrigatório
typestringUtilizar corporation
Obrigatório
site_urlstringSite do recebedor
annual_revenuestringReceita anual
Obrigatório
corporation_typestringTipo da empresa
founding_datestringData de fundação da empresa
main_address.streetstringRua
Obrigatório
main_address.complementarystringComplemento. Não pode ser uma string vazia nem null
Obrigatório
main_address.street_numberstringNúmero
Obrigatório
main_address.neighborhoodstringBairro
Obrigatório
main_address.citystringCidade
Obrigatório
main_address.statestringEstado
Obrigatório
main_address.zip_codestringCEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos
Obrigatório
main_address.reference_pointstringPonto de referência do endereço
Obrigatório
phone_numbers{}.dddstringDDD (Discagem Direta à Distância)
Obrigatório
phone_numbers{}.numberstringNúmero do telefone
Obrigatório
phone_numbers{}.typestringTipo do telefone
Obrigatório
managing_partners{}.namestringNome do representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.emailstringE-mail do representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.documentstringNúmero do CPF do representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.typestringSempre será individual
Obrigatório
managing_partners{}.mother_namestringNome da mãe do representante legal atrelado a empresa cadastrada como recebedor
managing_partners{}.birthdatestringAniversário do representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.monthly_incomestringRenda mensal média ou estimada declarada pelo representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.professional_occupationstringOcupação profissional do representante legal atrelado a empresa cadastrada como recebedor
Obrigatório
managing_partners{}.self_declared_legal_representativebooleanGarantia de que aquele cadastro de pessoal física se identifica como representante legal do CNPJ do recebedor ao qual está atrelado
Obrigatório
managing_partners{}.address.streetstringRua
Obrigatório
managing_partners{}.address.complementarystringComplemento. Não pode ser uma string vazia nem null
Obrigatório
managing_partners{}.address.street_numberstringNúmero
Obrigatório
managing_partners{}.address.neighborhoodstringBairro
Obrigatório
managing_partners{}.address.citystringCidade
Obrigatório
managing_partners{}.address.statestringEstado
Obrigatório
managing_partners{}.address.zip_codestringCEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos
Obrigatório
managing_partners{}.address.reference_pointstringPonto de referência do endereço
Obrigatório
managing_partners{}.phone_numbers{}.dddstringDDD (Discagem Direta à Distância)
Obrigatório
managing_partners{}.phone_numbers{}.numberstringNúmero do telefone
Obrigatório
managing_partners{}.phone_numbers{}.typestringTipo do telefone
Obrigatório
{
    "code": "1234",
    "register_information": {
        "company_name": "Recebedor pessoa juridica",
        "trading_name": "Empresa LTDA",
        "email": "[email protected]",
        "document": "77699131000133",
        "type": "corporation",
        "site_url": "http://www.site.com",
        "annual_revenue": 1000000,
        "corporation_type": "LTDA",
        "founding_date": "2010-10-30",
        "main_address": {
            "street": "Av. General Justo",
            "complementary": "Bloco A",
            "street_number": "375",
            "neighborhood": "Centro",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "zip_code": "20021130",
            "reference_point": "Ao lado da banca de jornal"
        },
        "phone_numbers": [
            {
                "ddd": "21",
                "number": "994647568",
                "type": "mobile"
            }
        ],
        "managing_partners": [
            {
                "name": "Tony Stark",
                "email": "[email protected]",
                "document": "26224451990",
                "type": "individual",
                "mother_name": "Nome da mae",
                "birthdate": "1984-10-30T00:00:00",
                "monthly_income": 120000,
                "professional_occupation": "Vendedor",
                "self_declared_legal_representative": true,
                "address": {
                    "street": "Av. General Justo",
                    "complementary": "Bloco A",
                    "street_number": "375",
                    "neighborhood": "Centro",
                    "city": "Rio de Janeiro",
                    "state": "RJ",
                    "zip_code": "20021130",
                    "reference_point": "Ao lado da banca de jornal"
                },
                "phone_numbers": [
                    {
                        "ddd": "27",
                        "number": "999992628",
                        "type": "mobile"
                    }
                ]
            }
        ]
    },
    "transfer_settings": {
        "transfer_enabled": "false",
        "transfer_interval": "Daily",
        "transfer_day": 0
    },
    "default_bank_account": {
        "holder_name": "Tony Stark",
        "holder_type": "individual",
        "holder_document": "26224451990",
        "bank": "341",
        "branch_number": "1234",
        "branch_check_digit": "6",
        "account_number": "12345",
        "account_check_digit": "6",
        "type": "checking"
    },
    "automatic_anticipation_settings": {
        "enabled": "true",
        "type": "full",
        "volume_percentage": "50",
        "delay": "null"
    }
}

📘

Representantes Legais (Managing Partners)

Só é necessário adicionar um único representante legal (managing_partners) para cada recebedor do tipo Pessoa Juridica.

Para Recebedores Pessoa Física register_information.type: individual

Especificação do objeto register_informationTipoConteúdo
namestringNome do recebedor
Obrigatório
emailstringE-mail do recebedor
Obrigatório
documentstringNúmero do CPF
Obrigatório
typestringUtilizar individual
Obrigatório
site_urlstringSite do recebedor
mother_namestringNome da mãe
birthdatestringAniversário
Obrigatório
monthly_incomestringRenda mensal
Obrigatório
professional_occupationstringOcupação profissional
Obrigatório
address.streetstringRua
address.complementarystringComplemento. Não pode ser uma recebedor vazia nem null
address.street_numberstringNúmero
Obrigatório
address.neighborhoodstringBairro
Obrigatório
address.citystringCidade
Obrigatório
address.statestringEstado
Obrigatório
address.zip_codestringCEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos
Obrigatório
address.reference_pointstringPonto de referência do endereço
Obrigatório
phone_numbers{}.dddstringDDD (Discagem Direta à Distância)
Obrigatório
phone_numbers{}.numberstringNúmero do telefone
Obrigatório
phone_numbers{}.typestringTipo do telefone
Obrigatório
{
    "code": "1234",
    "register_information": {
        "name": "Recebedor Pessoa fisica",
        "email": "[email protected]",
        "document": "26224451990",
        "type": "individual",
        "site_url": "https://sitedorecebedor.com.br",
        "mother_name": "Nome da mae",
        "birthdate": "1984-10-30T00:00:00",
        "monthly_income": 120000,
        "professional_occupation": "Vendedor",
        "address": {
            "street": "Av. General Justo",
            "complementary": "Bloco A",
            "street_number": "375",
            "neighborhood": "Centro",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "zip_code": "20021130",
            "reference_point": "Ao lado da banca de jornal"
        },
        "phone_numbers": [
            {
                "ddd": "21",
                "number": "994647568",
                "type": "mobile"
            }
        ]
    },
    "transfer_settings": {
        "transfer_enabled": "false",
        "transfer_interval": "Daily",
        "transfer_day": 0
    },
    "default_bank_account": {
        "holder_name": "Tony Stark",
        "holder_type": "individual",
        "holder_document": "26224451990",
        "bank": "341",
        "branch_number": "1234",
        "branch_check_digit": "6",
        "account_number": "12345",
        "account_check_digit": "6",
        "type": "checking"
    },
    "automatic_anticipation_settings": {
        "enabled": "true",
        "type": "full",
        "volume_percentage": "50",
        "delay": "null"
    }
}