Operational Functions Api
Operations that are for operational purposes only such as checking connectivity to the API
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
{
"ip":"8.8.8.8"
}
Response
{
"acl":"Default ACL",
"cache":false,
"ip":"8.8.8.8",
"provider":"AWS"
}
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
{
"domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi"
}
Response
{
"date_created":"2020-01-02T18:32:28Z",
"domain":[
"value1",
"value2"
],
"domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi",
"live":true,
"merchantid":11223344
}
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
{
"domain":[
"value1",
"value2"
],
"live":true,
"merchantid":11223344,
"nonce":"0123456789ABCDEF"
}
Response
{
"date_created":"2020-01-02T18:32:28Z",
"domain":[
"value1",
"value2"
],
"domain_key":"3MEcU8cEf...QMeebACxcQVejmT1Wi",
"live":true,
"merchantid":11223344
}
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.
Response
{
"client_name":"",
"clientid":"PC12345",
"merchants":[
{
"currency":"GBP",
"merchantid":11223344,
"name":"Merchant 1",
"status":"A",
"status_label":"Active"
}
]
}
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
{
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95"
}
Response
{
"code":"044",
"context":"aspiu352908ns47n343598bads",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"message":"OK"
}
Request
{
"exp":"1734024775",
"ip":"8.8.8.8"
}
Response
{
"code":"001",
"context":"aspiu352908ns47n343598bads",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"message":"Added IP address"
}