API Documentation
Create Checkout Order
3min
This API creates a payin order to enable users to make checkout transactions. It accepts amount and currency details. On creating an order a dynamic token is returned from this api which is required to be passed to Pay3 Android SDK
This api requires access token that can be generated using Access Token API.
Create an order with payin details from application's backend
POST
Request
Header Parameters
signature
String
required
Signature generated with sha256 followed by base64 encoding. Check below section for more details
access-token
String
required
Access token received from Access token API. You can reuse the access token across multiple API calls till it is expired
Body Parameters
currencyId
String
required
This will be provided by Pay3 during onboarding
fiatAmount
String
required
Amount user have to Pay in string format. Maximum two decimal places are allowed
paymentMethodId
String
required
Unique string identifier. This will be provided by Pay3 during onboarding
email
String
required
User email to identify the user, which will be available in reporting dashboard
requestId
String
required
Identifier that is created by client application's backend. This will be passed in relevant events and webhooks from Pay3 to Application
clientId
String
required
Client id. Application's identifier
userId
String
optional
It is a type of UUID. It will used as unique identifier of the user. If this is not passed, email will be used as a unique identifier of the user within Pay3.
The request for creating checkout order requires a header signature. This can be generated using following code snippet.