Eventos

Bem-vindo à seção de eventos da API. Aqui você encontrará todos os endpoints relacionados ao gerenciamento de eventos do sistema.

Create Event Transaction

Endpoint utilizado para criar um novo evento de transação no sistema.

POST {{apiUrl}}/events/transactions/create

Headers da requisição

Header	Obrigatório	Valor	Descrição
Accept	Sim	application/json	Formato de resposta aceito
Content-Type	Sim	application/json	Formato do corpo da requisição
Authorization	Sim	Bearer token	Token de autenticação

Parâmetros da requisição

O corpo da requisição deve ser enviado no formato JSON com os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
p2pInfo	object	Sim	Objeto contendo informações do pagador e beneficiário
p2pInfo.payerTaxIdentifier	string	Sim	CPF/CNPJ do pagador
p2pInfo.payerPaymentAccountType	number	Sim	Tipo da conta do pagador
p2pInfo.payeeTaxIdentifier	string	Sim	CPF/CNPJ do beneficiário
p2pInfo.payeePaymentAccountType	number	Sim	Tipo da conta do beneficiário
amount	number	Sim	Valor da transação
type	number	Sim	Tipo do evento de transação
description	string	Sim	Descrição da transação

Exemplo de requisição

Request Body

{
  "p2pInfo": {
    "payerTaxIdentifier": "14351023000161",
    "payerPaymentAccountType": 1,
    "payeeTaxIdentifier": "27563518323",
    "payeePaymentAccountType": 1
  },
  "amount": 0.10,
  "type": 1,
  "description": "Pagamento de parcela teste"
}

Resposta

Em caso de sucesso, o servidor retornará um status code 200 OK com os seguintes dados:

Response 200 OK

{
  "id": "042df7f5-5995-41ed-b038-fa2af988556d"
}

Campo	Tipo	Descrição
id	string	Identificador único do evento de transação criado

Get Event Transaction Status

Endpoint utilizado para consultar o status de um evento de transação no sistema.

Endpoint

POST {{apiUrl}}/events/transactions/consult

Headers da requisição

Header	Obrigatório	Valor	Descrição
Accept	Sim	application/json	Formato de resposta aceito
Content-Type	Sim	application/json	Formato do corpo da requisição
Authorization	Sim	Bearer token	Token de autenticação

Parâmetros da requisição

O corpo da requisição deve ser enviado no formato JSON com os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador da transação que deseja consultar

Exemplo de requisição

Request Body

{
  "id": "{{EVENT_TRANSACTION_ID}}"
}

Resposta

Todas as respostas retornam status code 200 OK. O campo status do evento pode assumir os valores EXECUTED, PROCESSING ou EXECUTION_ERROR. Em caso de falha (EXECUTION_ERROR), o campo descriptionError traz o detalhe do erro e o campo errorCode contém o código do erro.

Status EXECUTED

Transação concluída com sucesso:

Response 200 OK - EXECUTED

{
  "event": {
    "id": "042df7f5-5995-41ed-b038-fa2af988556d",
    "status": "EXECUTED",
    "createdAt": "2025-04-07T22:52:47.051Z",
    "updatedAt": "2025-04-07T22:52:50.804Z"
  },
  "transaction": {
    "status": "EXECUTED",
    "amount": 0.1,
    "transactionAt": "2025-04-07T22:52:50.796Z",
    "description": "Pagamento de parcela teste",
    "transactionType": "P2P",
    "payerTaxIdentifier": "14351023000161",
    "payerPaymentAccountType": "ACCOUNT",
    "payeeTaxIdentifier": "27563518323",
    "payeePaymentAccountType": "ACCOUNT"
  }
}

Status PROCESSING

Transação ainda em processamento:

Response 200 OK - PROCESSING

