API Basics

🚧

Create an Account

To get started, sign up for a free Novac account. API keys will only be accessible after you’ve successfully created an account on Novac.


Requests

All POST api endpoints require a json body to be passed as part of the request

Request payload for the POST APIs are typically in the format below:

{
  "transactionReference": "NB-1111",
  "amount": 100,
  "transactionType": "card"
}

Responses

API responses consistently follow a standard format, with the data field containing a custom object tailored to the specifics of the request made.

{
    "data": {},
    "status": true,
    "message": "Card order created successfully"
}
KeyTypeDescriptionValues
dataobjectcustom object returned for a request.
statusboolindicates if a request was successful or failed.true, false
messagestringsummary of the request operation status.

👍

Good To Know

Both request body data and response data are formatted as JSON and content type for responses is application/json.