OPEN BANKING DOCSTest webhook
Send a test webhook to verify the endpoint is working
X-API-Key<token>
In: header
Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidwebhookIdstring
ID of the webhook to test
eventTypestring
Event type to simulate
Value in
"TRANSACTION_COMPLETED" | "TRANSACTION_FAILED" | "ACCOUNT_CREATED" | "KYC_VERIFIED" | "PAYMENT_RECEIVED"testData?object | null
Optional test data to include in the webhook payload
Empty Object
Response Body
curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/webhooks/test" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "webhookId": "string", "eventType": "TRANSACTION_COMPLETED" }'{
"data": {
"testId": "string",
"webhookId": "string",
"eventType": "string",
"status": "SUCCESS",
"responseCode": 0,
"responseTime": 0,
"errorMessage": "string",
"sentAt": "2019-08-24T14:15:22Z",
"receivedAt": "2019-08-24T14:15:22Z"
}
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}