Documentação
Status PageSuporte
  1. cel_banking - BaaS & Core
  2. Core Banking - Lançamento manual

Realizar lançamento manual

Realizar lançamento manual em uma conta

Essa funcionalidade permite que os clientes da Core Banking, consigam efetuar lançamentos financeiros manuais em suas contas, tanto a débito quanto a crédito, utilizando a API de lançamento.

Cada lançamento precisa estar associado a um ID/Tag de operação previamente cadastrados pela Celcoin (por exemplo, PIX_IN, PIX_OUT, AJUSTE_OPERACIONAL, etc.).

Esses IDs/Tags determinam: O tipo da operação, as regras aplicáveis, os campos obrigatórios que devem ser preenchidos e a forma como o lançamento será registrado internamente e exibido nos extratos.

Dessa forma, o cliente tem autonomia para registrar operações específicas, mantendo aderência ao compliance, à contabilidade e aos controles regulatórios do Core.

Passos para Integrar

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

Regras


O lançamento só será efetuado caso o cliente possua conta transitória criada;

Não é possível efetuar o lançamento sem informar um Tipo de lançamento (launchType) previamente cadastrado;

O request deve conter todas as tags obrigatórias de acordo com o launchType Solicitado;

O launchType deve ser enviado com o type correto (Cada launchType esta ligado a DEBIT ou CREDIT)


Descrição dos campos

CampoDescriçãoTipo Campo
accountNumero da contastring
clientCodeIdentificador único gerado pelo cliente.String
launchTypeTipo de lançamento que será efetuadoString
amountValor do lançamentoDecimal (19,2)
typeTipo do lançamento (DEBIT ou CREDIT)String
descriptionDescrição do lançamentoString
accountNúmero da Conta de destino (Quem irá receber).String
tag.keyChave com a propriedade da tagString
tag.valueValor da Chave enviada na tagString

Exemplo de request

{
  "clientCode": "{{clientCode}}",
  "amount": 2,
  "type": "DEBIT",
  "description": "carga dev",
  "launchType": "PIXPAYMENTOUT",
  "tags": [
    {
      "key": "clientCode",
      "value": "123456"
    },
    {
      "key": "amount",
      "value": "0.1"
    },
    {
      "key": "creditParty.bank",
      "value": "123456"
    },
    {
      "key": "creditParty.account",
      "value": "468"
    },
    {
      "key": "creditParty.branch",
      "value": "0001"
    },
    {
      "key": "creditParty.taxId",
      "value": "12345678900"
    },
    {
      "key": "creditParty.name",
      "value": "celcoin"
    }
    ]
}

cURL da chamada

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/wallet/internal/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Token}}' \
--data '{
  "amount": 25.55,
  "clientRequestId": "1458854",
  "debitParty": {
    "account": "444444"
  },
  "creditParty": {
    "account": "444444"
  },
  "description": "string"
}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "CONFIRMED",
    "version": "2.0.0",
    "body": {
        "id": "00f6e814-9ff6-4f6e-8bf5-9565d5e2a4f2",
        "clientCode": "ce81a27b-f24f-41e5-aff8-925f3a1148f3",
        "amount": 2,
        "type": "DEBIT",
        "launchType": "PIXPAYMENTOUT",
        "description": "carga dev",
        "tags": [
            {
                "key": "clientCode",
                "value": "123456"
            },
            {
                "key": "amount",
                "value": "0.1"
            },
            {
                "key": "creditParty.bank",
                "value": "123456"
            },
            {
                "key": "creditParty.account",
                "value": "468"
            },
            {
                "key": "creditParty.branch",
                "value": "0001"
            },
            {
                "key": "creditParty.taxId",
                "value": "12345678900"
            },
            {
                "key": "creditParty.name",
                "value": "celcoin"
            }
        ]
    }
}
❗

Error 400

{
    "status": "ERROR",
    "version": "1.0.0",
    "error": {
        "errorCode": "CBE091",
        "message": "É necessário informar o campo: account"
    }
}

Tabela de errorCode

CodeMessage
CBE237Operação não permitida. Existe pendências para utilizar a API do BaaS.é obrigatório.
CBE316Lançamento não permitido. Não existe saldo em moeda eletrônica para o lançamento.
CBE210Cliente não esta ativo para utilizar a Api.
CBE215Operação não permitida para Virtual BaaS.
CBE234Não foi possível realizar essa operação. Tente novamente mais tarde.
CBE103Lançamento de credito não permitido. Valor ultrapassa o limite máximo permitido por operação.
CBE102Lançamento de debito não permitido. Valor ultrapassa o limite máximo permitido por operação.
CBE453Existem tags com keys duplicadas.
CBE460Não foi possível realizar essa operação. A movimentação não foi encontrada.
CBE658Esse tipo de lançamento não está mais ativo.
CBE659O tipo de operação informado (CREDIT ou DEBIT) não é compatível com o tipo de lançamento selecionado. Verifique se o tipo está correto para o launchType utilizado.
CBE657Tag obrigatória não encontrada: 0.
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.
CBE098Lançamento de debito não permitido. Conta com saldo insuficiente.

Webhooks de lançamentos manuais

EventoDescrição
launch-inEvento disparado sempre que for realizado um lançamento à CRÉDITO na conta do cliente
launch-outEvento disparado sempre que for realizado um lançamento à DÉBITO na conta do cliente.

Exemplo de webhook - "entity": "launch-out"

{
	"tenantId": "**PRIVATE**",
	"body": {
		"Status": "CONFIRMED",
		"Entity": "launch-out",
		"CreateTimestamp": "2025-06-17T12:41:41.0390944",
		"Body": {
			"Account": "30023646094074",
			"Description": "Rendimento teste postman",
			"Branch": "0001",
			"Amount": 0.01,
			"currentBalance": 5099505.77,
			"oldBalance": 5099505.78,
			"Id": "4ca54e0a-ed02-4507-8446-459f18b1a835",
			"TaxId": "66877376781",
           "launchType": "PIXPAYMENTOUT",
        "tags": [
            {
                "key": "clientCode",
                "value": "123456"
            },
            {
                "key": "amount",
                "value": "0.1"
            },            
            {
                "key": "creditParty.branch",
                "value": "0001"
            },
            {
                "key": "creditParty.taxId",
                "value": "12345678900"
            },
            {
                "key": "creditParty.name",
                "value": "celcoin"
            }
        ]
    }
		}
	},
	"entity": "launch-out"
}

Exemplo de webhook - "entity": "launch-in

{
	"tenantId": "**PRIVATE**",
	"body": {
		"Status": "CONFIRMED",
		"Entity": "launch-in",
		"CreateTimestamp": "2025-06-17T12:41:59.1483289",
		"Body": {
			"Account": "30023646094074",
			"Description": "Rendimento teste postman",
			"Branch": "0001",
			"Amount": 0.01,
			"currentBalance": 5099505.78,
			"oldBalance": 5099505.77,
			"Id": "78ce36c1-ccd3-430f-95fe-ca2cf725191b",
			"TaxId": "66877376781",
           "launchType": "PIXPAYMENTOUT",
        "tags": [
            {
                "key": "clientCode",
                "value": "123456"
            },
            {
                "key": "amount",
                "value": "0.1"
            },
            {
                "key": "creditParty.bank",
                "value": "123456"
            },
            {
                "key": "creditParty.name",
                "value": "celcoin"
            }
        ]
    }
		}
	},
	"entity": "launch-in"
}

Updated about 5 hours ago

Did this page help you?