Transaction (OFPI) Model and States

Reference information regarding the Transaction resource (Payments Brazil).

Transaction Model

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
  "amount": "1020.00",
  "currency": "BRL",
  "description": "Training shoes",
  "transaction_type": "INFLOW",
  "beneficiary": "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc",
  "payment_intent": "004a28bb-fac2-4172-884b-5b6ea15314ad",
  "customer": "9eebd63b-3339-44a9-8a5a-72bb6cb2f310"
}
ParameterTypeDescriptionExample
idstringBelvo's unique identifier for the current item.0d3ffb69-f83b-456e-ad8e-208d0998d71d
created_atstringThe ISO-8601 timestamp of when the data point was created in Belvo's database.2022-02-09T08:45:50.406032Z
created_bystringThe unique ID for the user that created this item.bcef7f35-67f2-4b19-b009-cb38795faf09
amountstringThe transaction amount.

> Note: The amount displayed is always positive as we indicate the direction of the transaction in transaction_type parameter.
1020.00
currencystringThe currency of the amount paid, for example, BRL (Brazilian Real).BRL
descriptionstringThe description of the payment.Training shoes
transaction_typestringThe direction of the transaction.

- INFLOW indicates money coming into the account.
- OUTFLOW indicates money coming out of the account.
INFLOW
beneficiarystringBelvo's unique ID used to identify the beneficiary's bank account.a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
payment_intentstringThe unique ID of the payment intent associated with the transaction.004a28bb-fac2-4172-884b-5b6ea15314ad
customerstringBelvo's unique ID for the customer associated with this transaction.9eebd63b-3339-44a9-8a5a-72bb6cb2f310