Hub de serviços - Pag contas

O HUB de Serviços Integrados é uma plataforma digital construída sobre uma arquitetura de API Iavançada, projetada para facilitar o gerenciamento e o processamento de pagamentos de contas.

Esta solução oferece uma interface unificada para a integração de diversos serviços, permitindo aos usuários acessar e gerenciar suas contas e pagamentos de forma eficiente e segura.

A arquitetura baseada em API garante flexibilidade, escalabilidade e compatibilidade com uma ampla gama de sistemas e aplicativos.

Integrando na Bcodex

Olá, bem-vindo à documentação técnica da Bcodex!

Nessa documentação, você vai encontrar todas as informações necessárias para integrar com as nossas APIs.

Sandbox e Produção compartilham o mesmo código, mas estão isolados um do outro, pois estão sendo executados em servidores separados e acessam bancos de dados diferentes. Mudar para Produção exige que você altere apenas a URL base e as credenciais. Os SDKs selecionam a URL base de acordo com o ambiente que você escolhe.

Postman:

Para facilitar a sua integração, disponibilizamos uma collection no Postman com todos os endPoints do produto de pagamento de contas.

Processo de Integração

Para se integrar na API Bcodex, você precisa passar por quatro etapas:

1. Obtenha suas credenciais de acesso

Nossas APIs possuem autenticação, utilizando o protocolo OAuth 2.0

Após a assinatura do contrato, ocorrerá um processo administrativo por parte da Bcodex. Iremos fornecer suas credenciais de usuário para o pagamento de contas em aproximadamente 24 horas após a assinatura do contrato. Essas credenciais incluem o client_id e o client_secret.

Com essas informações em mãos, nossos parceiros terão acesso a todas as funcionalidades disponíveis. Certifiquem-se de inserir essas credenciais de autenticação em todas as rotas relevantes.

2. Integração

Nessa fase nosso cliente pode realizar seus desenvolvimento em nosso ambiente de sandbox (testes), onde é possível testar toda a comunicação com nossas apis e entender seus comportamentos.

3. Homologação

Após finalizar o desenvolvimento com as apis da Bcodex, você deverá preencher um roteiro de homologação da funcionalidade que está implementando, para que possamos validar sua integração.

4. Produção

Ao final da homologação, você receberá o nosso OK e as chaves do seu ambiente produtivo para iniciar sua operação.

POSTConfirmacao de liquidação

https://sandbox.bcodex.io/bcdx-hub/api/v1/billet/:id/liquidate

Após a clara manifestação do cliente em proceder com o pagamento e a subsequente confirmação de que os fundos necessários foram reservados com sucesso na conta escrow, este endpoint assume um papel fundamental, agindo como o mecanismo que efetiva a liquidação do boleto junto à instituição bancária.

A utilização deste endpoint é o passo decisivo que conclui o ciclo de pagamento, confirmando a dedução do valor do saldo reservado e o seu direcionamento correto para a quitação do boleto.

Regras de horário de corte para pagamentos de boletos:

Tipo de Boleto	Homologação	Produção
Tributos	10:00 as 17:00	08:00 as 20:30
Conta de consumo	10:00 as 17:00	08:00 as 19:30
Títulos	10:00 as 17:00	Até 20:30 em dias úteis. Pagamentos após as 20:30, aos sábados, domingos e feriados, serão liquidados no próximo dia útil.

PARAMS

PATH VARIABLES

Bodyraw (json)

json

{
    "amount": 75.6,
    "clientReferenceId": "Descrição"
    
}

Example Request

curl

curl --location 'https://api.bcodex.io/bcdx-hub/api/v1/billet/:id/liquidate' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 75.6,
    "clientReferenceId": "Descrição"
}'

200 OK

Example Response

json

{
  "id": "0834993b-99c1-46ec-8b21-1a3af5ec8454",
  "clientReferenceId": "Padaria do Joaquim - POS 3",
  "status": "PROCESSIN_LIQUIDATION",
  "amount": 0.5,
  "updateAt": "2024-03-18T00:00:00.000Z"
}

Content-Type

application/json

Consulta de Pagamento

GETConsulta de pagamento

