Pagamento de Contas
No momento em que um usuário efetuar um pagamento de contas, os dados do pagamento deverão ser enviados para a QI Tech. Deste modo, será possível realizar uma análise do risco envolvido na operação, baseado naquele conjunto de dados.
Definição do Objeto de Pagamento de Contas
Request Body
{
"id": "082373263",
"amount": 12979,
"bill_payment_date": "2020-10-07T15:06:25-03:00",
"bill_due_date": "2020-10-07",
"bill_issuing_date": "2020-10-07",
"service_description": "CONTA DE ELETRICIDADE ENEL",
"face_recognition_key": "ef39e206-13d5-48de-b368-6c3bbc6f0222",
"validation_key": "69a59de3-0198-4a26-933a-c1de624c147d",
"company": {
"id": "451673263",
"provided_service": "eletricity",
"name" : "Enel",
"legal_name": "Eletropaulo Metropolitana Eletricidade de São Paulo S.A.",
"document_number": "61.695.227/0001-93",
"address": {
"street": "Av. Dr. Marcos Penteado de Ulhôa Rodrigues",
"number": "939",
"neighbourhood": "Sítio Tamboré",
"city": "Barueri",
"uf": "SP",
"complement": "Loja 1 e 2",
"postal_code": "06460-040"
}
},
"payer": {
"id": "182373263",
"type": "legal_person",
"document_number": "07.487.735/0001-69",
"name": "Gioconda Pizzaria e Rotisseria LTDA.",
"email": "gioconda_pizza@bol.com.br",
"address": {
"street": "Avenida 13",
"number": "704",
"neighbourhood": "Centro",
"city": "Ituiutaba",
"uf": "MG",
"complement": "Apt 1101",
"postal_code": "38300-140"
},
"phone": {
"international_dial_code": "55",
"area_code": "16",
"number": "981610077",
"type": "mobile"
},
"account": {
"participant": "60701190",
"branch": "3675",
"account_number": "13212",
"account_digit": "5",
"account_type": "CACC"
},
"sales_channel": "inbound_sales",
"segment": "Personalité"
},
"source": {
"channel": "internet_banking",
"platform": "android",
"ip": "198.185.105.098",
"session_id": "7839jdqd9a8wd9"
}
}
Um pagamento de conta deve ser enviado para a API antes de ser encaminhada para o sistema de processamento, a fim de realizar uma validação prévia de fraude.
O status do pagamento representa a decisão retornada pelo modelo sobre aquela conta. Os seguintes status são utilizados na flag analysis_status:
automatically_approvedautomatically_reprovedin_manual_analysispending
Abaixo estão listados os significados de cada uma das decisões, devolvida na flag analysis_status:
| status | descrição |
|---|---|
| automatically_approved | Recomenda-se que este pagamento de conta seja aprovado. |
| automatically_reproved | Recomenda-se que este pagamento de conta seja reprovado. |
| in_manual_analysis | Recomenda-se que este pagamento de conta seja analisado manualmente. |
| pending | O pagamento de conta está sendo processado. |
| nome | tipo | descrição |
|---|---|---|
| id | string | Identificador da transação no sistema do cliente. É essencial que este número seja único para cada pagamento de conta |
| document_amount | inteiro | Valor do documento em centavos - conforme descrição da seção "Padrões". |
| other_deduction_amount | inteiro | Valor das outras deduções aplicadas sobre o valor do documento em centavos - conforme descrição da seção "Padrões". |
| interest_amount | inteiro | Valor da multa, mora ou juros aplicados sobre o valor do documento em centavos - conforme descrição da seção "Padrões". |
| amount | inteiro | Valor final pago no conta - conforme descrição da seção "Padrões". |
| bill_payment_date | datetime | A data e hora do pagamento do conta, com fuso horário. |
| bill_due_date | date | Data de vencimento do conta de acordo com a padronização |
| description | string | Campo descrição ou observações do conta. |
| face_recognition_key | string | Chave de reconhecimento facial, caso tenha sido feito reconhecimento facial pela nossa API de reconhecimento facial. |
| validation_key | string | Chave de validação, caso tenha sido feita algum teste de validação do cliente em nossa API de validações. |
| client | client | Objeto que representa os dados do cliente, seja ele o cliente que está efetuando o pagamento do boleto ou o recebendo o pagamento. |
| company | company | Objeto que representa a concessionária ou prestador de serviço referente àquela conta. |
| payer | bill_payer | Objeto que representa a pessoa física ou pessoa jurídica que pagou a conta. |
| recipient | bill_client | Objeto que representa a pessoa física ou pessoa jurídica para quem a conta foi emitida. |
| source | source | Objeto do tipo Source que descreve as informações provenientes da aplicação utilizada para o pagamento da conta. |
Enviar um Pagamento de Conta
Request Body
{
"id": "12345",
...
}
Response Body
{
"bill_payment_key": "13d680ef-4b72-4cb2-a63d-cf3d790abaaf",
"status": "automatically_approved",
"reason": "rule_decision_enum"
}
Para realizar a avaliação de um pagamento de conta, basta enviar um objeto do tipo BillPayment ao seguinte endpoint:
POST https://api.caas.qitech.app/bill_payment/bill_payment
Recuperar um Pagamento de Conta
Response Body
{
"id": "082373263",
"amount": 12979,
...
}
Para recuperar os dados de um pagamento de conta, basta enviar uma requisição ao seguinte endpoint:
GET https://api.caas.qitech.app/bill_payment/bill_payment/{bill_payment_id}
Onde bill_payment_id é o identificador da transação no sistema do cliente utilizado no envio do pagamento de conta.
Atualizar um pagamento de conta
Request Body
{
"bill_payment_status": "completed",
"event_date": "2020-10-07T15:06:25-03:00"
}
Response Body
{
"bill_payment_key": "13d680ef-4b72-4cb2-a63d-cf3d790abaaf",
"bill_payment_status": "completed"
}
Após um pagamento de conta ser criado e analisado, ela será enviado à câmara de compensação para ser processado. Deste modo, é necessário que seja informada a atualizações de status do pagamento quando este for enviado, através do endpoint:
PUT https://api.caas.qitech.app/bill_payment/bill_payment/{bill_payment_id}
Deste modo, garante-se que nossa base de dados seja atualizada e sejamos capazes de identificar os pagamentos que estejam realmente sucetíveis a fraude.