Skip to navigation

Webhook Creation

View as Markdown

API call to create a webhooks tied to your Interac account. The events shared via the webhook are related to the transaction status changes. New transactions will not fire a webhook.

Body parameters are required:
apiKey - [string] will be used in the webhook’s header data send to your webhool

authorizationHeaderName

url - your webhook URL incl. https://...

Response will include the id which can be used to delete a webhook if needed.

Sample webhook responses

{
"deposit": {
"id": "2ffb7139-0b50-4840-998b-3cafbe80ebfa",
"interacSenderEmail": "john.doe@example.com",
"interacRecipientEmail": "payments@example.com",
"postedAmount": "20.00",
"status": "SENT",
"referenceCode": "H3GZDLGI",
"memo": "ACME INC. Payment for Order #HJ68GY75",
"createdAt": "2025-11-27T14:51:28.198Z",
"postedAt": "2025-11-27T14:51:30.454Z"
},
"partner_balance": "NaN"
}
{
"deposit": {
"id": "c15702ab-88e6-41a1-8e29-86fbee76f077",
"interacSenderEmail": "john.smith@example.com",
"interacRecipientEmail": "payments@example.com",
"postedAmount": "11.11",
"status": "COMPLETED",
"referenceCode": "SBBI7VQY",
"memo": "ACME INC. Payment for Order #HJ6G5GD5",
"createdAt": "2025-11-27T17:24:24.724Z",
"postedAt": "2025-11-27T17:24:26.157Z"
},
"partner_balance": "11.11"
}

Headers

x-api-keystringOptional

Request

This endpoint expects an object.
apiKeystringRequired
authorizationHeaderNamestringRequired
urlstringRequiredformat: "uri"

Response headers

content-security-policystringOptional
x-dns-prefetch-controlstringOptional
x-download-optionsstringOptional
x-frame-optionsstringOptional
x-xss-protectionstringOptional
etagstringOptional
cross-origin-opener-policystringOptional
origin-agent-clusterstringOptional
x-permitted-cross-domain-policiesstringOptional
referrer-policystringOptional
x-content-type-optionsstringOptional
access-control-allow-credentialsstringOptional
cross-origin-resource-policystringOptional
strict-transport-securitystringOptional
access-control-allow-originstringOptional
apigw-requestidstringOptional
cf-cache-statusstringOptional
NelstringOptional
Report-TostringOptional
CF-RAYstringOptional

Response

Created
dataobject
successinteger