v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Update a gateway service

Update an existing gateway service

put/v1/gateways/{id}

Path parameters

idstring required

The id of the gateway to be updated.

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

This will always be application/json

Request body

usernamestring

The merchant username

passwordstring

The gateway secret key

namestring

A Manually defined gateway name

typestring

Type of gateway

Response

200

statusinteger

{"stackTrail":"paths:/v1/gateways/{id}:put:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 200,
  "resource": {
    "type": "gateway",
    "data": {
      "created_at": "2020-05-25T13:24:56.662Z",
      "updated_at": "2020-05-25T14:14:02.059Z",
      "type": "MPGS",
      "name": "first updated gateway",
      "_id": "5ecbc728b12c99579e47002e",
      "mode": "test"
    }
  }
}