Gestão de Carteiras

Essa funcionalidade permite criar e gerenciar uma Carteira (Wallet) para que possa utilizá-la no momento da emissão de um boleto. Com ela, será possível gerenciar melhor boletos de acordo as suas características.

Pré requisitos para implementação:

• Possuir uma chave api da Celcoin, para mais informações acessar esse link

• Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.

• Ter o produto/solução contratado e habilitado em produção.

  • Caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

Passos para Integrar

1. Realizar autenticação na API - [API Reference]
2. Criar uma Carteira- [API Reference]
3. Alterar uma Carteira - [API Reference]
4. Excluir uma Carteira - [API Reference]

Caso seja necessário você pode consultar um beneficiário cadastrado.

• Consultar uma Carteira por ID- [API Reference]
• Consultar todas as carteiras - [API Reference]

2. Criar uma carteira

Para criar uma carteira, basta informar na chamada a seguir um código e um nome para a carteira.

cURL da chamada

curl --request POST \
     --url https://sandbox.openfinance.celcoin.dev/billissuance/v1/wallet \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "code": 1,
  "name": "Pagamento de Boleto"
}
'

Descrição dos campos

Exemplo de retorno

👍

Sucesso 201

{
  "id": "6634faaf01291980cd70ce0f",
  "code": 1,
  "message": "A solicitação de inclusão da carteira foi realizada com sucesso."
}

Descrição dos campos

❗

Error 400

{
  "code": "string",
  "statusCode": 0,
  "message": "string",
  "details": [
    {
      "field": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Para validar os cenários de erro dessa API, acesse a tabela de erros.

3. Alterar uma carteira

Esta API permite que o cliente altere o código ou o nome de uma Carteira específica através do ID único gerado no momento da criação.

cURL da chamada

curl --request PATCH \
     --url https://sandbox.openfinance.celcoin.dev/billissuance/v1/wallet/6634faaf01291980cd70ce0f \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "code": 2,
  "name": "Pagamento de Boletos 2"
}
'

Descrição dos campos

Exemplo de retorno

👍

Sucesso 201

{
  "id": "6634faaf01291980cd70ce0f",
  "message": "A solicitação de alteração da carteira foi realizada com sucesso."
}

Descrição dos campos

❗

Error 400

{
  "code": "string",
  "statusCode": 0,
  "message": "string",
  "details": [
    {
      "field": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Para validar os cenários de erro dessa API, acesse a tabela de erros.

4. Excluir uma carteira

Essa API permite a deleção de carteira

cURL da chamada

curl --request DELETE \
     --url 'https://sandbox.openfinance.celcoin.dev/billissuance/v1/wallet/6634faaf01291980cd70ce0f?force=false' \
     --header 'accept: application/json'

Descrição dos campos

Exemplo de retorno

👍

Sucesso 201

{
  "id": "6634faaf01291980cd70ce0f",
  "message": "A solicitação de alteração da carteira foi realizada com sucesso."
}

Descrição dos campos

❗

Error 400

{
  "code": "string",
  "statusCode": 0,
  "message": "string",
  "details": [
    {
      "field": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Para validar os cenários de erro dessa API, acesse a tabela de erros.