{
  "event": {
    "id": "042df7f5-5995-41ed-b038-fa2af988556d",
    "status": "PROCESSING",
    "createdAt": "2025-04-07T22:52:47.051Z",
    "updatedAt": "2025-04-07T22:52:48.100Z"
  },
  "transaction": {
    "status": "PENDING_COREBANK",
    "amount": 0.1,
    "transactionAt": "2025-04-07T22:52:50.796Z",
    "description": "Pagamento de parcela teste",
    "transactionType": "P2P",
    "payerTaxIdentifier": "14351023000161",
    "payerPaymentAccountType": "ACCOUNT",
    "payeeTaxIdentifier": "27563518323",
    "payeePaymentAccountType": "ACCOUNT"
  }
}

Status EXECUTION_ERROR

Falha na execução da transação. O campo descriptionError contém o detalhe do erro e o campo errorCode contém o código do erro:

Response 200 OK - EXECUTION_ERROR

{
  "event": {
    "id": "042df7f5-5995-41ed-b038-fa2af988556d",
    "status": "EXECUTION_ERROR",
    "descriptionError": "Saldo insuficiente para realizar a transação",
    "errorCode": "event_transaction_cannot_be_executed",
    "createdAt": "2025-04-07T22:52:47.051Z",
    "updatedAt": "2025-04-07T22:52:50.804Z"
  },
  "transaction": {
    "status": "EXECUTION_ERROR",
    "amount": 0.1,
    "transactionAt": "2025-04-07T22:52:50.796Z",
    "description": "Pagamento de parcela teste",
    "transactionType": "P2P",
    "payerTaxIdentifier": "14351023000161",
    "payerPaymentAccountType": "ACCOUNT",
    "payeeTaxIdentifier": "27563518323",
    "payeePaymentAccountType": "ACCOUNT"
  }
}

Dados de Mock para Homologação

Em ambiente de homologação, é possível simular diferentes cenários utilizando os seguintes CPF/CNPJ como payeeTaxIdentifier (beneficiário) na criação do evento. Ao consultar o status do evento, o sistema retornará respostas mockadas conforme a tabela abaixo:

Tax ID (Beneficiário)	Status do Evento	Status da Transação	Error Code
84284250604	CREATED	PENDING_CORE_BANK	-
33781503780	PROCESSING	PENDING_CORE_BANK	-
86258863450	EXECUTED	EXECUTED	-
15210776140	EXECUTION_ERROR	FAILED	event_transaction_cannot_be_executed
70685213633	EXECUTION_ERROR	FAILED	payment_account_not_found
70347358241	EXECUTION_ERROR	FAILED	user_not_found
87355118501	EXECUTION_ERROR	FAILED	account_not_found
38152747297	EXECUTION_ERROR	FAILED	internal_transfer_details_not_found
85282751321	EXECUTION_ERROR	FAILED	target_payment_account_not_found
78688372000140	EXECUTION_ERROR	FAILED	internal_transfer_not_created_celcoin
08463704000102	EXECUTION_ERROR	FAILED	internal_transfer_not_created

Nota: Utilize um dos CPF/CNPJ acima como payeeTaxIdentifier ao criar o evento. Ao consultar o status do evento criado, o sistema retornará a resposta mockada correspondente ao tax_id utilizado.

Campos da resposta

Event

Campo	Tipo	Descrição
id	string	Identificador único do evento
status	string	Status do evento: `EXECUTED`, `PROCESSING` ou `EXECUTION_ERROR`
descriptionError	string	Detalhe do erro (preenchido apenas quando status é `EXECUTION_ERROR`)
errorCode	string	Código do erro (preenchido apenas quando status é `EXECUTION_ERROR`)
createdAt	string	Data de criação do evento
updatedAt	string	Data da última atualização do evento

Transaction

Campo	Tipo	Descrição
status	string	Status da transação
amount	number	Valor da transação
transactionAt	string	Data e hora da transação
description	string	Descrição da transação
transactionType	string	Tipo da transação (ex: P2P)
payerTaxIdentifier	string	CPF/CNPJ do pagador
payerPaymentAccountType	string	Tipo da conta do pagador
payeeTaxIdentifier	string	CPF/CNPJ do beneficiário
payeePaymentAccountType	string	Tipo da conta do beneficiário