Webhook events

7min

International payments webhook events
International webhooks return events after an API endpoint is called. The returned webhook event contains details relevant to the API call.
Event Name
Description
﻿International.Hold.Cleared  ﻿ 
Hold on the international payment has cleared and the funds have be sent to the receiver's bank account
﻿International.Hold.Escalated﻿ 
International payment is on hold and it's status was escalated. This is often used to indicate that additional actions are needed
﻿International.Payment.Sent﻿ 
International payment has been successfully sent to the receiving institution and the funds are available in the receiver's bank account
﻿International.Payment.Canceled﻿ 
International payment canceled at partner request
﻿International.Payment.Returned﻿ 
International payment was returned from the receiving bank
Hold Cleared
A hold on the international payment has cleared
Extended webhook event details
GET
Request
Body Parameters
id
String
required
The unique ID of the webhook event. This ID is in GUID format.
eventName
String
optional
Webhook event being reported
status
String
optional
The status of the webhook event. When you receive an event, it is always in Pending status and refers to the registration status (an event was created but not yet delivered), and not the resource status.
partnerId
String
optional
Your ID in the CR system. This ID is in GUID format.
createdAt
String
optional
Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
resources
Object
optional
The resources related to the event being triggered.
details
Object
optional
The event details.
﻿
Hold Escalated
International payment is on hold and it's status was escalated. This is often used to indicate that additional actions are needed
Extended webhook event details
GET
Request
Body Parameters
id
String
optional
The unique ID of the webhook event. This ID is in GUID format.
eventName
String
optional
Webhook event being reported.
status
String
optional
The status of the webhook event. When you receive an event, it is always in Pending status and refers to the registration status (an event was created but not yet delivered), and not the resource status
partnerId
String
optional
Your ID in the CR system. This ID is in GUID format.
createdAt
String
optional
Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
resources
String
optional
The resources related to the triggered event.
details
Object
optional
The event details.
﻿
Payment Sent
International payment has been successfully sent to the receiving institution and the funds are available in the receiver's bank account
Extended webhook event details
Get a cake by its ID
GET
Request
Body Parameters
id
String
optional
The unique ID of the webhook event. This ID is in GUID format.
eventName
String
optional
Webhook event being reported
status
String
optional
The status of the webhook event. When you receive an event, it is always in Pending status and refers to the registration status (an event was created but not yet delivered), and not the resource status.
partnerId
String
optional
Your ID in the CR system. This ID is in GUID format.
createdAt
String
optional
Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
resources
String
optional
The resources related to the triggered event
details
Object
optional
The event details
﻿
Payment Canceled
International payment canceled at partner request
Extended webhook event details
GET
Request
Body Parameters
id
String
optional
The unique ID of the webhook event. This ID is in GUID format.
eventName
String
optional
Webhook event being reported.
status
String
optional
The status of the webhook event. When you receive an event, it is always in Pending status and refers to the registration status (an event was created but not yet delivered), and not the resource status.
partnerId
String
optional
Your ID in the CR system. This ID is in GUID format.
createdAt
String
optional
Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
resources
String
optional
The resources related to the triggered event.
details
Object
optional
The event details.
﻿
Payment Returned
International payment was returned from the receiving bank
Extended webhook event details
GET
Request
Body Parameters
id
String
optional
The unique ID of the webhook event. This ID is in GUID format.
eventName
String
optional
Webhook event being reported.
status
String
optional
The status of the webhook event. When you receive an event, it is always in Pending status and refers to the registration status (an event was created but not yet delivered), and not the resource status.
partnerId
String
optional
Your ID in the CR system. This ID is in GUID format.
createdAt
String
optional
Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
resources
String
optional
The resources related to the triggered event.
details
Object
optional
The event details.
﻿
﻿

Event Name	Description
International.Hold.Cleared	Hold on the international payment has cleared and the funds have be sent to the receiver's bank account
International.Hold.Escalated	International payment is on hold and it's status was escalated. This is often used to indicate that additional actions are needed
International.Payment.Sent	International payment has been successfully sent to the receiving institution and the funds are available in the receiver's bank account
International.Payment.Canceled	International payment canceled at partner request
International.Payment.Returned	International payment was returned from the receiving bank

Updated 29 Jan 2025

Did this page help you?

International Payments

Error codes