Subscribe and Download File Reports

Report subscriptions allow customers to subscribe to file based reports and download them for their intraday or end of day reconciliation requirements.

Step by step guide

Step 1 - Create subscription for the desired file reports

Our first step is to create a subscription for an intraday or end-of-day file report, specifying the report format (e.g. BAI, CAMT) and other related details. To do this you will need to utilize the subscription APIs.

POST /v1/subscription will create the file report subscription.

Representative payload for end-of-day report:

{
  "subscriptionType": "FILE_REPORT",
  "typeSpecificSubscriptionInfo": {
    "reportType": "EOD_STATEMENT",                // EOD_STATEMENT or INTRADAY_REPORT
    "reportFormat": "BAI2",                       // BAI2, CAMT52, CAMT53
    "entityId": "2481F41D17064198BDAA16A7CBC91D70",
    "deliveryMethod": "API"
  }
}

Representative response with the details of the subscription created.

{
    "subscriptionType": "FILE_REPORT",
    "subscriptionId": "a48e2a74684148e0b7828eb595975027", // Unique identifier assigned by TxB
    "typeSpecificSubscriptionInfo": {
        "reportType": "EOD_STATEMENT",
        "reportFormat": "BAI2",
        "reportNamePrefix": null,
        "frequency": null,
        "transactionScope": null,
        "reportIfNoTransactions": null,
        "entityId": "2481F41D17064198BDAA16A7CBC91D70",
        "deliveryMethod": "API"
    }
}

Step 2 - Query the file reports generated by TxB

Once you have created the subscription, TxB will now generate the transaction file reports depending on the details provided in the subscription. You should use the API POST /v2/documents/query which will return a list of file reports generated.

Representative payload to query end-of-day reports in BAI2 format:

{
    "entityId": "2481F41D17064198BDAA16A7CBC91D70",
    "documentData": {
        "reportFormat": "BAI2", 
        "reportCategory": "EOD_STATEMENT",           // EOD_STATEMENT, INTRADAY_REPORT
        "startDateTime": "2024-06-01T00:00:00Z"
    }
}

Representative response with list of generated reports:

{
    "documentData": [
        {
            "reportName": "BAI2_2024-06-04T20_00_05.224629_EoD_report.BAI",
            "reportFormat": "BAI2",
            "reportId": "13132891",
            "reportCategory": "EOD_STATEMENT",
            "entityId": "2481F41D17064198BDAA16A7CBC91D70",
            "linkUrl": "https://api.test.txb.gs.com/v2/documents/eyJnk...jyWux0/file",
            "reportScopeStartTime": "2024-06-04T00:00:00Z",
            "reportScopeEndTime": "2024-06-04T23:59:59Z"
        },
        {
            "reportName": "BAI2_2024-06-02T20_00_11.931953_EoD_report.BAI",
            "reportFormat": "BAI2",
            "reportId": "13121563",
            "reportCategory": "EOD_STATEMENT",
            "entityId": "2481F41D17064198BDAA16A7CBC91D70",
            "linkUrl": "https://api.test.txb.gs.com/v2/documents/eyJlbm...6DQgQ/file",
            "reportScopeStartTime": "2024-06-02T00:00:00Z",
            "reportScopeEndTime": "2024-06-02T23:59:59Z"
        }
	]
}

Step 3 - Download a file report

The response data from the previous step, contains an array of report objects with a linkUrl included for each, representing the file reports generated. To download a particular file report, you have to invoke the corresponding linkUrl.

Note: The link is only valid for 5 days, after which date you will need to repeat step 2.

Step 4 (Optional) - Get details of created report subscriptions

If you want to get the details of all the subscriptions, created by you, the API GET /v1/subscriptions returns the full list.

