Fetch Transactions

Associated with an account

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

fsi-transactions:read

Body Response - Schema

200 (the transactions list)

ParameterTypeDescriptionRequired
_embeddedobject"_embedded" subdivides into:

1 - "transactions" (array[object]) - list of account's transactions. Required.
1.1 - "id" (string) - transaction's ID. Required.
1.2 - "description" (string) - brief description for a transaction. Required.
1.3 - "value" (object) - a tuple with value and currency.
1.3.1 - "value" (string) - a value associated with a currency. Required.
1.3.2 - "currency" (string) - use currency code ISO 4217.

> = 3 characters
> <= 3 characters. Required.
> 1.4 - "booked_at" (string) -transaction's book date.
> 1.5 - "value_at" (string) -transaction's value date. Required.
> 1.6 - "status" (string) - allowed values:
> "UNDEFINED", "PENDING", "BOOKED",
> "POSTED".
> 1.7 - "type" (string) - allowed values:
> "UNDEFINED", "CREDIT_CARD", "PAYMENT", "WITHDRAWAL", "DEFAULT", "TRANSFER",
> "ADD_ON", "DEPOSIT",
> "PURCHASE", "OTHER". Required.
> 1.8 - "flow" (string) - transaction's flow - either a debit or a credit in an account. Allowed values:
> "CREDIT", "DEBIT". Required.
> 1.9 - "custom_type" (string) - transaction type customized by bank client.
> 1.10 - "custom_status" (string) - transaction status customized by bank client.
yes
totalintegertotal number of itemsyes

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The FSI Integrations API has been in General Availability since January 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!