Consultar tipos de lançamento

O cliente poderá consultar a lista completa dos lançamento cadastrados.

Essa funcionalidade ajuda o cliente a validar previamente quais tipos de lançamentos estão disponíveis, garantindo uso correto da API e prevenindo erros de integração

Passos para integrar

Realizar autenticação na API - [API Reference]
Consultar tipos de lançamentos cadastrados -

Detalhes do Request

Campo	Descrição	Tipo Campo	Exemplo
clientId	Identificador do cliente	int	001
launchType	Tipo de lançamento	string	PIXPAYMENTIN
type	Tipo do lançamento	string	DEBIT ou CREDIT
status	Se está Ativo ou Inativo	booleano	TRUE ou FALSE

Caso nenhum parâmetro seja informado, serão retornados todos os tipos de lançamentos cadastrados.

cURL da Chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/webhook/subscription' \
--header 'Authorization: Bearer {{token}}'

Exemplo de retorno

👍
Sucesso 200

{
    "status": "SUCCESS",
    "version": "1.0.0",
    "body": {
        "client": {
            "name": "Baas",
            "clienteId": 296,
            "localId": 23646
        },
        "launchList": [
            {
                "launchType": "PIXPAYMENTIN",
                "type": "CREDIT",
                "ativo": true,
                "tags": [
                    {
                        "key": "clientCode",
                        "value": "123456"
                    },
                    {
                        "key": "amount",
                        "value": "0.1"
                    },
                    {
                        "key": "endToEndId",
                        "value": "EDF838-404939393"
                    },
                    {
                        "key": "debitParty.bank",
                        "value": "123456"
                    },
                    {
                        "key": "debitParty.account",
                        "value": "468"
                    },
                    {
                        "key": "debitParty.branch",
                        "value": "0001"
                    },
                    {
                        "key": "debitParty.taxId",
                        "value": "12345678900"
                    },
                    {
                        "key": "debitParty.name",
                        "value": "celcoin"
                    }
                ],
                "createdDate": null,
                "updateDate": null
            },
            {
                "launchType": "PIXPAYMENTOUTTESTES",
                "type": "DEBIT",
                "ativo": true,
                "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"
                    }
                ],
                "createdDate": "2025-10-06T14:38:50.639Z",
                "updateDate": "2025-10-07T13:13:54.621Z"
            }
        ]
    }
}

❗
Error 400

{
    "status": "ERROR",
    "version": "1.0.0",
    "error": {
        "errorCode": "CBE661",
        "message": "A consulta não retornou resultados."
    }
}

Tabela de errorCode

Code	Message
CBE663	LaunchType não encontrado ou com status igual ao informado.
CBE239	Não foi possivel recuperar os dados do cliente para busca do JWT.
CBE210	Cliente não esta ativo para utilizar a Api.
CBE215	Operação não permitida para Virtual BaaS.
CBE661	A consulta não retornou resultados..
CBE660	LaunchType inválido ou nulo.
CBE659	Existem tags com keys duplicadas.
CBE101	O 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..
CBE658	Esse tipo de lançamento não está mais ativo.