Reference Materials

Format and protocol

Our APIs adhere to the following standard around format and protocol.

Interaction PatternRequest / response
Communication ProtocolHTTPS with Mutual TLS
String Encoding FormatUTF-8 (Unicode Normalization Form C (NFC))
Request/Response FormatJSON / XML (for ISO-20022)
Methods SupportedGET, PUT, POST, DELETE
URL Scheme{TXB-base-url}/{version}/{service}/{resource-path}


Version: The API version intended to be used. Service: The core service/product providing the functionality. resource-path: complete hierarchical path of the resource

  • Other items
    • kebab-case is used throughout in the URL
    • URLs generally use nouns, not verbs
    • Actions are determined by HTTP method used and request body of the post request (if required)
    • Depending on client needs, call-backs using WebHooks or similar approaches will also be considered

Environments available

TxB makes two environments available for our API users

  • Test –
    • E.g.,
    • Used to test initial integrations and new features
    • Our test environment is a replica of our production environment (with mocked payment rail and external settlement services) that allows you to experience production-like performance, errors, etc. before you hit the ground running in production
  • Production -

Error behavior

TXB APIs respond with a small set of client actionable and universally well understood HTTP response codes. More granular level of information for error-scenarios is provided inside error objects

Response CodeMeaning
400Bad request
429Too many requests
500Server error

In case of non-successful processing of the request the TXB APIs respond with a non-200 HTTP response code.

  • These lie in 2 broad categories:
    • 4XX response: - Some issue with the request
    • 5XX response: - Some issue on the server side


In case multiple errors are encountered, return a list of all errors. Returning all errors at once helps the users address them in smaller number of iterations.

In all non-success scenarios, the response body contains a list of error objects containing detailed information about what caused this error and how can it be resolved.

errorCodeINT32YesUnique error code to identify precisely what sort of error occurred. Should be granular.
messageString (256 max)NoHuman readable message explaining the error
moreInfoString (256 max)NoRelevant link to more information and how to solve the error
retryBoolNoIndicates whether this requested can be replayed by client with expectation to succeed
retryAfterINT32NoTime in milliseconds after which client can retry the failed request
paramsObjectNoAdditional parameters about error (used for some specific error scenarios)

Field naming

The following naming conventions are used throughout for TXB APIs:

  • Field Names:
    • All field names are camelCased ASCII strings starting with a small cap alphabet or underscore
    • Examples: firstName, paymentAmount, dailyLimit, dailyLimit2, \_ext
  • Dates:
    • All date fields end with “Date” suffix
    • Examples: startDate, submissionDate, validityDate
  • Date-times:
    • All date-time fields end with “Time” suffix
    • Examples: paymentTime, acceptanceTime, completionTime
  • Identifiers:
    • All identifier fields end with “Id” suffix
    • Examples: paymentId, clientId, agentId

Field formats

  • Date and Date-time:
    • Only ISO8601 format is used to specify Date and Date-time Fields
    • Date Examples:
      • 2019-05-23, 1995-11-01, 2019-01-31
      • 2019-05-23T05:53:17Z, 1996-11-01T23:00:01Z
  • Boolean:
    • Only true/false values are used
    • Following formats are not used
      • true/false
      • 1/0
      • “Yes”/”No”
      • “Y”/”N”
  • JSON fields:
    • Only standard JSON field notations are used
    • Type casting like below examples are not used
      • “78” (Using strings in place of numbers)
      • “128.20” (Using strings in place of float)

Request headers

We support the below Request Headers

HeaderMandatorySupported valuesDefault value
AcceptNOapplication/json, application/xmlapplication/json
Content-TypeNOApplication/json, application/xmlApplication/json
  • Authorization header is non-mandatory as it holds additional information if required for additional authorization
  • If a non-mandatory header is not passed in the request, then its value is set to the default header value
  • Some additional security headers can also be required to be passed
  • Any additional headers passed with the request (besides the supported ones) are ignored by TXB APIs

Response headers

Response headers are included in the https response to provide additional information about the response sent. API users are expected to parse these responses headers to correctly interpret the response.

HeaderMandatoryPossible values
Content-TypeAlways with Response BodyApplication/json, application/xml
Content-EncodingAlways with Response BodyIdentity, deflate, gzip
X-API-VersionNoActual complete version of API responding
X-API-Deprecation-DateWith API versions planned for deprecationDate on which API will be marked deprecated
X-API-Deprecation-InfoWith API versions planned for deprecationAdditional information/documentation link on the deprecated API with possible upgrade options
  • Default String encoding: - UTF-8 (Unicode Normalization Form C (NFC))
  • Responses use their own encoding for content compression
  • Response encoding format is captured in “Content-Encoding” response header

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