Criar cobrança com vencimento

PUT https://sandbox.tbanks.com.br/cobv/{identificadorDaCobrança}

Com esse endpoint você poderá criar cobranças (Qr Codes) para pagamentos com vencimento.

Corpo do request

Campo	Tipo	Obrigatório	Descrição
devedor	Object	Sim	Informação do pagador
└── nome	String	Sim	Nome do pagador
└── cpf	String	Sim	Número do documento do pagador
└── logradouro	String	Não	Endereço do pagador
└── cidade	String	Não	Cidade do pagador
└── uf	String	Não	Estado do pagador
└── cep	String	Não	Cep do pagador
└── email	String	Não	Email do pagador
valor	Object	Sim	Informação do valor da cobrança
└── original	String	Sim	Valor da cobrança
└── multa	Object	Não	Dados de multa da cobrança
└── └── modalidade	Enum	Sim	Modalidade da multa a ser aplicada (Verificar tabela de modalidades para mais detalhes)
└── └── valor	String	Sim	Valor da multa
└── juros	Object	Não	Dados de juros da cobrança
└── └── modalidade	Enum	Sim	Modalidade de juros (Verificar tabela de modalidades para mais detalhes)
└── └── valor	String	Sim	Valor dos juros a serem aplicados
└── desconto	Object	Não	Dados de desconto da cobrança
└── └── modalidade	Enum	Sim	Modalidade de desconto a ser aplicada (Verificar tabela de modalidades para mais detalhes)
└── └── descontoDataFixa	Array	Sim	Valores de desconto por data
└── └── └── data	String	Sim	Data do desconto
└── └── └── valor	String	Sim	Valor do desconto até a data informada
└── abatimento	Object	Não	Dados de abatimento da cobrança
└── └── modalidade	Enum	Sim	Modalidade do abatimento a ser aplicado (Verificar tabela de modalidades para mais detalhes)
└── └── valor	String	Sim	Valor do abatimento
chave	String	Sim	Valor da chave recebedora
calendario	Object	Sim	Informação da expiração da cobrança
└── dataDeVencimento	String	Sim	Data de vencimento do QR Code
└── validadeAposVencimento	String	Não	Expiração do QR code após a data de vencimento em dias
infoAdicionais	Array	Não	Array de informações adicionais para o QRCode
└── nome	String	Sim	Nome da informação adicional
└── valor	String	Sim	Descrição da informação adicional
solicitacaoPagador	String	Não	Descrição para o pagador
reutilizavel	boolean	Não	Define se a cobrança pode ser reutilizável

Exemplo de requisição

json

{
    "calendario": {
        "dataDeVencimento": "2022-12-31",
        "validadeAposVencimento": 42
    },
    "devedor": {
        "logradouro": "Alameda Souza, Numero 80, Bairro Braz",
        "cidade": "Recife",
        "uf": "PE",
        "cep": "70011750",
        "cpf": "12345678909",
        "nome": "Francisco da Silva",
        "email": "[email protected]"
    },
    "valor": {
        "original": "123.45",
        "multa": {
            "modalidade": "2",
            "valor": "15.00"
        },
        "juros": {
            "modalidade": "2",
            "valor": "2.00"
        },
        "desconto": {
            "modalidade": "1",
            "descontoDataFixa": [
                {
                    "data": "2022-11-30",
                    "valor": "10.00"
                }
            ]
        },
        "abatimento": {
            "modalidade": "2",
            "valor": "2.00"
        }
    },
    "chave": "84283691003",
    "solicitacaoPagador": "Cobrança dos serviços prestados.",
    "infoAdicionais": [
        {
            "name": "Teste cobv",
            "value": "Teste cobv"
        }
    ]
}

Corpo do response

Campo	Tipo	Descrição
loc	Object	Informação da location do QR code gerado
└── location	String	Location do QR code gerado
└── id	String	Número da revisão do location
└── tipoCob	String	Tipo da cobrança gerada
devedor	Object	Informação do pagador
└── nome	String	Nome do pagador
└── cpf	String	Número do documento do pagador
└── logradouro	String	Endereço do pagador
└── cidade	String	Cidade do pagador
└── uf	String	Estado do pagador
└── cep	String	Cep do pagador
└── email	String	Email do pagador
recebedor	Object	Informação do pagador
└── nome	String	Nome do recebedor
└── cpf	String	Número do documento do recebedor
└── logradouro	String	Endereço do recebedor
└── cidade	String	Cidade do recebedor
└── uf	String	Estado do recebedor
└── cep	String	Cep do recebedor
valor	Object	Informação do valor da cobrança
└── original	String	Valor da cobrança
└── modalidadeAlteração	String	Modalidade de alteração da cobrança
chave	String	Valor da chave recebedora
txid	String	Id da transação
calendario	Object	Informação da expiração da cobrança
└── criacao	String	Data de vencimento do QR Code
└── dataDeVencimento	String	Data de vencimento do QR Code
└── validadeAposVencimento	String	Expiração do QR code após a data de vencimento em dias
infoAdicionais	Array	Array de informações adicionais para o QRCode
└── nome	String	Nome da informação adicional
└── valor	String	Descrição da informação adicional
location	String	Location do QR code gerado
solicitacaoPagador	String	Descrição para o pagador
revisao	String	Status da cobrança
reutilizavel	boolean	*Define se a cobrança pode ser reutilizada
copiaCola	String	Código copia e cola do QR Code

Descrição das modalidades de Juros

Status	Descrição
VALUE_PER_DAY,1	Valor (dias corridos)
PERCENTAGE_PER_DAY,2	Percentual ao dia (dias corridos)
PERCENTAGE_PER_MONTH_BUSY_DAY,3	Percentual ao mês (dias corridos)
PERCENTAGE_PER_YEAR_BUSY_DAY,4	Percentual ao ano (dias corridos)
VALUE_WORKING_DAY,5	Valor (dias úteis)
PERCENTAGE_PER_WORKING_DAY,6	Percentual ao dia (dias úteis)
PERCENTAGE_PER_MONTH_WORKING_DAY,7	Percentual ao mês (dias úteis)
PERCENTAGE_PER_YEAR_WORKING_DAY,8	Percentual ao ano (dias úteis)

Descrição das modalidades de Multa

Status	Descrição
FIXED_VALUE,1	Valor fixo
PERCENTAGE,2	Percentual

Descrição das modalidades de Abatimento

Status	Descrição
FIXED_VALUE,1	Valor fixo
PERCENTAGE,2	Percentual

Descrição das modalidades de Desconto

Status	Descrição
FIXED_VALUE_UNTIL_THE_DATE,1	Valor Fixo até a data informada
PERCENTAGE_VALUE_UNTIL_THE_DATE,2	Percentual até a data informada
VALUE_PER_ANTICIPATION,3	Valor por antecipação dia corrido
VALUE_PER_ANTICIPATION_WORKING_DAY,4	Valor por antecipação dia útil
PERCENTAGE_PER_ANTICIPATION,5	Percentual por antecipação dia corrido
PERCENTAGE_PER_ANTICIPATION_WORKING_DAY,6	Percentual por antecipação dia útil