Criação da Carteira

Request

ENDPOINT

/postpaid/wallet

MÉTODO

POST

Request Body

{
    "owner": {
        "person_type": "natural",
        "name": "\<NOME TITULAR DA CARTEIRA\>",
        "document_number": "\<CPF TITULAR DA CARTEIRA\>",
        "email": "\<EMAIL TITULAR DA CARTEIRA\>",
        "birthdate" : "\<DATA DE NASCIMENTO TITULAR DA CARTEIRA\>",
        "address": {
            "street": "\<RUA TITULAR DA CARTEIRA\>",
            "state": "\<ESTADO TITULAR DA CARTEIRA\>",
            "city": "\<CIDADE TITULAR DA CARTEIRA\>",
            "neighborhood": "\<BAIRRO TITULAR DA CARTEIRA\>",
            "number": "\<No. TITULAR DA CARTEIRA\>",
            "postal_code": "\<CEP TITULAR DA CARTEIRA\>",
            "complement": "\<COMPLEMENTO TITULAR DA CARTEIRA\>"
        },
        "phone": {
            "number": "\<CELULAR TITULAR DA CARTEIRA\>",
            "area_code": "\<DDD TITULAR DA CARTEIRA\>",
            "country_code": "55",
        }
    },
    "program_key" : "\<CHAVE DO PROGRAMA FORNECIDA PELO TIME DE INTEGRAÇÂO\>",
    "invoice_configuration":{
        "closing_day": "\<DATA DE FECHAMENTO DA FATURA\>", 
        "due_day": "\<DATA DE VENCIMENTO DA FATURA\>", 
        "grace_months": "\<DIFERENÇA, EM MESES, ENTRE closing_day e due_day\>", 
        "issuing_and_due_day_difference": "\<DIAS ANTES DO VENCIMENTO QUE A FATURA DEVE SER EMITIDA\>", 
        "invoice_payment_type": "bankslip", 
        "delay_fine_percentage": "\<CONFIGURAÇÃO DE ATRASO - VALOR DA MORA\>", 
        "delay_monthly_interest_rate": "\<CONFIGURAÇÃO DE ATRASO -VALOR DOS JUROS POR DIA\>"
    },
    "invoice_authorization": {
        "signature": {
            "signer": {
                "name": "\<NOME ASSINANTE\>",
                "email": "\<EMAIL ASSINANTE\>",
                "phone": {
                    "number": "\<CELULAR ASSINANTE\>",
                    "area_code": "\<DDD ASSINANTE\>",
                    "country_code": "55",
                },
                "document_number": "CPF ASSINANTE"
                },
            "authentication_type": "opt_in",
            "authenticity": {
                "timestamp": "\<DATA E HORA DA ASSINATURA\>",
                "ip_address": "\<IP DO ASSINANTE\>",
                "fingerprint": {},
                "third_party_additional_data": {},
                "session_id": "\<ID DA SESSÃO DO ASSINANTE\>"
                },
            "signed_object": {
                "document_key": "\<CHAVE DO DOCUMENTO NA QI\>"
                }
            }
        },
    "default_monthly_interest_rate": "\<TAXA DE JUROS MENSAL, DEFAULT DA CARTEIRA, CONSIDERADA PARA CADA ENTRADA (PIX)\>"
  }

Request body details

Payload wallet

Campo	Tipo	Descrição	Caracteres
`owner`	object	Objeto Dono da carteira	Objeto owner
`program_key`	string	Chave do programa de crédito
`invoice_configuration`	object	Objeto Configurações da Fatura para cada Carteira	Objeto invoicer_configuration
`invoice_authorization`	object	Objeto Autorização	Objeto invoice_authorization
`default_monthly_interest_rate`	number	Taxa de juros default da carteira.

Objeto owner

