Consultar Transações do Extrato

Essa funcionalidade permite que os clientes da Celcoin consigam realizar a consulta de qualquer transações que conste no extrato de uma conta BaaS de seus cliente.

Passos para Integrar

Realizar autenticação na API - [API Reference]
Realiza a consulta na API - [Reference]

Fluxo de integração

Consultar Extrato

Você pode realizar a busca das transações pelos seguintes parâmetros :

id (Identificador da transação retornado na requisição de payment.)
clientCode (Identificador único gerado pelo cliente.)
endToEndId (Identificador ponta-a-ponta associado ao pagamento.)
returnIdentification (Identificador ponta-a-ponta associado a devolução pix.)

cURL da chamada

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/status?endToEndId=E13935893202410101813C8vLsJjsJTm&movementType=PIXPAYMENTOUT' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {token}'

Tipos de Movimentação Disponível

movementType	Descrição
PIXPAYMENTIN	Credito referente a um cash-in Pix
PIXPAYMENTOUT	Debito referente a um cash-out Pix
PIXREVERSALOUT	Movimentação referente a um Pix Reversal Out
PIXREVERSALIN	Movimentação referente a um Pix Reversal In
TEFTRANSFERIN	Credito referente a um cash-in de transferência interna
TEFTRANSFEROUT	Debito referente a um cash-out de transferência interna
TEDTRANSFERIN	Credito referente a um cash-in de TED
TEDTRANSFEROUT	Debito referente a um cash-out de TED
TEDREVERSALOUT	Movimentação referente a um TED Reversal out
TEDREVERSALIN	Movimentação referente a um TED Reversal In

Exemplo de retorno

👍
Sucesso 200

movementType -> PIXPAYMENTIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "50de3664-02b6-46f2-b316-b56a1fa35256",
        "createDate": "2024-10-10T15:13:18",
        "confirmationDate": "2024-10-10T15:13:21",
        "amount": 4.0000,
        "status": "Saldo Liberado",
        "balanceType": 2,
        "movementType": "PIXPAYMENTIN",
        "nameDebit": "Jasmine O'Kon",
        "nameCredit": "Enrique Graham",
        "accountDebit": "3005406551115",
        "accountCredit": "3005406551255",
        "endToEndId": "E13935893202410101813C8vLsJjsJTm"
    }
}

movementType -> PIXPAYMENTOUT

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "5819abfb-5dbb-4520-b34e-1d31049cb7c3",
        "clientCode": "xxaaaa1ax2szdaasasa9353aadaasda45382a09",
        "description": "pix",
        "createDate": "2024-10-07T09:00:15",
        "confirmationDate": "2024-10-07T09:00:29",
        "amount": 5.0000,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "PIXPAYMENTOUT",
        "nameDebit": "Margaret Gusikowski",
        "nameCredit": "Enrique Graham",
        "accountDebit": "3005406551115",
        "accountCredit": "30023646094934",
        "endToEndId": "E13935893202410071157zAeqzBHO7vF"
    }
}

movementType -> PIXREVERSALOUT

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "f9a15a64-8b9b-4189-95d1-3c64abdd2c01",
        "clientCode": "73053a6c-3e37-4110-ad6d-d08a67a6c0d0",
        "description": "pixReversal",
        "createDate": "2024-07-26T10:40:38",
        "confirmationDate": "2024-07-26T10:40:42",
        "amount": 0.0100,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "PIXREVERSALOUT",
        "nameDebit": "Dana Wisoky",
        "nameCredit": "IS2B  Integrated Solutions to Business SA",
        "accountDebit": "100539627",
        "accountCredit": "30023646056255",
        "reasonDevolution": "BE08",
        "returnIdentification": "D13935893202407261340onfm1P69Lcj",
        "originalEndToEndId": "E13935893202407261209kZltnNXGElW"
    }
}

movementType -> PIXREVERSALIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "4743d191-54b0-11ed-99d8-49447a988cf3",
        "clientCode": "dfdgfd1213213",
        "createDate": "2022-10-20T19:30:04",
        "confirmationDate": "2022-10-20T19:30:04",
        "amount": 1.1000,
        "status": "Saldo Liberado",
        "balanceType": 2,
        "movementType": "PIXREVERSALIN",
        "nameDebit": "Davi Ferreira de Sousa",
        "nameCredit": "Lucas Martins Rodrigues",
        "accountDebit": "300539061378",
        "accountCredit": "42161",
        "reasonDevolution": "MD06",
        "returnIdentification": "D0000000020221020213438075664721",
        "originalEndToEndId": "E1393589320221020201201966385353"
    }
}

movementType -> TEFTRANSFERIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "280a6fea-f7f8-462f-84a2-8180ed1afd2f",
        "clientCode": "658f-33d7-4ff3-97d2-4ba27cc72a27",
        "description": "Transferencia interna",
        "createDate": "2024-10-15T08:13:23",
        "confirmationDate": "2024-10-15T08:13:28",
        "amount": 1.0000,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "TEFTRANSFERIN",
        "nameDebit": "Enrique Graham",
        "nameCredit": "Jasmine O'Kon",
        "accountDebit": "3005406551115",
        "accountCredit": "3005406551255",
        "endToEndId": "d6b26511-b745-4089-90e0-376149ecb897"
    }
}

