Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Adicionar Saldo

Suggest Edits

Essa funcionalidade permite que os clientes da Celcoin consigam adicionar dinheiro em contas de sandbox para testar as demais funcionalidades.

📘

Atenção

Este endpoint funciona exclusivamente no ambiente de sandbox! Em produção, os saldos são adicionados às contas por meio de operações de cash in.

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Realizar o lançamento na conta [API Reference]

Fluxo de integração

Gerar Lançamento

Json de exemplo

{
    "clientCode": "f9b978a6-ab7e-4460-997d", //Identificador unico da transação do cliente.
    "amount": 20,  // Valor
    "type": "CREDIT", // Tipo da transação CREDIT 
    "description": "Deposito"  //Descrição da transação
}

cURL da chamada

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas-wallet-transactions-webservice/v1/wallet/entry/{{AccountNumber}}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{Token}}' \
--header 'Content-Type: application/json' \
--data-raw '{"clientCode":"f9b978a6-ab7e-4460-997d","amount":20,"type":"CREDIT","description":"Deposito"}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "c0b2d6ac-d46c-4f95-8c8c-d7e74877d1c0",
        "clientCode": "f9b978a6-ab7e-4460-997d"
    }
}

Status do Lançamento

RetornoDescrição
PROCESSINGLançamento em processamento.
CONFIRMEDLançamento Confirmado
ERRORErro no lançamento.

❗

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE039",
    "message": "Account invalido.."
  }
}

Tabela de errorCode

CodeMessage
CBE091É necessário informar o campo: account.
CBE039Account invalido.
CBE041Account possui tamanho maximo de 20 caracteres
CBE092Lançamento não permitido.Conta esta encerrada.
CBE001ClientCode é obrigatório.
CBE093ClientCode possui tamanho maximo de 200 caracteres.
CBE094Amount é obrigatório.
CBE095Amount invalido. Favor verificar a formatação do campo e deve ser maior que 0.
CBE096Type é obrigatório e deve ser do tipo CREDIT.
CBE097Description possui tamanho maximo de 250 caracteres.
CBE099Lançamento de credito não permitido.Instituição com saldo insuficiente.
CBE100Existe um lançamento idêntico pendente.Favor aguarde para realizar esta operação para evitar duplicidade.
CBE101Já existe um lançamento com o mesmo clientCode. Favor realizar uma nova operação.
CBE103Lançamento de credito não permitido.Valor ultrapassa o limite maximo permitido por operação.
CBE105Lançamento de credito não permitido.Valor ultrapassa o limite maximo permitido por periodo.

Updated 3 months ago