Skip to main content
POST
/
api
/
service
/
transaction
/
list
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const transactions = await client.transactions.list({ from: 0, to: 0 });

console.log(transactions.data);
{
  "data": [
    {
      "id": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "creditor": {
        "iban": {
          "iban": "<string>",
          "accountHolderName": "<string>",
          "bic": "<string>"
        },
        "sortCode": {
          "sortCode": "<string>",
          "accountNumber": "<string>",
          "accountHolderName": "<string>"
        },
        "bankCode": {
          "accountNumber": "<string>",
          "code": "<string>",
          "accountHolderName": "<string>"
        },
        "bban": {
          "bban": "<string>",
          "accountHolderName": "<string>",
          "bic": "<string>"
        },
        "wallet": {
          "address": "<string>"
        }
      },
      "debtor": {
        "iban": {
          "iban": "<string>",
          "accountHolderName": "<string>",
          "bic": "<string>"
        },
        "sortCode": {
          "sortCode": "<string>",
          "accountNumber": "<string>",
          "accountHolderName": "<string>"
        },
        "bankCode": {
          "accountNumber": "<string>",
          "code": "<string>",
          "accountHolderName": "<string>"
        },
        "bban": {
          "bban": "<string>",
          "accountHolderName": "<string>",
          "bic": "<string>"
        },
        "wallet": {
          "address": "<string>"
        }
      },
      "balance": {
        "before": "<string>",
        "after": "<string>"
      },
      "bankStatementReference": "<string>",
      "transactionDate": 123,
      "paymentProcessId": "<string>"
    }
  ],
  "paging": {
    "hasNext": true,
    "nextCursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
from
number
required

Start timestamp (inclusive) - unix timestamp

​
to
number
required

End timestamp (exclusive) - unix timestamp

​
accountId
string<uuid>

Account Id to fetch transactions for. Optional, is not specified - transactions for the default accounts will be returned

​
afterCursor
string

Cursor for pagination

Minimum string length: 1

Response

200 - application/json

The list of transactions

​
data
object[]
required

Array of transactions

​
paging
object
required

Pagination information