put
https://app.shuttleglobal.com/c/api/instances/{instance_key}/gateways/
Updating a gateway is intended to be used in conjunction with Shuttle support.
gateway_idcan be either ID or code
Request fields:
status(optional) - update the status to one ofACTIVE,RUNDOWN,ARCHIVEvalues- A map of parameters, specific to the gateway, for valid options contact supporttags- An array of strings to store on this objects, you can search objects by tagmetadata- A list of key values pairs to store on a object
Gateway statuses:
ACTIVE- Supports new payments and new payment methodsRUNDOWN- Only support payments on existing payment_methodsARCHIVE- Does not support new payments or payment_methods, nor will any API requests be made to the gateway in this status
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Business Rules
The logic behind this operation, by what the request carries:
- Disconnect a provider — body carries status ARCHIVE
- Dismiss an archived provider's notice — an archived gateway; body carries status_reason null and no status change
- Restore an archived provider — body carries status ACTIVE on an archived gateway
- Update a provider's settings — status unchanged; body carries values and currencies
Bad request - invalid parameters
Unauthorized - invalid credentials
Gateway not found
Validation error - invalid gateway configuration