movementType -> TEFTRANSFEROUT

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "280a6fea-f7f8-462f-84a2-8180ed1afd2f",
        "clientCode": "658f-33d7-4ff3-97d2-4ba27cc72a27",
        "description": "Transferencia interna",
        "createDate": "2024-10-15T08:13:23",
        "confirmationDate": "2024-10-15T08:13:28",
        "amount": 1.0000,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "TEFTRANSFEROUT",
        "nameDebit": "Enrique Graham",
        "nameCredit": "Jasmine O'Kon",
        "accountDebit": "3005406551115",
        "accountCredit": "3005406551255",
        "endToEndId": "d6b26511-b745-4089-90e0-376149ecb897"
    }
}

movementType -> TEDTRANSFEROUT

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "11c57da4-6fd8-4ec3-9b89-87a2712c2f77",
        "clientCode": "d6669fb0-c5d6-4566-bdb8-549ab1419499",
        "createDate": "2024-08-28T15:37:51",
        "confirmationDate": "2024-08-28T15:38:40",
        "amount": 0.0100,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "TEDTRANSFEROUT",
        "nameDebit": "Ms. Otis Schimmel",
        "nameCredit": "Brooke Kuphal",
        "accountDebit": "300539137269",
        "accountCredit": "43778",
        "numCtrlSTR": "STR20240828033080063",
        "typeMessage": "STR0008"
    }
}

movementType -> TEDTRANSFERIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "11c57da4-6fd8-4ec3-9b89-87a2712c2f77",
        "clientCode": "d6669fb0-c5d6-4566-bdb8-549ab1419499",
        "createDate": "2024-08-28T15:37:51",
        "confirmationDate": "2024-08-28T15:38:40",
        "amount": 0.0100,
        "status": "Saldo Liberado",
        "balanceType": 1,
        "movementType": "TEDTRANSFERIN",
        "nameDebit": "Ms. Otis Schimmel",
        "nameCredit": "Brooke Kuphal",
        "accountDebit": "300539137269",
        "accountCredit": "43778",
        "numCtrlSTR": "STR20240828033080063",
        "typeMessage": "STR0008"
    }
}

movementType -> TEDREVERSALIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "22c68847-e3e8-4310-9970-a1caed76a9bb",
        "description": "SPB Cashin Notification",
        "createDate": "2023-11-22T15:25:08",
        "confirmationDate": "2023-11-22T15:25:08",
        "amount": 2.0000,
        "status": "Saldo Liberado",
        "balanceType": 2,
        "movementType": "TEDREVERSALIN",
        "nameDebit": "Irma Purdy",
        "nameCredit": "Davi Ferreira de Sousa",
        "accountDebit": "30023646053435",
        "accountCredit": "42161",
        "reasonDevolution": "Verificar informações de creditado.",
        "numCtrlSTR": "STR20231122033837907",
        "reason": "Verificar informações de creditado."
    }
}

movementType -> TEDTRANSFERIN

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "22c68847-e3e8-4310-9970-a1caed76a9bb",
        "description": "SPB Cashin Notification",
        "createDate": "2023-11-22T15:25:08",
        "confirmationDate": "2023-11-22T15:25:08",
        "amount": 2.0000,
        "status": "Saldo Liberado",
        "balanceType": 2,
        "movementType": "TEDREVERSALOUT",
        "nameDebit": "Irma Purdy",
        "nameCredit": "Davi Ferreira de Sousa",
        "accountDebit": "30023646053435",
        "accountCredit": "42161",
        "reasonDevolution": "Verificar informações de creditado.",
        "numCtrlSTR": "STR20231122033837907",
        "reason": "Verificar informações de creditado."
    }
}

❗
Error 400

{
  "status": "ERROR",
  "version": "1.0.0",
  "error": {
    "errorCode": "CBE540",
    "message": "É necessário informar pelo menos um dos campos: id, clientCode, ou returnIdentification."
  }
}

Tabela de errorCode

Code	Message
CBE540	É necessário informar pelo menos um dos campos: id, clientCode, ou returnIdentification.
CBE332	ClientCode possui tamanho maximo de 200 caractere
CBE542	endToEndId possui tamanho maximo de 50 caracteres.
CBE543	ReturnIdentification possui tamanho maximo de 200 caracteres
CBE422	MovmentType é inválido
CBE106	Não encontramos nenhuma transação através do parâmetro informado.
CBE149	É necessário informar pelo menos um dos campos: id, ou clientCode.
CBE329	É necessário informar pelo menos um dos campos: id , clientrequestid ou endToEndId.
CBE437	movementType inválido.

Consultar Transações do Extrato

Passos para Integrar

Fluxo de integração

Consultar Extrato

👍
Sucesso 200

❗
Error 400

Passos para Integrar

Fluxo de integração

Consultar Extrato

👍Sucesso 200

❗Error 400

👍
Sucesso 200

❗
Error 400