You can use TxB Webhooks to have event updates proactively pushed from TxB to your server. Since webhooks only transfer data when an object has changed state, you can spend less time polling TxB APIs and receive fresher data (i.e., you only see data when something new has happened).

Currently, TxB supports webhook updates for two objects:

  • Payments that you initiate. After you initiate a payment with TxB, we will send events back to you when that payment transitions from INITIATED to RELEASED to SETTLED.
  • Customer service cases. After you create a customer service case with TxB via API, we will send events back to you when that case transitions to a CLOSED state.
  • Payments that you receive. When an incoming payment is posted to your account, we will send you a webhook event stating payment was RECEIVED.

Available events

Event NameTerminal StatusDescription
PAYMENT_STATUS.PENDINGNoPayment processing has been delayed, e.g., because of insufficient funds
PAYMENT_STATUS.ACCEPTEDNoPayment processing within TxB is complete and we are waiting to send to network
PAYMENT_STATUS.RELEASEDMaybePayment network has confirmed receipt of the payment. In some cases, this is a terminal step
PAYMENT_STATUS.SETTLEDYesPayment receiver has confirmed receipt
PAYMENT_STATUS.REJECTEDYesTxB stopped the payment from being processed due to an error, e.g., incorrect account number
PAYMENT_STATUS.CANCELEDYesThe payment originator requested that we cancel or reverse the payment
PAYMENT_STATUS.RETURNEDYesThe payment network or receiver has canceled the payment and returned it to TxB
INCOMING_PAYMENT.RECEIVEDMaybeYou have received an incoming payment that has been posted to your TxB account

Case events are currently in Alpha and will be published when generally available.

Responses to a webhooks

Once you receive a callback from TxB, you're expected to respond with one of the following codes:

HTTP Response ExpectedDescriptionAutomatic RetriesExample Body of Response
207Partial successNo{"eventId": "Payment1234", "errorDescription": "Payment end to end ID not found"}
400Bad requestNonull
401Authentication failedNonull
403Unauthorized to access resourceNonull
404Resource not foundNonull
408Time outYesnull
429Too many requestsYesnull

If TxB receives a 408, 429, or 5XX status code, then we will automatically retry to send the event. Otherwise, please use the payment status API to poll for an update. We also suggest using the payment status API periodically to reconcile payments which have not hit a terminal state for several days.

Event grouping

You can receive events individually (as they happen) or grouped together (e.g., if you plan to send a lot of payments and don't want to be bombarded with API requests). Below are the two ways in which TxB can group multiple events into a single callback. If you request event grouping, we recommend using both of the below grouping features.


Receive all updates accumulated over a fixed period of time.


  • Event A - Payment accepted by TxB at 10:03 AM
  • Event B - Payment released at 10:05 AM
  • Event C - Payment settled at 10:15 AM
  • Event D - Payment returned at 11:20 AM

If you opt for updates every 10 minutes, TxB will group events A and B and send them together at 10:10 AM, with event C coming through in the next update at 10:20 AM and event D at 11:20 AM.

Maximum Events

Receive updates when a pre-configured number of events are accumulated.


  • Event A - Payment accepted by TxB at 10:03 AM
  • Event B - Payment released at 10:05 AM
  • Event C - Payment settled at 10:15 AM
  • Event D - Payment returned at 10:20 AM

If you opt for a maximum of 3 events in a group and a 15 minute update frequency, TxB will group events A, B and C and send them together at 10:15 AM, with event D coming through in the next update at 10:30 AM.

Anatomy of a webhook payload

    "deliveryId": "7a484093-f205-4004-9c5f-4c333527656e",

    ## Every message we send to you will be uniquely defined by a `deliveryId`
    ## One `deliveryId` can contain between 1 and N individual events
    ## The maximum number of a events in a message is configurable

    "events": [
            "eventName": "PAYMENT_STATUS.RELEASED",

            ## eventNames correspond to the event trigger
            ## for example, PAYMENT_STATUS.RELEASED indicates
            ## that a payment you initiated has been released to
            ## a payment network

            "eventId": "7a484093-f205-4004-9c5f-4c333527656e",
            "eventTimestamp": "2021-02-01T16:56:46.384Z",

            ## the time at which an event was created.  Note that events
            ## may be delivered after the point at which they are created

            "eventData": {

            ## event data provides the object which has changed status
            ## which is, in thise case, a payment

                "identifiers": { ... },
                "paymentExecutedValueDate": "2021-06-21",
                "amount": 101,
                "paymentCurrency": "USD",
                "paymentStatus": {
                    "status": "RELEASED",
                    "statusTime": "2020-12-01T16:55:42.279Z"

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 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.