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).
Error Glossary (click to expand)
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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
enum
required

Type of token requested

Allowed:
integer
required

Merchant Id. Required for merchant or userForMerchant token.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json