POST
/
ach
/
gateways
Create New Gateway Endpoint Configuration
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/ach/gateways \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_headers": {
    "Content-Type": [
      "application/json",
      "text/html"
    ],
    "Host": [
      "https://host.com"
    ]
  },
  "disabled": false,
  "max_wait_ms": 1500,
  "url": "https://fintech.com/ach/auth"
}'
{
  "created": "2010-05-06T12:23:34.321Z",
  "custom_headers": {
    "Content-Type": [
      "application/json",
      "text/html"
    ],
    "Host": [
      "https://host.com"
    ]
  },
  "disabled": false,
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "max_wait_ms": 1500,
  "tenant": "abcdef_ghijkl",
  "updated": "2010-05-06T12:23:34.321Z",
  "url": "https://fintech.com/ach/auth"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Gateway Config Create Request

​
url
string<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:

"https://fintech.com/ach/auth"

​
custom_headers
object

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

Example:
{
  "Content-Type": ["application/json", "text/html"],
  "Host": ["https://host.com"]
}
​
disabled
boolean
default:false

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

​
max_wait_ms
integer
default:1500

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

Required range: 1 <= x <= 32000

Response

Created Gateway Config Object

Represents a Gateway Config Object

​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
created
string<date-time>

Time when Gateway Config object was created

Example:

"2010-05-06T12:23:34.321Z"

​
custom_headers
object

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

Example:
{
  "Content-Type": ["application/json", "text/html"],
  "Host": ["https://host.com"]
}
​
disabled
boolean
default:false

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

​
id
string<uuid>

Identifier of the Gateway Config object

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
max_wait_ms
integer
default:1500

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

Required range: x >= 1
​
updated
string<date-time>

Time when Gateway Config object was updated

Example:

"2010-05-06T12:23:34.321Z"

​
url
string<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:

"https://fintech.com/ach/auth"