v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Archive a gateway

Delete the specified gateway service

delete/v1/gateways/{id}

Path parameters

idstring required

The id of the gateway to be archived. Recieved at the gateway creation stage

Query parameters

action'check'

Use value 'check' to verify credentials before updating the service

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

Response

200

statusinteger

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

Example response

{
  "status": 200,
  "resource": {
    "type": "gateway",
    "data": {
      "name": "GooglePay",
      "type": "MasterCard",
      "mode": "test",
      "wallets": [
        "google"
      ],
      "archived": true,
      "verification_status": "completed",
      "_id": "67a3fd4c21f0bd5f83e7f52a",
      "updated_at": "2025-02-10T00:50:08.594Z",
      "created_at": "2025-02-06T00:07:40.556Z"
    }
  }
}