Sign in

v1

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

List all payment transactions

List all payment transactions associated with your Belvo account.

get/payments/br/transactions/

Query parameters

pageinteger
Example:1

A page number within the paginated result set.

page_sizeinteger
Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

id__instring[]

Return information for these resource ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]
created_atstring date
Example:2022-05-05

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

created_at__gtstring date
Example:2022-05-05

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

created_at__gtestring date
Example:2022-05-04

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

created_at__ltstring date
Example:2022-04-01

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

created_at__ltestring date
Example:2022-03-30

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]
chargestring uuid
Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The charge.id you want to get results for.

charge__instring[]

One or more charge.ids that you want to get results for.

[
  "2f122ae2-fc09-4c6d-9940-b6220e8d191d"
]
beneficiarystring uuid
Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The beneficiary.id you want to get results for.

beneficiary__instring[]

One or more beneficiary.ids that you want to get results for.

[
  "ee43f030-4feb-4a06-95e7-d8d8afe5b16e"
]
payerstring uuid
Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The payer's bank-account.id you want to get results for.

payer__instring[]

One or more payer bank-account.ids that you want to get results for.

[
  "901bc024-be57-4972-b4cf-31664b369d6e"
]
customerstring uuid
Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The customer.id you want to get results for.

customer__instring[]

One or more customer.ids that you want to get results for.

[
  "cb320adc-9a6b-4224-933a-5b08cf771ac7"
]
payment_intentstring uuid
Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The payment-intent.id you want to get results for.

payment_intent__instring[]

One or more payment-intent.ids that you want to get results for.

[
  "cb320adc-9a6b-4224-933a-5b08cf771ac7"
]
transaction__type'INFLOW' | 'OUTFLOW'
Example:INFLOW

Return results for this transaction type. Can be either INFLOW or OUTFLOW.

currencystring
Example:BRA

Return results that hold finances or balances in only this three-letter currency code.

descriptionstring
Example:Training shoes

Return results for items with this description.

amountnumber float
Example:1000.02

Return results only for this value.

amount__gtnumber float
Example:1000.02

Return results only for more than this amount.

amount__gtenumber float
Example:1000.02

Return results only for and more than this amount.

amount__ltnumber float
Example:1000.02

Return results only for less than this amount.

amount__ltenumber float
Example:1000.02

Return results only for this amount or less.

amount__rangenumber[]

Return results between this amount range. The first value indicates the start of the range and the second value indicates the end of the range.

[
  100,
  5000
]

Response

OK

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "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"
    }
  ]
}