post https://sandbox.openfinance.celcoin.dev/v5/transactions/billpayments/authorize
Tipos de pagamento de contas:
0 - Undefined
1 - Concessionaria
2 - FichaCompensacao
Nesta etapa retornaremos os dados do registro consultado, por meio de sua linha digitável ou código de barras. Para mais informações de como realizar a implementação dessa api, criamos o artigo
DADOS REQUEST AUTHORIZE
Campo | Tipo | Obrigatoriedade | Descrição |
---|---|---|---|
externalTerminal | String (50) | 🟡 Não obrigatório | |
externalNSU | Int | 🟡 Não obrigatório | |
type | String (1) | 🟡 Não obrigatório | |
digitable | String (48) | ✅ Obrigatório | |
barcode | String (50) | ✅ Obrigatório |
DADOS RESPONSE AUTHORIZE
Campo | Tipo | Obrigatoriedade | Descrição |
---|---|---|---|
assignor | String (100) | ✅ Obrigatório | Cedente do pagamento consultado |
documentRecipient | String (18) | ✅ Obrigatório | CPF ou CNPJ do beneficiário |
documentPayer | String (18) | ✅ Obrigatório | CPF ou CNPJ do pagador |
payDueDate | Datetime | ✅ Obrigatório | Data de baixa do boleto |
nextBusinessDay | Datetime | ✅ Obrigatório | Próximo dia útil |
dueDateRegister | Datetime | ✅ Obrigatório | Data de vencimento do registro |
allowChangeValue | Bool | ✅ Obrigatório | Permissão de alteração do valor do boleto |
recipient | String (100) | ✅ Obrigatório | Nome do beneficiário |
payer | String (100) | ✅ Obrigatório | Nome do pagador |
discountValue | Double | ✅ Obrigatório | Valor do desconto calculado |
interestValueCalculated | Double | ✅ Obrigatório | Valor juros já calculado |
maxValue | Double | ✅ Obrigatório | Valor máximo permitido para pagamento do título |
minValue | Double | ✅ Obrigatório | Valor mínimo permitido para pagamento do título |
fineValueCalculated | Double | ✅ Obrigatório | Valor multa já calculado |
originalValue | Double | ✅ Obrigatório | Valor nominal do título |
totalUpdated | Double | ✅ Obrigatório | Valor atualizado a ser pago do título |
totalWithDiscount | Double | ✅ Obrigatório | Valor total de descontos e abatimentos |
totalWithAdditional | Double | ✅ Obrigatório | Valor total de juros e multa |
settleDate | Datetime | ✅ Obrigatório | Informa a data em que o pagamento será enviado para liquidação |
dueDate | Datetime | ✅ Obrigatório | Retorna a data de vencimento extraída do código |
endHour | String (5) | ✅ Obrigatório | Informa a Hora corte do convênio (HH:MM) |
initeHour | String (5) | ✅ Obrigatório | Informa a Hora recebimento Inicial do convênio (HH:MM) |
nextSettle | String (1) | ✅ Obrigatório | Informa se o título será liquidado no próximo dia útil |
transactionId | Int | ✅ Obrigatório | Protocolo de identificação da operação |
value | Double | ✅ Obrigatório | Valor extraído do código |
errorCode | String (3) | ✅ Obrigatório | Define o código status da operação |
message | String (100) | 🟡 Não obrigatório | Informa descrição do erro |
status | String (30) | ✅ Obrigatório | Define o status da operação |