PATCH
/
ach
/
gateways
/
{id}
Update Gateway Endpoint Configuration By ID
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/ach/gateways/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_headers": {
    "Content-Type": [
      "application/json",
      "text/html"
    ],
    "Host": [
      "https://host.com"
    ]
  },
  "disabled": true,
  "max_wait_ms": 2,
  "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.

Path Parameters

​
id
string<uuid>
required

The unique resource identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Gateway Config Object fields allowed for update

Gateway Config Update Request

​
custom_headers
object | null

Custom http headers for the Auth request to Gateway URL

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

Allows to disable/enable Gateway Config for the Fintech (Tenant)

​
max_wait_ms
integer

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

Required range: x >= 1
​
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"

Response

Updated 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"