1.Interface description
- The white label self-developed service sets the webhook address through the white label backend. When subsequent specified events occur, data will be pushed to this interface
- After the data push fails, it will be pushed again every 3 seconds, and after 5 failed push attempts, it will no longer be pushed.
- The set webhook address must be provided to UPay for verification before it can be successfully pushed.
2.Request method
Request Method | POST |
Request Body | Using content type=application/json; Charset=UTF-8 format transmission |
3.Header parameter
Parameter | Type | Required | Describe |
---|---|---|---|
X-UPA-REQUESTID | String | true | Global unique request ID, kept unique for easy problem localization in the future |
X-UPA-TIMESTAMP | long | true | 13 digit timestamp, request initiation time |
4.Request body parameters
- Request body description
The request body content is encrypted using the public key set in the white label backend. - Card webhook events and data format
ReferenceCard
5.Response
The white label self-developed service receives a request and needs to respond within 5 seconds
- Success: The HTTP status code is equal to 200 and the response content is' SUCCESS'
- Failure: If timeout, HTTP status code is not equal to 200, or the return result is not 'SUCCESS', it will be judged as a failure by UPay
If the response result is judged as a failure, it will resend every 3 seconds, with a maximum of 5 resend attempts. White label self-developed services require appropriate idempotent processing to prevent business exceptions.