Preference Endpoints (api/Preference)
General Definitions
| Parameter | Description |
| baseurl |
Sandbox - https://test.xprizo.com/api |
| apiversion | 1.0 |
| apikey | API key For authentication |
Update Approval Webhook
Approval Webhook is triggered when a new pending transaction is created or when this pending transaction is approved, canceled, or rejected.
Request
curl --location --request PUT '{baseurl}/Preference/SetApprovalWebhook?url={url}' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}'| Parameter | Description |
| url | Url to receive callbacks |
Response (200)
Your callback URL must respond with JSON object {'status': 'success' } and HTTP code 200 to Xprizo.
Update Payment Webhook
Payment Webhook is triggered when a payment transaction with an action set to 2 (callback) is created.
Callbacks are only sent to the profile that created the transaction.
Callbacks will keep sending requests to the platform for 24 hours or until it gets a response.
If a 200 (success) response is received then the transaction will be processed.
If any other response (except a timeout) is received then the transaction will be voided.
Request
curl --location --request PUT '{baseurl}/Preference/SetPaymentWebhook?url={url}' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}'| Parameter | Description |
| url | Url to receive callbacks |
Response (200)