https://sandbox.bcodex.io/bcdx-hub/api/v1/billet/:id

Este endpoint é projetado para gerar a segunda via de um recibo de pagamento, oferecendo uma réplica exata do documento original.

Dentre essas informações adicionais, destacam-se o código de barras preciso e a linha digitável característica do boleto. Através deste endpoint, os usuários têm à disposição um meio confiável e eficiente para recuperar registros vitais de suas transações, assegurando transparência total e acesso contínuo às suas informações financeiras.

PATH VARIABLES

Example Request

curl

curl --location 'https://api.bcodex.io/bcdx-hub/api/v1/billet/:id'

200 OK

Example Response

json

{
  "id": "8b9d186a-589d-45c7-a355-a0366b6e9185",
  "pixPaymentId": null,
  "clientReferenceId": null,
  "managerId": "f1555387-3278-444f-a04d-0193374e46fd",
  "status": "LIQUIDATED",
  "beneficiary": {
    "document": "xxxx",
    "name": "xxxx"
  },
  "type": "PAYMENT",
  "amount": 1563.37,
  "title": null,
  "barCode": "02191970500001563379201551000324987580470102",
  "digitableLine": "03399201595100032498175804701029197050000156337",
  "dueDate": "2024-05-03T00:00:00.000Z",
  "debtor": {
    "document": "xxx",
    "name": "xxxxxxxx"
  },
  "venueDate": "2024-05-06T00:00:00.000Z",
  "searchedAt": "2024-04-30T01:27:08.040Z",
  "createdAt": "2024-04-30T01:27:08.040Z",
  "updatedAt": "2024-04-30T01:27:08.040Z",
  "amountDetail": {
    "nominalValue": 1563.37,
    "fine": 0,
    "discount": 0,
    "interest": 0,
    "totalAmount": 1563.37,
    "maximunAmount": 1563.37,
    "minimunAmount": 1563.37,
    "allowPartialPayment": false
  },
  "paymentAgreement": "Título/Boleto",
  "paymentProviderId": null,
  "nsu": null,
  "bank": {
    "code": "0633",
    "agency": "00019"
  },
  "paymentDate": "2024-06-04T15:45:37.560Z",
  "authentication": "4582385c-4dc2-47ac-a32c-505275111751"
}

Content-Type

application/json

Listagem de transações

GETListagem de Transacoes

https://bcodex.io/transacoes/clientid?dataInicial&dataFinal&status&valorMaximo&valorMinimo&tipoDebito&managerId

Este endpoint é projetado para oferecer uma visão e detalhada de todas as transações que foram efetivamente liquidadas pelo parceiro. Esta funcionalidade reside na sua capacidade de aplicar um filtro preciso que compreende um intervalo de datas, permitindo aos usuários especificar tanto uma data inicial quanto uma final. Essa característica assegura que os usuários possam obter uma lista cronologicamente ordenada de transações, liquidada dentro do período estipulado.

PARAMS

dataInicial

dataFinal

status

valorMaximo

valorMinimo

tipoDebito

managerId

Example Request

curl

curl --location 'https://bcodex.io/boleto/consulta'

200 OK

Example Response

json

{
  "transactions": [
    {
      "id": "e53b53e3e5b1488baef5988eaa51",
      "amount": "20.00",
      "transactionDate": "2024-09-19T00:00:00",
      "accountId": "e53b53e3e5b1488baef5988eaa51",
      "terminalId": "e53b53e3e5b1488baef5988eaa51"
    }
  ]
}

Content-Type

application/json

Webhooks

PUTAtualização Webhook

https://sandbox.bcodex.io/bcdx-hub/api/v1/webhook

AUTHORIZATIONBearer Token

Token

Bodyraw (json)

json

{
      "webhookUrl": "https://tarik.free.beeeceptor.com",
      "webhookSecret": "1234567891011121314151617181920212923242526"
}

Example Request

curl

curl --location --request PUT 'https://sandbox.bcodex.io/bcdx-hub/api/v1/webhook' \
--data '{
      "webhookUrl": "https://tarik.free.beeeceptor.com",
      "webhookSecret": "1234567891011121314151617181920212923242526"
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers