menu

Track Account Activity

TxB APIs allow Clients to track real-time ledger activity. Clients use this service to understand what transactions have impacted their TxB account balance today (real-time, intraday) or on previous days (end of day, prior days). Whereas payment status APIs provide interim status updates (e.g., PENDING), ledger activity generally reflects payments which are in a terminal state (e.g., SETTLED).

Step by step guide

Step 1 - Get a list of all referenceNumbers

Our ledger activities APIs provide information on an account or service level. So, our first step is to get a list of the accounts or services ('referenceNumbers') associated with a TxB Client.

info

Note

referenceNumber is the unique identifier of a TxB account or service

GET /v1/reports/transactionReports/reportReferences will return a list of accounts or services that the Client currently uses. It returns 2 referenceNumbers, 1 for a deposit account and 1 for a payments only service.

[
  {
    "referenceNumber": "123456789012",
    "referenceType": "DEPOSITACCOUNT", \\ can be Deposit Account or Payments Service Number
    "isVirtual": false
  },
  {
    "referenceNumber": "123456789011",
    "referenceType": "PAYMENTSONLY", \\ can be Deposit Account or Payments Service Number
    "isVirtual": false
  }
]

Step 2 - Get the transactionReport for the TxB deposit account

GET /v2/reports/transactionReports?referenceNumber='123456789012'&businessDate='10-11-2020&limit=10' returns the full balance info for the account and the first 10 transactions for the requested businessDate:

{
  "asOfDateTime": "2020-10-11T23:52:42.279Z",
  "references": {
    "referenceNumber": "123456789012",  // aka  accountNumber
    "referenceType": "DEPOSITACCOUNT",
    "currency": "USD",
    "jurisdiction": "US",               // Identifies the country of the TxB Branch
    "referenceBank": {...},             // Identifies the BIC, Routing Number of the TxB account
    "isVirtual": false,
    "virtualAccountDetails": {          // shows virtual account hierarchy
     "parentAccountNumber": null,
     "physicalAccountNumber": null
    },

  "balances": [
    {
      "balanceType": "AVAILABLE",
      "startOfDayBalance": 2000,
      "endOfDayBalance": null,
      "currentBalance": 1000
    },
    {
      "balanceType": "LEDGER",
      "startOfDayBalance": 2000,
      "endOfDayBalance": null,
      "currentBalance": 1000
    }
  ],
  "transactions": [
    {
      "postingDate": "2020-10-11T16:52:42.279Z",
      "valueDate": "2020-10-11",
      "amount": 1000.00 ,
      "amountCurrency": "USD"
      "identifiers": {
        "gsUniquePaymentId": "Id_TxB_Created)",
        "paymentEndToEndId": "Id_You_Created"
        ...
      },
      "transactionType": "Outgoing Wire",
      "transactionTypeCode": {
        "domainCode": "PMNT",
        "familyCode": "ICDT",
        "subFamilyCode": "XBCT"
      },
      "linkedRecords": {...}             // E.g., returns link to the original payment
      ...
    }
    ...
  ],
  "hasMore": false
}

Step 3 - Interpret the data & repoll if necessary

Based on the data that we return, you will need to perform some analysis and figure out if there are any additional actions required

  • References object

    1. Use this section to understand how this account fits into a broader portfolio of accounts
    2. E.g., if this is a multi-currency account or virtual account, you may need to repeat this query on each virtual account to create a full view of transaction activity
  • Balances array

    1. Use this section to understand how much liquidity is available in the account
    2. In this case, the endOfDayBalance is null, which means that the 'books' have not closed on the account for the day. You may want to poll again at the end of the day (e.g., ~8pm EST) when endOfDayBalance is populated
    3. The balances and transactions tie out as expected. balances[0].startOfDay - transactions[0].amount = balances[0].currentBalance
  • Transactions array

    1. There is only 1 transaction available for this account on this businessDate. Note that hasMore equals false, so there aren't any additional pages of transactions to pull for this account
    2. Each transaction is uniquely identified by the gsUniquePaymentId (think of this as your transactionId)
    3. In most cases, 1 payment equals 1 transaction, e.g., if I make an outbound wire payment from TxB to another bank, this single wire payment will be reflected as a single transaction
    4. In other cases, 1 payment equals more than 1 transaction, e.g., if that same wire payment is returned by the receiving bank, then you will see two transactions in your account (1 for the payment and 1 for the return)
    5. In yet other cases, more than 1 payment equals 1 transaction, e.g., for bulk-processed payments (e.g., US ACH), all N payments within a payment batch will be treated as a single transaction

For information about account data access for UK open banking, learn more here.


This site is for informational purposes only and does not constitute an offer to sell, or the solicitation of an offer to buy, any security. The Goldman Sachs Marquee® platform is for institutional and professional clients only. Some of the services and products described on this site may not be available in certain jurisdictions or to certain types of client. Please contact your Goldman Sachs sales representative with any questions. Nothing on this site constitutes an offer, or an invitation to make an offer from Goldman Sachs to purchase or sell a product. This site is given for purely indicative purposes and does not create any contractual relationship between you and Goldman Sachs. Any market information contained on the site (including but not limited to pricing levels) is based on data available to Goldman Sachs at a given moment and may change from time to time. 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. © 2023 Goldman Sachs. All rights reserved.
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. © 2023 Goldman Sachs. All rights reserved.
Not all products and functionality mentioned on this website are currently available through our API platform.
All loans and deposit products are provided by Goldman Sachs Bank USA, Salt Lake City Branch. Member FDIC.
Brokerage and investment advisory services offered by our investment products are provided by Goldman Sachs & Co. LLC (`‘GS&CO.`’), which is an SEC registered broker-dealer and investment adviser, and member FINRA/SIPC. Research our firm at FINRA's BrokerCheck. Custody and clearing services are provided by Apex Clearing Corporation, a registered broker-dealer and member FINRA/SIPC. Please consider your objectives before investing. A diversified portfolio does not ensure a profit or protect against a loss. Past performance does not guarantee future results. Investment outcomes and projections are forward-looking statements and hypothetical in nature. Neither this website nor any of its contents shall constitute an offer, solicitation, or advice to buy or sell securities in any jurisdictions where GS&Co. is not registered. Any information provided prior to opening an investment account is on the basis that it will not constitute investment advice and that GS&Co. is not a fiduciary to any person by reason of providing such information. For more information about our investment offerings, visit our Full Disclosures.
Investment products are: NOT FDIC INSURED ∙ NOT A DEPOSIT OR OTHER OBLIGATION OF, OR GUARANTEED BY, GOLDMAN SACHS BANK USA ∙ SUBJECT TO INVESTMENT RISKS, INCLUDING POSSIBLE LOSS OF THE PRINCIPAL AMOUNT INVESTED