[
    {
        "subscriptionType": "FILE_REPORT",
        "subscriptionId": "a48e2a74684148e0b7828eb595975027",
        "typeSpecificSubscriptionInfo": {
            "reportType": "EOD_STATEMENT",
            "reportFormat": "BAI2",
            "reportNamePrefix": null,
            "frequency": null,
            "transactionScope": null,
            "reportIfNoTransactions": null,
            "entityId": "2481F41D17064198BDAA16A7CBC91D70",
            "deliveryMethod": "API"
        }
    },
    {
        "subscriptionType": "FILE_REPORT",
        "subscriptionId": "4ee1f3c071674addaa8bbe84e13deade",
        "typeSpecificSubscriptionInfo": {
            "reportType": "INTRADAY_STATEMENT",
            "reportFormat": "CAMT52",
            "reportNamePrefix": null,
            "frequency": 30,
            "transactionScope": "INCREMENTAL",
            "reportIfNoTransactions": null,
            "entityId": "2481F41D17064198BDAA16A7CBC91D70",
            "deliveryMethod": "API"
        }
    }
]

Step 5 (Optional) - Update a report subscription

If you want to modify any particular subscription (e.g., updating the report format or report type), then follow the steps:

Delete the subscription using the API DELETE /v1/subscription/{subscriptionId}
Create a new subscription with updated information, as mentioned in step 1.

Was this page useful?

Give feedback to help us improve developer.gs.com and serve you better.

Goldman Sachs DeveloperPrivacy and CookiesGS Terms & ConditionsRegulatory DisclosuresSecurity

GS DAP® is owned and operated by Goldman Sachs. This site is for informational purposes only and does not constitute an offer to provide, or the solicitation of an offer to provide access to or use of GS DAP®. Any subsequent commitment by Goldman Sachs to provide access to and / or use of GS DAP® would be subject to various conditions, including, amongst others, (i) satisfactory determination and legal review of the structure of any potential product or activity, (ii) receipt of all internal and external approvals (including potentially regulatory approvals); (iii) execution of any relevant documentation in a form satisfactory to Goldman Sachs; and (iv) completion of any relevant system / technology / platform build or adaptation required or desired to support the structure of any potential product or activity. All GS DAP® features may not be available in certain jurisdictions. Not all features of GS DAP® will apply to all use cases. Use of terms (e.g., "account") on GS DAP® are for convenience only and does not imply any regulatory or legal status by such term.

Certain solutions and Institutional Services described herein are provided via our Marquee platform. The Marquee platform is for institutional and professional clients only. This site is for informational purposes only and does not constitute an offer to provide the Marquee platform services described, nor an offer to sell, or the solicitation of an offer to buy, any security. Some of the services and products described herein may not be available in certain jurisdictions or to certain types of clients. Please contact your Goldman Sachs sales representative with any questions. Any data or market information presented on the site is solely for illustrative purposes. There is no representation that any transaction can or could have been effected on such terms or at such prices. Please see https://www.goldmansachs.com/disclaimer/sec-div-disclaimers-for-electronic-comms.html for additional information.

Transaction Banking services are offered by Goldman Sachs Bank USA (“GS Bank”). GS Bank is a New York State chartered bank, a member of the Federal Reserve System and a Member FDIC.

Mosaic is a service mark of Goldman Sachs & Co. LLC. This service is made available in the United States by Goldman Sachs & Co. LLC and outside of the United States by Goldman Sachs International, or its local affiliates in accordance with applicable law and regulations. Goldman Sachs International and Goldman Sachs & Co. LLC are the distributors of the Goldman Sachs Funds. Depending upon the jurisdiction in which you are located, transactions in non-Goldman Sachs money market funds are affected by either Goldman Sachs & Co. LLC, a member of FINRA, SIPC and NYSE, or Goldman Sachs International. For additional information contact your Goldman Sachs representative. Goldman Sachs & Co. LLC, Goldman Sachs International, Goldman Sachs Liquidity Solutions, Goldman Sachs Asset Management, L.P., and the Goldman Sachs funds available through Goldman Sachs Liquidity Solutions and other affiliated entities, are under the common control of the Goldman Sachs Group, Inc.