To initiate API requests for either payment collection or fund transfers, authorization is required.
Overview
OAuth2 is an open standard protocol for authorization that enables secure API authentication. It allows users to authenticate with third-party applications or services (in this case, Ubiqpay API) without revealing their login credentials. Instead, OAuth2 generates an access token that is used to authenticate API requests.
How to Use OAuth2 for Ubiqpay API
To use OAuth2 for authentication with our API, follow the steps below:
-
Obtain client ID and secret: To get started with OAuth2, you will need to obtain a client ID and secret from the Ubiqpay dashboard. These credentials will be used to authenticate your requests.
-
Request authorization: To request authorization, your application will need to send an authorization request. This request should include your client ID and secret.
-
Obtain an access token: Ubiqpay will issue an access token to your application. This token is used to authenticate API requests on behalf of the merchant.
-
Use the access token to authenticate API requests: To make an API request, you must include the access token in the request header. The Ubiqpay authorization server will validate the token to ensure the request is authorized.
OAuth2 Authorization Flow
The authorization flow for OAuth2 is as follows:
-
Your application sends an authorization request to Ubiqpay.
-
Ubiqpay validates your client ID and secret.
-
Ubiqpay issues an access token to your application.
-
Your application includes the access token in the request header of API requests.
-
Ubiqpay validates the access token and processes the API request.
For more information on using OAuth2 with Ubiqpay API, please get in touch with our support team.
We hope this OAuth2 authentication documentation helps you get started with our API!