v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Authentication

token

Authenticates API integrators for every Aeropay endpoint.

Returns a transient JSON web token (JWT) to authorize access to the AeroPay API. Tokens last for 30 minutes and are required in the authorization header formatted as: Bearer {{token}}.

Scopes The scope parameter determines who is acting on the system and which endpoints are available:

  • merchant: Used for merchant calls. To obtain a merchant scoped token, the id parameter is required.
  • userForMerchant: Used to act on behalf of users created by your merchant. To obtain a userForMerchant scoped token, an additional userId is required along with all merchant credentials (api_key, api_secret, id).
<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP002401Invalid API key or secret key
AP006401Client not authorized for this scope
AP101401No authenticated user
AP700400Missing or invalid required parameter
AP701400Improperly formatted parameter
</details>
post/v2/token

Headers

Content-Typestring required

Request body

OR

Response

Success - Token generated

TTLinteger
tokenstring
All 31 operations