Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Payment Transactions (Brazil)

Get details about a payment transaction

Get the details about a specific payment transaction.

get/payments/br/transactions/{id}/

Path parameters

idstring uuid required
Example:a3b92311-1888-449f-acaa-49ae28d68fcd

The transaction.id you want to get detailed information about.

Response

OK

idstring uuid required

Belvo's unique identifier for the current item.

created_atstring date-time required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

created_bystring uuid required

The unique ID for the user that created this item.

amountstring required

The transaction amount.

Note: The amount displayed is always positive as we indicate the direction of the transaction in transaction_type parameter.

currency'BRL' required

The currency of the amount paid, for example, BRL (Brazilian Real).

descriptionstring required

The description of the payment.

transaction_type'INFLOW' | 'OUTFLOW' required

The direction of the transaction.

  • INFLOW indicates money coming into the account.
  • OUTFLOW indicates money coming out of the account.
beneficiarystring uuid required

Belvo's unique ID used to identify the beneficiary's bank account.

{"stackTrail":"components:schemas:paymentTransaction:properties:payer","oasType":"schema","type":"unknown","description":"**Note**: For OFPI, this will return an empty object `{}`.\n"}
payment_intentstring uuid

The unique ID of the payment intent associated with the transaction.

customerstring uuid

Belvo's unique ID for the customer asscociated with this transaction.

Example response

{
  "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"
}