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.

Autenticação

Realiza a geração do token para a autenticação dos endpoints da API.

POSTGeração de Token

https://sandbox.bcodex.io/bcdx-sso/login

HEADERS

Content-Type

application/x-www-form-urlencoded

Bodyurlencoded

username

40756355-9edd-4bc2-a23f-38fdsa780d345ba7

password

2a3cd0ab066a2755a63f90dd5633271cdsadsa

Example Request

curl

curl --location 'https://sandbox.bcodex.io/bcdx-sso/login' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=40756355-9edd-4bc2-a23f-38fdsa780d345ba7' \
--data-urlencode 'password=2a3cd0ab066a2755a63f90dd5633271cdsadsa'

200 OK

Example Response

json

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJKYnJnaE9yRFZVZDU2ZnNNOFdHQUFUOGpRN3JxbHl2clNQZDNoYkdiemdJIn0.eyJleHAiOjE3MTc0NjA0MDQsImlhdCI6MTcxNzQ1OTgwNCwianRpIjoiOTZhNzJkZDMtMjA3ZS00NDIwLTk3OTMtZjViMWZhNzBhYzJhIiwiaXNzIjoiaHR0cHM6Ly9iY29kZXgta2V5Y2xvYWstZGV2LTEyMTIwNDI1MjUudXMtZWFzdC0xLmVsYi5hbWF6b25hd3MuY29tL3JlYWxtcy9iY29kZXgiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZTNkZjVlYjEtNmI5Yi00MjdhLTk5MDYtZTQ3YjE0ODNkNTVhIiwidlvbl9zdGF0ZSI6IjhhYmEwNDE5LWY2ZTgtNDkxZS1hYjZhLTI2Mjg0OTA0M2ZhZiIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiLyoiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIlBJWFBBWV9QSVhfQUxMIiwiZGVmYXVsdC1yb2xlcy1iY29kZXgiLCJjcmVhdGUtdXNlcnMiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByb2ZpbGUiOiJtYW5hZ2VyIiwibmFtZSI6InFhYmNvZGV4IiwiZ3JvdXBzIjpbIlBJWFBBWV9QSVhfQUxMIiwiZGVmYXVsdC1yb2xlcy1iY29kZXgiLCJjcmVhdGUtdXNlcnMiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiUElYUEFZX01BTkFHRVJfQUxMIl0sInByZWZlcnJlZF91c2VybmFtZSI6InFhYmNvZGV4IiwiZ2l2ZW5fbmFtZSI6InFhYmNvZGV4IiwiZW1haWwiOi0bG9vay5jb20ifQ.q8VzExx_wB8fd5u7Nezah3RdujybY6bRutUUXc8UHDiNUjbtkosK6V8t_OlyzTOzKH0HJQAzX4L91o3eyiAsh_Lpqhcws5rMs9ex1uLUB2Q0aquXzBLVICr0uYQ5fLRK5kXRfoB3XekBeXnAiLuSeDOlNw_IkjyuTP5uDWVOVUcq_D4PQCHsZ9CLv_VlBM0nr6BfAchPfBXSstYhWywsdN-UeF_pcwwBJOU6gy71BSuQnKeN9iNTvA6pVnd4qFnofGn_3BIdrnDDXRc8wHTr5H823yA1O0rkjJiHOEOjoD9wVHyQy--UFQSgeYrtMQOR9X4g",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJkODVjYWI5NC0xNjYwLTRiYzktOGMxMC0wYzdiZTdiNDY5M2IifQ.eyJpYXQiOjE3MTc0NTk4MDQsImp0aSI6IjUzZjY5MmFhLTVhMDQtNDUxNS1iOTJkLTI1YzRkMDM1NDQ5NCIsImlzcyI6Imh0dHBzOi8vYmNvZGV4LWtleWNsb2FrLWRldi0xMjEyMDQyNTI1LnVzLWVhc3QtMS5lbGIuYW1hem9uYXdzLmNvbS9yZWFsbXMvYmNvZGV4IiwiYXVkIjoiaHR0cHM6Ly9iY29kZXgta2V5Y2xvYWstZGV2LTEyMTIwNDI1MjUudXMtZWFzdC0xLmVsYi5hbWF6b25hd3MuY29tL3JlYWxtcy9iY29kZXgiLCJzdWIiOiJlM2RmNWViMS02YjliLTQyN2EtOTkwNi1lNDdiMTQ4M2Q1NWEiLCJ0eXAiOiJPZmZsaW5lIiwiYXpwIjoiYmluZC11c2VyIiwic2Vzc2lvbl9zdGF0ZSI6IjhhYmEwNDE5LWY2ZTgtNDkxZS1hYjZhLTI2Mjg0OTA0M2ZhZiIsInNjb3BlIjoicHJvZmlsZSBhZGRyZXNzIG9mZmxpbmVfYWNjZXNzIGVtYWlsIHBob25lIHVzZXJfaW5mbyBtaWNyb3Byb2ZpbGUtand0Iiwic2lkIjoiOGFiYTA0MTktZjZlOC00OTFlLWFiNmEtMjYyODQ5MDQzZmFmIn0.awGQMRHph-qWNHKZSe4jYpr33AXKo8dM6WCms1unO9Q",
  "token_type": "Bearer",
  "expires_in": 600
}

