EML Data Services Swagger

swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "This is a partial Swagger representation of the EML Data Services API documentation version 1.0 that will be used to generate a .NET client. See https://developer.emerchants.com.au/paywith/eml.v1.html# for vendor documentation.",
    "version": "1.0",
    "title": "EML Data Services API",
    "contact": {
      "email": "[email protected]"
    }
  },
  "host": "beta.wsmerchants.com.au",
  "basePath": "/3.0",
  "tags": [
    {
      "name": "token",
      "description": "Obtain OAuth 2.0 access token"
    },
    {
      "name": "accounts",
      "description": "Manage EML accounts"
    }
  ],
  "schemes": [
    "https"
  ],
  "paths": {
    "/token": {
      "get": {
        "tags": [
          "token"
        ],
        "summary": "Obtain an access token for the EML Data Services API",
        "description": "",
        "operationId": "getToken",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Token request including grant_type value client_credentials",
            "required": true,
            "schema": {
              "$ref": "#/definitions/GrantRequest"
            }
          }
        ],
        "responses": {
          "401": {
            "description": "Forbidden"
          },
          "405": {
            "description": "Invalid input"
          }
        }
      }
    },
    "/accounts": {
      "post": {
        "tags": [
          "accounts"
        ],
        "summary": "Create a new EML account",
        "description": "",
        "operationId": "createAccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Account request including registration data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateAccountRequest"
            }
          }
        ],
        "responses": {
          "401": {
            "description": "Forbidden"
          },
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "access_token": [
              "write:eml"
            ]
          }
        ]
      }
    },
    "/accounts/{id}/status": {
      "put": {
        "tags": [
          "accounts"
        ],
        "summary": "Update the status of an EML account",
        "description": "",
        "operationId": "updateAccountStatus",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of account on which to update status",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "body",
            "name": "body",
            "description": "Account request including registration data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateAccountStatusRequest"
            }
          }
        ],
        "responses": {
          "401": {
            "description": "Forbidden"
          },
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "access_token": [
              "write:eml"
            ]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "access_token": {
      "type": "oauth2",
      "authorizationUrl": "https://beta.wsmerchants.com.au/3.0/token",
      "tokenUrl": "https://beta.wsmerchants.com.au/3.0/token",
      "flow": "accessCode",
      "scopes": {
        "write:eml": "update values in EML"
      }
    }
  },
  "definitions": {
    "GrantRequest": {
      "type": "object",
      "required": [
        "grant_type"
      ],
      "properties": {
        "grant_type": {
          "type": "string",
          "description": "Grant Type",
          "enum": [
            "client_credentials"
          ]
        }
      }
    },
    "CreateAccountRequest": {
      "type": "object",
      "required": [
        "grant_type"
      ],
      "properties": {
        "grant_type": {
          "type": "string",
          "description": "Grant Type",
          "enum": [
            "client_credentials"
          ]
        }
      }
    },
    "UpdateAccountStatusRequest": {
      "type": "object",
      "required": [
        "grant_type"
      ],
      "properties": {
        "grant_type": {
          "type": "string",
          "description": "Grant Type",
          "enum": [
            "client_credentials"
          ]
        }
      }
    }
  }
}