Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
ACH

Create New Gateway Endpoint Configuration

By creating Gateway Endpoint Configuration object for Fintech, you enable ACH in Auth flow for all the ACH transactions for specified Fintech (Tenant)

post/ach/gateways

Request body

custom_headersobject

Optional parameter that allows to configure custom http headers for the Auth request to Gateway URL if needed

disabledboolean

Setting this parameter to 'true' allows create Gateway Config as inactive ( can be useful as a preparation step)

max_wait_msinteger

Optional parameter that configures the maximum amount of time in milliseconds that we will wait for the response from Gateway URL request. Default value is used if empty

urlstring url required

The URL address which will be used for the ACH in Auth Flow requests to get authorization from the fintech to process the transaction

Example request

{
  "custom_headers": {
    "Content-Type": [
      "application/json",
      "text/html"
    ],
    "Host": [
      "https://host.com"
    ]
  },
  "url": "https://fintech.com/ach/auth"
}

Response

Created Gateway Config Object

createdstring date-time

Time when Gateway Config object was created

custom_headersobject

Optional parameter that allows to configure custom http headers for the Auth request to Gateway URL if needed

disabledboolean

Indicates if the Gateway Config is active for Auth Flow for the current Fintech (Tenant)

idstring uuid

Identifier of the Gateway Config object

max_wait_msinteger

Shows maximum amount of time in milliseconds that we will wait for the response from Gateway URL Auth request

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

updatedstring date-time

Time when Gateway Config object was updated

urlstring url

The URL address which will be used for the ACH in Auth Flow requests to get authorization from the fintech to process the transaction

Example response

{
  "created": "2010-05-06T12:23:34.321Z",
  "custom_headers": {
    "Content-Type": [
      "application/json",
      "text/html"
    ],
    "Host": [
      "https://host.com"
    ]
  },
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "tenant": "abcdef_ghijkl",
  "updated": "2010-05-06T12:23:34.321Z",
  "url": "https://fintech.com/ach/auth"
}