Get ACH authorization language
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
-
enterpriseIdstring requiredID of the enterprise
Query Params
-
useSeparateLinkbooleanWhentrue, leaves the ACH Terms URL out ofachAuthorizationLanguageso it can be rendered as a hyperlink usinglinkLabelandlink.
Responses
200
OK
Response Body
object
-
achAuthorizationLanguagestring requiredThe ACH authorization language. Ends with the ACH Terms URL unlessuseSeparateLinkistrue; in that case, render it followed by a space andlinkLabel, withlinkLabelas a hyperlink tolink. -
linkstring uri requiredThe ACH Terms & Conditions URL for the enterprise. -
linkLabelstring requiredThe hyperlink text forlink. WhenuseSeparateLinkistrue, render it right afterachAuthorizationLanguage, separated by a space.
401
Unauthorized
Response Body
object
-
errorNamestring required -
errorstring required
404
Not Found
Response Body
object
-
errorNamestring required -
errorstring required
500
Internal Server Error
Response Body
object
-
errorNamestring required -
errorstring required