Operational Functions Api

Operations that are for operational purposes only such as checking connectivity to the API

POST/v6/acl/check

ACL Check Request

Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and services such as AWS or Azure to check that those addresses are listed in the ACLs.

    Request Attributes

200 OK AclCheckResponseModel

    Response Attributes

Request

AclCheckRequest
{
  "ip":"8.8.8.8"
}

Response

AclCheckResponseModel
{
  "acl":"Default ACL",
  "cache":false,
  "ip":"8.8.8.8",
  "provider":"AWS"
}
POST/dk/check

Domain Key Check Request

Checks the contents of a domain key. Can be used for operational processes to ensure that the properties of a domain key meet their expectations.

    Request Attributes

200 OK DomainKeyResponse

    Response Attributes

Request

DomainKeyCheckRequest
{
  "domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi"
}

Response

DomainKeyResponse
{
  "date_created":"2020-01-02T18:32:28Z",
  "domain":[
    "value1",
    "value2"
  ],
  "domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi",
  "live":true,
  "merchantid":11223344
}
POST/dk/gen

Domain Key Generation Request

Generates a domain key based on the permissions of the calling api-key. Domain keys can be used in Direct Post and XHR calls to the API services.

    Request Attributes

200 OK DomainKeyResponse

    Response Attributes

Request

DomainKeyRequest
{
  "domain":[
    "value1",
    "value2"
  ],
  "live":true,
  "merchantid":11223344
}

Response

DomainKeyResponse
{
  "date_created":"2020-01-02T18:32:28Z",
  "domain":[
    "value1",
    "value2"
  ],
  "domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi",
  "live":true,
  "merchantid":11223344
}
GET/v6/merchants/{clientid}

List Merchants Request

An operational request to list current merchants for a client.

Sorting

Sorting can be performed by include a query parameter i.e. /merchants/?sort=merchantid

Fields that can be sorted are merchantid or name.

    Path Attributes

200 OK ListMerchantsResponse

    Response Attributes

Response

ListMerchantsResponse
{
  "client_name":"",
  "clientid":"PC12345",
  "merchants":[
    {
      "currency":"GBP",
      "merchantid":11223344,
      "name":"Merchant 1",
      "status":"A",
      "status_label":"Active"
    }
  ]
}
POST/v6/ping

Ping Request

A ping request which performs a connection and authentication test to the CityPay API server. The request will return a standard Acknowledgement with a response code 044 to signify a successful ping.

The ping call is useful to confirm that you will be able to access the API from behind any firewalls and that the permission model is granting access from your source.

    Request Attributes

200 OK Acknowledgement

    Response Attributes

Request

Ping
{
  "identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95"
}

Response

Acknowledgement
{
  "code":"044",
  "context":"aspiu352908ns47n343598bads",
  "identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
  "message":"OK"
}