Transações

Todos os tipos de movimentações realizados na API de BaaS são feitos a partir do objeto transaction.

Com esse objeto Pix, Boleto, TED (Transferência Eletrônica Disponível), Cartão pré-pago, Cartão de crédito e Pagamento de contas possuem a mesma estrutura.

Veja a estrutura básica de uma transação:

{
  "id": "integer",
  "account_id": "integer",
  "wallet_slug": "string",
  "value": "integer",
  "side": "string",
  "status": "string",
  "category": "string",
  "created_at": "string",
  "updated_at": "string",
  "payment_method": "string",
  "description": "string",
  "operation_id": "string",
  "custom_id": "string",
  "uuid": "string",
  "metadata": {
    ...
  }
}

Campos

Para entender melhor o que cada campo significa consulte a tabela abaixo:


id	id da operação.	-
account_id	id da conta.	-
wallet_slug	Carteira que foi feita a transação.	-
value	Valor da operação, medido em centavos de real (valor x 100).	Formatação padrão da API de BaaS.
side	Indica se a operação é de entrada (cash-in) ou de saída (cash-out).	`credit` -Entrada/Cash-in. `debit` - Saída/Cash-out.
status	O campo `status` indica a situação da transação.	`approved` - Operação aprovada. `pending` - Operação aguardando definição. `denied` - Operação negada.
category	Indica o tipo de transação que foi feita.	Lista das possíveis categorias.
payment_method	Indica o método de pagamento utilizado para realizar a transação.	Lista dos possíveis métodos de pagamento.
created_at	Data de criação da operação.	-
updated_at	Data da ultima alteração de status.	-
description	Mensagem do usuário.	-
operation_id	Identificador da operação. Agrupa transações relacionadas p.ex. transferências internas, fees, extornos, etc...	-
custom_id	Identificador customizavel para parceiros.	Pode ser usado qualquer tipo de caractere.
uuid	Identificador único da transação.	-
metadata	O campo `metadata` representa algumas informações que são sensíveis ao tipo da transação. Nele são disponibilizadas informações adicionais de cada metodo de pagamento.	Lista dos possíveis preenchimentos do metadata.

Método de Pagamento

O campo payment_method indica o método de pagamento utilizado para realizar a transação. Os valores possíveis são:

Campo	Descrição
`CONTA`	Valor saiu ou entrou por uma conta da aplicação.
`BOLETO`	Valor entrou na conta por um Boleto.
`PREPAID_CARD`	Valor saiu ou entrou por um Cartão pré-pago.
`CREDIT_CARD`	Valor foi pago utilizando um Cartão de crédito.
`TED`	Valor foi pago ou recebido via TED.
`PIX`	Valor foi pago ou recebido via Pix.

Categorias

❕
Cada categoria está atrelada a um ou mais possíveis métodos de pagamento.

`Category`	Descrição	`payment_method`
`BILL_PAYMENT`	Pagamento de contas.	`CONTA`
`EXTERNAL_TRANSFER`	Transferência externa.	`TED` ou `PIX`
`EXTERNAL_CHARGEBACK`	Recebimento de estorno/devolução que foi emitido externo a aplicação (quando uma compra de cartão é estornada ou um Pix é devolvido.	`PREPAID_CARD` ou `PIX`
`EXTERNAL_PURCHASE`	Compra realizada externa a aplicação (tipicamente uma compra com Cartão pré-pago).	`PREPAID_CARD`
`EXTERNAL_PURCHASE_CANCEL`	Cancelamento de uma `EXTERNAL_PURCHASE` (quando a compra no cartão é cancelada antes de ser liquidada).	`PREPAID_CARD`
`FEE`	Taxa por uma `transaction` (por exemplo, a taxa cobrada por uma operação de `TED`).	`CONTA`
`INTERNAL_TRANSFER`	Transferência interna entre contas da sua aplicação.	`CONTA`
`RECEIVAL`	Recebimento de fora da aplicação.	`TED` ou `PIX`
`RECHARGE`	Recarga na conta via Boleto.	`BOLETO`
`SENDBACK`	Devolução Pix iniciada pelo usuário.	`PIX`
`WALLET_TRANSFER`	Transferência entre duas `wallets` de uma `account`.	`CONTA`

Metadata

Informações sensíveis adicionais a cada método de pagamento:

Boleto

BILL_PAYMENT

{
  "fine_value": "integer",
  "interest_value": "integer",
  "discount_value": "integer",
  "original_value": "integer",
  "due_date": "string",
  "schedule_to": "string",
  "writable_line": "string",
  "bill_type": "string"
}

RECHARGE

{
  "fee": "integer",
  "writable_line": "string",
  "barcode_number": "string",
  "due_date": "string"
}

Pix

RECEIVAL

{
  "bank_code": "string",
  "agency_number": "string",
  "number": "string",
  "charge_id": "integer",
  "holder": {
    "name": "string",
    "document_type": "string",
    "document": "string"
  },
  "bank_ispb": "string",
  "Pix_key": "string",
  "end_to_end_id": "string",
  "identification": "string"
}

EXTERNAL_TRANSFER

{
  "bank_code": "string",
  "agency_number": "string",
  "number": "string",
  "holder": {
    "name": "string",
    "document_type": "string",
    "document": "string"
  },
  "bank_ispb": "string",
  "Pix_key": "string",
  "initiation_method": "string",
  "end_to_end_id": "string",
  "identification": "string"
}

SENDBACK

{
  "end_to_end_id": "string",
  "original_transaction_id": "integer"
}

EXTERNAL_CHARGEBACK

{
  "original_transaction_id": "integer"
}

TED

EXTERNAL_TRANSFER

{
  "bank_code": "string",
  "agency_number": "string",
  "number": "string",
  "holder": {
    "name": "string",
    "document_type": "string",
    "document": "string"
  }
}

Transferência Interna

INTERNAL_TRANSFER

{
  "credit": {
    "account_id": "string",
    "account_name": "string",
    "wallet_slug": "string"
  },
  "debit": {
    "account_id": "string",
    "account_name": "string",
    "wallet_slug": "string"
  }
}

Cartão pré-pago

EXTERNAL_PURCHASE

{
  "prepaid_card_id": "integer",
  "establishment": {
    "name": "string",
    "mcc": "string",
    "city": "string"
  }
}

EXTERNAL_PURCHASE_CANCEL

{
  "prepaid_card_id": "integer",
  "original_transaction_id": "integer"
}

EXTERNAL_CHARGEBACK

{
  "prepaid_card_id": "integer",
  "original_transaction_id": "integer"
}

Campos

Método de Pagamento

Categorias

❕Cada categoria está atrelada a um ou mais possíveis métodos de pagamento.

Metadata

Boleto

Pix

TED

Transferência Interna

Cartão pré-pago

❕
Cada categoria está atrelada a um ou mais possíveis métodos de pagamento.