Webhooks
The Revio API allows you to set up webhook URLs and programmatically set up callback events for the services you use. There is no limit to the number of webhooks you can set up.
Sample callback requests can be found in the reference material below:
Step 1: Create a Client callback URL
This request allows you to set up the URL for where you want all callback events to be sent to.
Reference | Link |
---|---|
Integration Recipe | /v2/clientcallbackurl |
Documentation | Swagger |
API Reference | Reference |
Sample request
{
"clientId": 109,
"url": "https://webhook.site/2f48e323-5793-4efa-a1a3-87c1c9980f70",
"callbackType": "EFT_COLLECTION",
"callbackVersion": "V2"
}
Content-type : application/json
Authorization : Bearer XXXXXXXXXXXXXXXXXXXXXXXXX
// As generated in Post https://dev-payce.auth.eu-west-1.amazoncognito.com/oauth2/token
Field notes
Field | Description |
---|---|
clientId | Can be returned using GET /v2/merchantprofile/ and referencing the createdByClient field |
url | Destination URL |
callbackType | DEBICHECK_COLLECTION, DEBICHECK_MANDATE, EFT_COLLECTION, EFT_PAYMENT |
Step 2: Create a callback event
This request allows you to access the events for initiating callbacks.
Reference | Link |
---|---|
Integration Recipe | v2/callback/collection/eft/ |
Documentation | Swagger |
API Reference | Reference |
Sample request
{
"collectionStatus": "UNPAID",
"callbackVersion": "V2"
}
Content-type : application/json
Authorization : Bearer XXXXXXXXXXXXXXXXXXXXXXXXX
// As generated in Post https://dev-payce.auth.eu-west-1.amazoncognito.com/oauth2/token
Step 3: Test callback status change
This request allows you to simulate callbacks on events. Common examples include changing a collection status from COMPLETED to UNPAID.
Reference | Link |
---|---|
Integration Recipe | /v2/callback/test/collection/eft/ |
Documentation | Swagger |
API Reference | Reference |
Sample request
{
"collectionStatus": "UNPAID",
"callbackVersion": "V2"
}
Content-type : application/json
Authorization : Bearer XXXXXXXXXXXXXXXXXXXXXXXXX
// As generated in Post https://dev-payce.auth.eu-west-1.amazoncognito.com/oauth2/token
Updated over 1 year ago