Generate transaction statements

You can generate a transaction statement with the API. You can also download transaction statements, referred to as transaction confirmations, from your Dashboard.

Prerequisites

• The account member has the canViewAccount membership permission.
• You have a project access token.
• The transaction status is Booked.
• Subscribe to the TransactionStatement.Generated webhook.

API guide

Step 1: Generate statement

1. Call the generateTransactionStatement mutation.
2. Add the transactionId.
3. Choose the language for your transaction statement.
4. Add the success payload and any information you need, such as the transaction statement ID and status.
5. Add rejections (not shown).

🔎 Open the mutation in API Explorer

mutation TransactionStatement {
  generateTransactionStatement(
    input: {
      transactionId: "$TRANSACTION_ID"
      language: es
    }
  ) {
    ... on GenerateTransactionStatementSuccessPayload {
      __typename
      transactionStatement {
        createdAt
        id
        statusInfo {
          status
          ... on PendingTransactionStatementStatusInfo {
            __typename
            status
        }
      }
    }
  }
}

Step 2: Get transaction statement ID

Get the transactionStatement > id from the success payload (line 7).

warning

This is the only way to get the transactionStatement > id. Copy it immediately to use in step 3.

{
  "data": {
    "generateTransactionStatement": {
      "__typename": "GenerateTransactionStatementSuccessPayload",
      "transactionStatement": {
        "createdAt": "2024-09-26T15:31:38.742Z",
        "id": "$TRANSACTION_STATEMENT_ID",
        "statusInfo": {
          "status": "Pending",
          "__typename": "PendingTransactionStatementStatusInfo"
        }
      }
    }
  }
}

Step 3: Retrieve download URL

After generating the transaction statement, you receive a TransactionStatement.Generated webhook notification letting you know the statement can be downloaded by URL. The URL is valid for seven days.

1. Call the transactionStatement query.
2. Add the transactionStatement > id.
3. Add statusInfo for all statuses. The URL to download the statement is provided in statusInfo > GeneratedTransactionStatementStatusInfo > url (line 11).

🔎 Open the query in API Explorer

query GetStatementUrl {
  transactionStatement(id: "$TRANSACTION_STATEMENT_ID") {
    createdAt
    updatedAt
    statusInfo {
      status
      ... on GeneratedTransactionStatementStatusInfo {
        __typename
        expiresAt
        status
        url
      }
    }
  }
}

Step 4: Download statement

Use the url to download the statement within seven days of generation.

1. Copy the url from the payload (line 10).
2. Paste the url into your preferred browser.
3. The document downloads automatically after you press enter.

{
  "data": {
    "transactionStatement": {
      "createdAt": "2024-09-26T16:08:55.512Z",
      "updatedAt": "2024-09-26T16:08:55.512Z",
      "statusInfo": {
        "status": "Generated",
        "__typename": "GeneratedTransactionStatementStatusInfo",
        "expiresAt": "2024-10-03T16:09:01.286Z",
        "url": "$YOUR_DOWNLOAD_URL"
      }
    }
  }
}

Troubleshooting

If the transaction statement status is Failed or Expired, return to step 1 to generate your statement again.

Dashboard

1. On your Dashboard, go to Data > Transactions.
2. Open the eligible transaction for which you'd like to download an account confirmation statement (not shown). The transaction status must be Booked.
3. Click Transaction confirmation, triggering the generation and download of the document automatically.

Eligible transactions

Transaction confirmation statements are only available for incoming and outgoing SEPA Credit Transfers and Instant SEPA Credit Transfers with the status Booked. The transaction confirmation button doesn't appear for ineligible transactions.