Get transaction information

You can query information about a single transaction and multiple transactions using the API. Transaction information is also available on Dashboard > Data > Transactions.

Prerequisites

You need a project access token run these queries.

Multiple transactions

Get information about multiple transactions using the API. This sample queries the project's Booked transactions.

1. Call the transactions query.
2. Add all the information you'd like to review.
   • The sample query uses several transactions query options, including filtering for only Booked transactions and adding the transaction type (line 2).
   • It also exposes the creditors' full IBANs and BICs for SEPA Credit Transfers (lines 19-23).
   • Confirm whether a transaction statement can be generated (line 26).
3. Add optional messages to the success payload, either for validation or in case of rejection.
   • The sample query adds a more thorough Booked payload.

Query

🔎 Open the query in API Explorer

query BookedTransactions {
  transactions(filters: { status: Booked }) {
    edges {
      node {
        amount {
          currency
          value
        }
        statusInfo {
          status
          ... on BookedTransactionStatusInfo {
            __typename
            bookingDate
            status
            valueDate
          }
        }
        type
        ... on SEPACreditTransferTransaction {
          creditor {
            BIC
            IBAN
            maskedIBAN
          }
        }
        statementCanBeGenerated
      }
    }
    totalCount
  }
}

Payload

Review all Booked transactions for your project, the type of transaction, and the BIC and IBAN for all creditors. Confirm whether a transaction is eligible for a transaction statement

{
  "data": {
    "transactions": {
      "edges": [
        {
          "node": {
            "amount": {
              "currency": "EUR",
              "value": "22.00"
            },
            "statusInfo": {
              "status": "Booked",
              "__typename": "BookedTransactionStatusInfo",
              "bookingDate": "2024-01-25T18:27:27.987Z",
              "valueDate": "2024-01-25T18:27:27.987Z"
            },
            "type": "SepaInstantCreditTransferIn",
            "creditor": {
              "BIC": "SWNBFR22",
              "IBAN": "FR7699999001001510219788187",
              "maskedIBAN": "FR7699999001001510******187"
            },
            "statementCanBeGenerated": true
          }
        },
        {
          "node": {
            "amount": {
              "currency": "EUR",
              "value": "15.00"
            },
            "statusInfo": {
              "status": "Booked",
              "__typename": "BookedTransactionStatusInfo",
              "bookingDate": "2024-01-25T18:25:16.415Z",
              "valueDate": "2024-01-25T18:25:16.415Z"
            },
            "type": "SepaCreditTransferOutReturn",
            "creditor": {
              "BIC": "SWNBFR22",
              "IBAN": "FR7699999001001510219788187",
              "maskedIBAN": "FR7699999001001510******187"
            },
            "statementCanBeGenerated": false
          }
        }
      ],
      "totalCount": 2
    }
  }
}

Single transaction

Get information about a single transaction using the API.

1. Call the transaction query.
2. Enter the transaction ID for the transaction you're querying.
3. Add all the information you'd like to review.
   • The sample query uses several transaction query options, including the counterparty, custom label, reference, and whether a transaction statement can be generated statementCanBeGenerated.
4. Add optional messages to the success payload, either for validation or in case of rejection.

Query

🔎 Open the query in API Explorer

query TransactionInfo {
  transaction(id: "$YOUR_TRANSACTION_ID") {
    account {
      IBAN
    }
    amount {
      currency
      value
    }
    bookedBalanceAfter {
      currency
      value
    }
    counterparty
    label
    reference
    statusInfo {
      status
    }
    type
    id
    updatedAt
    statementCanBeGenerated
  }
}

Payload

View all the requested information about the single transaction.

{
  "data": {
    "transaction": {
      "account": {
        "IBAN": "FR7699999001001383799322594"
      },
      "amount": {
        "currency": "EUR",
        "value": "250.00"
      },
      "bookedBalanceAfter": {
        "currency": "EUR",
        "value": "1350.00"
      },
      "counterparty": "Catharijne Janssen",
      "label": "Sample Payment",
      "reference": "internal-note-765",
      "statusInfo": {
        "status": "Booked"
      },
      "type": "SepaCreditTransferIn",
      "id": "$TRANSACTION_ID",
      "updatedAt": "2023-05-03T12:34:05.339Z"
      "statementCanBeGenerated": true
    }
  }
}