Token Request

The Almara Pay API uses OAuth2.0 authentication and this requires client_id, client_secret, grant_type, scope.

These parameters are provided once one is setup in the ZamuPay System.

Token Request is a POST request responsible for returning the bearer token that is required for all the requests that are to be made.

For this the required details are: client_id, client_secret, grant_type, scope

Sample success response:

{
    "access_token":"eyJhdddsGciOiJSUzI1NiIsImtpZCI6IkJEQTFFRURDNjNDQkVDNDY4N0Q5MzdDNThCM0ZBQjYxIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2MjQ1NDIzMTgsImV4cCI6MTYyNDU0NTkxOCwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NDQzMTAiLCJhdWQiOiJQeVBheV9hcGkiLCJjbGllbnRfaWQiOiJQeVBheV9hcGkiLCJjbGllbnRfY3VzdeqvG9tZXJfaWQiOiJmYmViMzc4NS03MmEyLWViMTEtYTgxMy1kYzQxYTlmODczOWMiLCJjbGllbwwwfnRfY3VzdG9tZXJfdHlwZSI6IkNvcnBvcmF0ZSIsImNsaWVudF93ZWJzaXRlIjoiaHR0cDovL3d3dygw2445weWNzLmNvLmtlIiwianRpIjoiODcxMzlGOTZEMzJCNTRGNTA4OERCRTI4OTBCMkEyM0UiLCJpYXQiOjE2MjQ1NDIzMTgsInNjb3BlIjpbIlB5UGF5X2FwaSJdfQ.BifQbO6n9P_928WRN40qDJgvvdujFygWpbTmPIiOwPgG2uGlZzDeeVRguU6KseS4HuTZrZg2oWEnyTFG5gcH06m8Yd0sPdN5m441425IscbvcXE3sAn7Nbvs VHSMITl1rZdS1KNzbTWKzGV4l8AFTNLa4j63Z7aG73E6e1BrIHsP6dV0JUKTjXzBOyX6dmV0E4MuSHv9qyFk0YdlQkPw1NHtDYwOh___r88mNavaeKlsX1JMevq17MLXz3pfx2upH89KdoATdALBMjY7r8MSLslZCr1d-VmVeQaLq7heHvgtLIHsZlyqeeqeqkznKE6piL9wHScVtIgVmdNSVJVJAOIQgjHxn0oVnOOw",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "PyPay_api"
}

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST '/connect/token' \ --header 'Authorization: Bearer <token>' \ --data-urlencode 'client_id=GENERATED_CLIENT_ID' \ --data-urlencode 'client_secret=GENERATED_CLIENT_ID' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'scope=PyPay_api'

{ "access_token":"eyJhdddsGciOiJSUzI1NiIsImtpZCI6IkJEQTFFRURDNjNDQkVDNDY4N0Q5MzdDNThCM0ZBQjYxIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2MjQ1NDIzMTgsImV4cCI6MTYyNDU0NTkxOCwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NDQzMTAiLCJhdWQiOiJQeVBheV9hcGkiLCJjbGllbnRfaWQiOiJQeVBheV9hcGkiLCJjbGllbnRfY3VzdeqvG9tZXJfaWQiOiJmYmViMzc4NS03MmEyLWViMTEtYTgxMy1kYzQxYTlmODczOWMiLCJjbGllbwwwfnRfY3VzdG9tZXJfdHlwZSI6IkNvcnBvcmF0ZSIsImNsaWVudF93ZWJzaXRlIjoiaHR0cDovL3d3dygw2445weWNzLmNvLmtlIiwianRpIjoiODcxMzlGOTZEMzJCNTRGNTA4OERCRTI4OTBCMkEyM0UiLCJpYXQiOjE2MjQ1NDIzMTgsInNjb3BlIjpbIlB5UGF5X2FwaSJdfQ.BifQbO6n9P_928WRN40qDJgvvdujFygWpbTmPIiOwPgG2uGlZzDeeVRguU6KseS4HuTZrZg2oWEnyTFG5gcH06m8Yd0sPdN5m441425IscbvcXE3sAn7Nbvs VHSMITl1rZdS1KNzbTWKzGV4l8AFTNLa4j63Z7aG73E6e1BrIHsP6dV0JUKTjXzBOyX6dmV0E4MuSHv9qyFk0YdlQkPw1NHtDYwOh___r88mNavaeKlsX1JMevq17MLXz3pfx2upH89KdoATdALBMjY7r8MSLslZCr1d-VmVeQaLq7heHvgtLIHsZlyqeeqeqkznKE6piL9wHScVtIgVmdNSVJVJAOIQgjHxn0oVnOOw", "expires_in": 3600, "token_type": "Bearer", "scope": "PyPay_api" }

Sample success response:#

Request

Responses

Sample success response: