Register for webhook events
Registers you for webhook events. There is no option to sign up for individual webhooks.
Request attributes
|
requestId string The GUID that enables the application to link request with response Required |
|
|
callBackUrl string The value is a URL. Webhooks are reported to this URL as a result of a triggered action. Make sure the callback URL is added to our allowlist. SSL required. Required |
|
|
callBackUserName string Authentication data for webhook API calls if the server requires authentication Required |
|
|
callBackPassword string Authentication data for webhook API calls if the server requires authentication Required |
|
|
sourceSenderId string The GUID that identifies the merchant partner Required |
Sample request
{
"requestId": "R4J39QO2DC-YP3B-3BT2-5AC9-FFOP111SLGN0",
"callBackUrl": "string",
"callBackUserName": "string",
"callBackPassword": "string"
}Response attributes
|
registrationId string Unique registration ID for a webhook |
|
requestId string The GUID that enables the application to link request with response |
|
callBackUrl string The value is a URL. Webhooks are reported to this URL as a result of a triggered action. Make sure the callback URL is added to CR's allowlist. SSL required. |
|
callBackUserName string Authentication data for webhook API calls if the server requires authentication |
|
callBackPassword string Authentication data for webhook API calls if the server requires authentication |
|
subMerchantId string Identifier of the merchant partner |
|
isActive boolean True if the card is active, otherwise false |
|
deactivatedAt string Date and time card was deactivated, if relevant, in date-time format. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm] |
|
isInErrorState boolean True if the webhook is in error status, otherwise false |
|
errorStateReason string Reason the registration is in an error state |
|
detectedErrorStateAt string Time the error was detected. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm] |
Sample response
{
"registrationId": "hk76vsmh-k7hs-4ch6-7mks-nj76clk8h0xk",
"requestId": "7gmlpo54-sn87-2nlg-8clk-fhk90xmhu12x",
"callBackUrl": "www.yoururl.com",
"callBackUserName": "jroll",
"callBackPassword": "1234",
"merchantId": "hk7xmlhs-7lkc-a0cn-aluv-hk7xkg67c14l",
"isActive": true,
"deactivatedAt": "2020-12-16T09:31:35.622Z",
"isInErrorState": true,
"errorStateReason": "string",
"detectedErrorStateAt": "2020-12-16T09:31:35.622Z"
}
