Authentication

API Endpoints & Authentication

Posted helponepay

API Endpoints & Authentication

Authentication

The Gateway API uses API keys to authenticate requests. They can be used and managed from the request headers. API keys carry many privileges, so be sure to keep them safe and secure. Do not share your API keys. Authentication to the API Key is performed via HTTP Request. All API Request must be made over HTTPS. Any of these requests made without an authentication will not be processed.

API key is provided in the Request Header.

Sample API Key: d9694a00-adea-01cb-7a56-c43dd0ebf722

HTTP Methods Used

  • GET requests are used to retrieve resource representation/information only – and not to modify it in any way. 
  • POST methods are used to create a new resource into the collection of resources.
  • PUT methods are primarily used to update existing resource (if the resource does not exist, then API may decide to create a new resource or not).
  • DELETE methods are used to delete resources (identified by the Request-URL).

Request Headers

Property NameRequiredTypeDescription
Content-TypeYesStringapplication/json
x-authorizationYesStringAPI Key

Endpoints

  • Payment Transaction Endpoint: {{GatewayAPIURL}}/Transaction
  • Customer Management Endpoint: {{GatewayAPIURL}}/Customer
  • Automated Billing Endpoint: {{GatewayAPIURL}}/Billing/Plan
  • Batch Endpoint: {{GatewayAPIURL}}/Batch/GetBatchDetail