API keys API

Get latest

Use your existing key to get a new key.

The response contains the key you should use from now on. Usually this is your existing key. When your existing key is about to expire, this is your new key.

You should do this once per day.

To test your automatic key renewal code:

Create two API keys using PaymentsPlus.
Configure your application to use the first key.
Confirm that your application automatically switches to the second key.

Request

GET `/api-keys/latest`

Request body

None.

Response

If successful, this method returns the following in the response body.

Field	Format	Data
`keyName`	`string`	The API key name. Use for logging.
`key`	`string`	The API key.
`expiryDate`	`date-time`	The date and time the key will expire.

API Key response example

{
  "keyName": "FACILITYCODE_SEC...zrikj5x",
  "key": "FACILITYCODE_SEC_dcm89ugjh5jbcjq5pdymhgimdj7gwwd7dddhty6arjrjftv8hymz8zr",
  "expiryDate": "2022-01-02T03:48:40+00:00"
}

HTTP status codes

See HTTP Status Codes for more.

Status Code	Description	More information
`200`	OK	The request has succeeded.
`401`	UNAUTHORIZED	The API key in the request is expired. View more.