API Documentation
Simulate Webhooks
1min
Below API can be used to simulate the webhooks which are triggered by Pay3's system. Webhooks are sent to the API endpoint shared during client onboarding in the webhooks payload format.
This API can be used for testing the back-end of client application asynchronously even when order is not being performed from UI.
The list for possible statuses can be found here.
Note: This does not create any state changes or orders in Pay3's system.
Simulate receiving webhook data
POST
Request
Header Parameters
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
requestId
String
required
Identifier that is created by Application's backend.
clientId
String
required
Client id. Application's identifier
orderId
String
required
This is the unique identifier in Pay3's system. This is equivalent to token shared in Create Order API's response.
orderStatus
String
required
This is the status for which you want to simulate webhook for. You will be receiving webhook data corresponding to this status
orderType
String
required
This represents the order type for which you want to simulate webhook. It can be CHECKOUT, PAYOUT etc.
eventType
String
required
This respresents the event type field, which is received in webhook. It should be passed as :
pay3-sdk-transaction-status : for payment related webhooks
pay3-sdk-login-status : for easy-sign related webhooks
errorCode
String
optional
This param accepts any one errorCode defined in SDK Errors
Updated 05 Feb 2025
Did this page help you?