v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Create a gateway service

Create a new gateway service on your PowerBoard account

post/v1/gateways

Headers

x-user-secret-keystring required

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

Content-Typestring required

Content type will always be application/json

Request body

type'Afterpay' | 'MasterCard' | 'Paypal' | 'Paypalclassic' | 'Zipmoney' required

The type of gateway to be added

namestring required

A manually defined name for the gateway service to be added

usernamestring required

Merchant name

passwordstring

Gateway secret key

Response

200

statusinteger

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

Example response

{
  "status": 201,
  "resource": {
    "type": "gateway",
    "data": {
      "created_at": "2020-05-25T13:17:59.890Z",
      "updated_at": "2020-05-25T13:17:59.890Z",
      "type": "MPGS",
      "name": "first MPGS gateway",
      "_id": "5ecbc587b12c99579e47002d",
      "mode": "test"
    }
  }
}