v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Login

Authentication endpoint

Use this endpoint to obtain an access token for calling Velo Payments APIs.

You need your API key and API secret issued by Velo

To login and get an access token the API key and API secret must be Base64 encoded by concatenating them with a colon between them

e.g. Given an ApiKey: 44a9537d-d55d-4b47-8082-14061c2bcdd8 and ApiSecret: c396b26b-137a-44fd-87f5-34631f8fd529

Using a Base64 encode function Base64Encoder().encode("44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529")

Included as a Basic Authorization header: -H "Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ=="

post/v1/authenticate

Query parameters

grant_typestring

OAuth grant type. Should use 'client_credentials'

Response

Valid Authenication response

access_tokenstring required
token_typestring required
expires_innumber
refresh_tokenstring
scopestring
entityIdsstring[]

Example response

{
  "access_token": "IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk",
  "refresh_token": "IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk",
  "scope": "example_scope",
  "token_type": "bearer",
  "expires_in": 1799,
  "entityIds": [
    "entityIds",
    "entityIds"
  ]
}
All 109 operations