Authentication

Prior to attempting to query the API you must first complete authentication with the our Platform. The authentication process utilises the account credentials which are supplied following the configuration of your account.

These credentials include the below.

• TerminalID
• ClientID
• ClientSecret

Authentication POST - Request

URL

https://test-oauth.dnapayments.com/oauth2/token

Authentication is completed via a POST request to the test URL shown above. The POST must contain the below data:

Authentication Request
Field Name	State	Data Type	Description
grant_type	Mandatory	String	Authorisation type required to confirm the action required. client_credentials Obtain credentials required to process a transaction.
scope	Mandatory	String	Confirm scope of the action to be performed with credentials. partners_reporting Partner Reporting API
client_id	Mandatory	String	Provided to the integrator following the successful creation of a test account.
client_secret	Mandatory	String	Provided to the integrator following the successful creation of a test account.

Authentication POST - Response

Following the receipt of a correctly formatted authorisation POST the DNA platform will respond with the below.

Field Name	Data Type	Description
access_token	String	Access token provided by the DNA platform. The token should be securely stored ready to be used in the interactions with the API.
expires_in	Integer	Number of seconds from generation until the access_token expires. If the token is not used before this time has passed a new token will need to be requested.
refresh_token	String	Reserved for future use.
scope	String	List of scopes to which users have agreed to grant access within this access_token
token_type	String	Type of token issued Bearer Bearer token

Example Request and Response

Request

Example: Authentication Request (NodeJs)

var request = require("request");

var options = {
    method: 'POST',
    url: 'https://oauth.dnapayments.com/oauth2/token',
    formData:
    {
        scope: 'partners_reporting',
        client_id: 'ExampleShop',
        client_secret: 'mFE454mEF6kmGb4CDDeN6DaCnmQPf4KLaF59GdqwP',
        grant_type: 'client_credentials'
    }
};
request(options, function (error, response, body)
{
    if (error) throw new Error(error);
    console.log(body);
});

Response

Example: Authentication Response

{
"access_token": "D*OAeMXErWmCSWcZYsyJf0cRZlC5C$hCR2dEGJp7.2q1W*z_iSC9sa3JGLtAR3ZG",
"expires_in": 7200,
"refresh_token": "!NnycppKptqQE_w6!0oul!=bCEXlu=JX*7yW!h.xpuHJvs9ums9lPJ1FpUfmSfH7",
"scope": "partners_reporting",
"token_type": "Bearer"
}