REST API›Fiat›ACH Debits

GET

Returns the ACH debit authorization language that must be presented to and accepted by the end user before initiating an ACH debit transfer. Acceptance is mandatory — the acceptAuthTerms field on the initiate request must be true. This is a required part of BitGo's risk and compliance strategy for ACH debit origination. The ACH Terms URL in the response varies based on the enterprise's CaaS status. By default, achAuthorizationLanguage ends with the ACH Terms URL and can be displayed as is. When useSeparateLink is true, the URL is left out: render achAuthorizationLanguage followed by a space and linkLabel, where linkLabel is a hyperlink to link. For example, in HTML: {achAuthorizationLanguage} <a href="{link}">{linkLabel}</a>. Requires access token scope: wallet_view_all or wallet_spend_all

Path Params

  • enterpriseId string required
    ID of the enterprise

Query Params

  • useSeparateLink boolean
    When true, leaves the ACH Terms URL out of achAuthorizationLanguage so it can be rendered as a hyperlink using linkLabel and link.

    Defaults to false

Responses

200
OK

Response Body

object

  • achAuthorizationLanguage string required
    The ACH authorization language. Ends with the ACH Terms URL unless useSeparateLink is true; in that case, render it followed by a space and linkLabel, with linkLabel as a hyperlink to link.
  • link string uri required
    The ACH Terms & Conditions URL for the enterprise.
  • linkLabel string required
    The hyperlink text for link. When useSeparateLink is true, render it right after achAuthorizationLanguage, separated by a space.
401
Unauthorized

Response Body

object

  • errorName string required
  • error string required
404
Not Found

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required