Campo	Tipo	Descrição	Caracteres
`person_type`	string	Identificador de que o objeto enviado é uma pessoa física ou jurídica.
`name`	string	Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF.	100
`document_number`	string	CPF da pessoa (apenas números). Limitado a 11 caracteres.
`birthdate`	string	Data de nascimento no formato YYYY-MM-DD
`address`	string	Endereço do cliente.	Objeto adress
`phone`	string	Objeto com dados do telefone	Objeto phone
`email`	string	Email do cliente.

Objeto address

Campo	Descrição	Exemplo	Máx. Caracteres
`street`	string	Rua do endereço	100
`state`	string	Estado do endereço (com dois caracteres maiúsculos)	2
`city`	string	Cidade do endereço	100
`neighborhood`	string	Bairro do endereço	100
`number`	string	Número da rua	10
`postal_code`	string	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)	8
`complement`	string	Complemento do endereço (texto livre)	100

Objeto phone

Campo	Descrição	Exemplo	Máx. Caracteres
`country_code`	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
`area_code`	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
`number`	string	Número de telefone (apenas números)	10

Objeto invoice_configuration

Campo	Descrição	Exemplo
`closing_day`	number	Dia de fechamento da fatura (data de corte para registro de entradas me uma fatura).
`due_day`	number	Dia de vencimento da fatura. Opções: 1,5,10
`grace_months`	number	Diferença de meses entre a data de fechamento e vencimento.
`delay_fine_percentage`	number	Valor da mora, em caso de atraso no pagamento da fatura.
`delay_monthly_interest_rate`	number	Valor do juros, por mês, em caso de atraso no pagamento da fatura.
`issuing_and_due_day_difference`	number	Número de dia entre a emissão da fatura e vencimento, para fins de cálculo da data de emissão da fatura
`invoice_payment_type`	string	Meio de pagamento da fatura. Opções: 'bankslip'

CONFIGURAÇÕES DA INVOICE

Na configuração da invoice (invoice_configuration), os dados fixos, como "delay_fine_percentage", "grace_months", "delay_monthly_interest_rate", "invoice_payment_type", "issuing_and_due_day_difference", podem estar diretamente configurado no setup inicial do parceiro na API, simplificando o payload de criação da wallet. As informações configuradas no setup inicial do parceiro na API serão fixas para todos os clientes.

caution

O número de dias entre a data de vencimento da fatura “invoice_configuration.due_day“ e a data fechamento “invoice_configuration.closing_day“, precisa ser maior ou igual a 8 dias e menor ou igual a 10 dias.

Response

ENDPOINT

/postpaid/wallet

MÉTODO

POST

HTTP STATUS

201

Response Body

{
    "wallet_key": "0f4581d6-f4a4-4430-b94e-5db700e4baed",
    "status": "pending_kyc_analysis"
}

Response body details

Campo	Tipo	Descrição	Caracteres
`wallet_key`	string	Identificador único da carteira (uuid)
`status`	string	Status da carteira

Erros

STATUS

4XX

Response Body

{
  "title": "Bad Request",
  "description": "The type of person is invalid for this program, please try another.",
  "translation": "Invalid Person",
  "code": "CARD000007"
}

Code	Status code	Descrição
QIT000001	400	Invalid Json schema.
CARD000005	404	It was not possible to fetch the Program for the program_key {program_key}.
CARD000007	400	The type of person is invalid for this program, please try another.
CARD000044	400	The due day {due_day} is invalid for the program {program_key}.
CARD000045	400	Requester postpaid limit exceeded. Current total: {current_total}, requested amount: {requested_amount}, limit: {limit}.

Webhook

WEBHOOK_TYPE

baas.pospaid_card.card

Webhook Body

{
    "webhook_type": "baas.pospaid_card.card",
    "event_datetime": "2023-07-24T12:00:00.000Z",
    "data": {
        "wallet_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
        "program_key": "bf74df61-557a-45cb-914f-41e127a6e18c",
        "status": "created",
    }
}

Criação da Carteira

Request​

Request body details​

Payload wallet​

Objeto owner​

Objeto address​

Objeto phone​

Objeto invoice_configuration​

Response​

Response body details​

Erros​

Webhook​