š»API Documentation
API Specification Common Standards
Protocol Standards and Methods
Request Header
Signature
Build the content
Sign the content
NOTE
ā\nā is LF, ASCII value is '0x0A'
Parameter names are case-sensitive;
When checking returned data or a push notification signature, the transferred sign parameter is excluded in this signature as it is compared with the created signature.
When post the Json body, carefully check the quote, ' is not same as "
Merchant APIs
Base URL - <base_url> : api-azsit.purplepay.app
Authentication
Register as a merchant on PurplePay Dashboard with email and password
Purple Pay authentication API uses Bearer authorization. It should be included in the header
Generating JWT Token
End Point:
Method: POST
URL:
<base_url>/auth/token
Request Parameters:
Response:
Using the JWT Token
Once you have generated a JWT access token, you can use it to authenticate your requests.
The token should be included in the
Authorization
header with theBearer
keyword, like so:Replace
<your-jwt-token>
with your actual JWT token.Remember, all API requests must be made over HTTPS. Non-secure requests will fail.
Payments Config API
It returns details of supported chains and their details.
It also returns data to support and enrich classification around the different attributes of payments such as payment type (merchant, ecommerce, P2P etc).
Endpoint:
Method: GET
URL:
<base_url>/payments/chain_config
Create Checkout API
Payments API is used to create orders and generate counterfactual payment addresses to receive payments on different chains
Endpoint:
Method: POST
URL:
<base_url>/payments/burner_address
Request Parameters:
Response:
Payment Status API
The payment status and verification API tracks and updates the status of payments for the given Purple Pay order id.
Endpoint
Method: GET
URL:
<base_url>/payments/payment_verify/<payment_id>
This payment id can be purple pay payment_id or merchant user_order_id.
Request Parameters
payment_id in url path as mentioned above
Response:
Last updated