Content-Type

application/json

Consulta de contas

POSTConsulta de contas

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

A operação realizará a consulta retornando a informação dos títulos que estão registrados na CIP.
Sendo apenas, documentos que são emitidos por uma instituição financeira.

Ao realizar a pesquisa de boletos do tipo Conta de Consumo ou Tributos, como estes não são registrados na CIP, este endpoint consultará apenas as informações contidas no códigos de barras, retornando assim valores que estão definidos na composição do código de barras.

Bodyraw (json)

json

{
    "barCodeOrDigitableLine": "xxxxxxxxxxxxxxxxxx"
}

Example Request

curl

curl --location 'https://sandbox.bcodex.io/bcdx-hub/api/v1/billet/consult' \
--header 'Content-Type: application/json' \
--data '{
    "barCodeOrDigitableLine": "xxxxxxxxxxxx"
}'

200 OK

Example Response

json

{
  "id": "117c7fe2-22c4-4239-a904-0dcb7454b24f",
  "pixPaymentId": null,
  "clientReferenceId": null,
  "managerId": "84b04be4-cc00-4e2a-a7e0-0fee7f3b0f57",
  "status": "SEARCHED",
  "beneficiary": {
    "document": "xxxxxxxxx",
    "name": "Axxxxxxxxxxxx"
  },
  "type": "PAYMENT",
  "amount": 33.49,
  "title": null,
  "barCode": "02191970500000033499201551090000214130490102",
  "digitableLine": "02199201595109000021041304901022197050000003349",
  "dueDate": "2024-05-03T00:00:00.000Z",
  "debtor": {
    "document": "xxxxx",
    "name": "xxxxx"
  },
  "venueDate": "2024-08-01T00:00:00.000Z",
  "searchedAt": "2024-04-26T19:44:46.829Z",
  "createdAt": "2024-04-26T19:44:46.829Z",
  "updatedAt": "2024-04-26T19:44:46.829Z",
  "amountDetail": {
    "nominalValue": 33.49,
    "fine": 0,
    "discount": 0,
    "interest": 0,
    "totalAmount": 33.49,
    "maximunAmount": 33.49,
    "minimunAmount": 33.49,
    "allowPartialPayment": false
  },
  "paymentAgreement": "Título/Boleto",
  "paymentProviderId": null
}

Content-Type

application/json

Reserva de saldo

POSTReserva de saldo

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

Este endpoint efetuar a reserva de saldo numa conta escrow, especificamente destinada ao pagamento de boletos. Este processo é acionado subsequentemente à consulta prévia de um boleto e é essencialmente uma resposta à manifestação do cliente de desejar proceder com a liquidação do mesmo. Ao invocar este endpoint, o sistema assegura a alocação dos fundos necessários, garantindo que o montante correspondente ao valor do boleto esteja seguramente retido e pronto para ser utilizado no pagamento, assim que o cliente confirmar a operação de liquidação.

Duração default de reserva: 30 minutos

Duração Mínima: 5 minutos.
Duração Máxima: 720 minutos

AUTHORIZATIONBearer Token

Token

<token>

PATH VARIABLES

6095fceb-98b4-4238-94a1-c071fda3c492

Identificador do boleto consultado

Bodyraw (json)

json

{
	"amount": 3027.28,
    "expiresAt": 120,
    "accountId": "d5b5fbb0-ea84-43c4-9c23-594ca8bd7000"
}

Example Request

curl

curl --location 'https://sandbox.bcodex.io/bcdx-hub/api/v1/billet/:id/reserve-balance' \
--data '{
  "id": "e53b53e3e5b1488baef5988eaa51",
  "valor": 20.00
}'

200 OK

Example Response

json

{
  "billet": {
    "reserve": {
      "amount": 0.5,
      "expiresAt": "2024-03-18T00:00:00.000Z"
    },
    "id": "0834993b-99c1-46ec-8b21-1a3af5ec8454",
    "accountId": "13623569-8cc9-4408-9a87-fd0357fa555e",
    "status": "SEARCHED"
  }
}

Content-Type

application/json