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

id

string

The unique ID of the webhook event. This ID is in GUID format.

eventName

string

Webhook event being reported.

status

string

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

createdAt

string

Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

resources

object

The resources related to the event being triggered.

child attributes

paymentId

string

holds

string

Hold ID. Used to track the status of the hold put on the related international payment. This ID is in GUID format.

details

object

The event details.

child attributes

HoldId

string

Hold ID. Used to track the status of the hold put on the related international payment. This is in GUID format.

paymentId

string

holdType

string

The reason a hold was place on the payment.
Extended webhook event { "id": "2618e009-7339-41a8-bd4d-b0fb013a523b", "eventName": "International.Hold.Cleared", "status": "Pending", "partnerId": "e30bfd38-907a-45f1-b5b7-af08014c8e79", "createdAt": "2024-01-18T14:04:24.507-05:00", "resources": [ "international/v1/payments/aefff994-148e-4f28-9ddc-b0fb013610c7/holds/62a79dad-8e47-48a3-a707-b0fb0136137b" ], "details": [ { "holdId": "62a79dad-8e47-48a3-a707-b0fb0136137b", "paymentId": "aefff994-148e-4f28-9ddc-b0fb013610c7", "holdType": "InternalReview" } ] }

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

id

string

The unique ID of the webhook event. This ID is in GUID format.

eventName

string

Webhook event being reported.

status

string

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

createdAt

string

Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

resources

 

The resources related to the triggered event.

details

object

The event details.

child attributes

HoldId

string

Hold ID. Used to track the status of the hold put on the related international payment. This is in GUID format.

paymentId

string

holdType

string

The reason a hold was place on the payment.
Extended webhook event { "id": "9fd99994-f1e9-4b84-9386-b0fb01381f6f", "eventName": "International.Hold.Escalated", "status": "Pending", "partnerId": "e30bfd38-907a-45f1-b5b7-af08014c8e79", "createdAt": "2024-01-18T13:56:24.25-05:00", "resources": [ "international/v1/payments/aefff994-148e-4f28-9ddc-b0fb013610c7/holds/62a79dad-8e47-48a3-a707-b0fb0136137b" ], "details": [ { "holdId": "62a79dad-8e47-48a3-a707-b0fb0136137b", "paymentId": "aefff994-148e-4f28-9ddc-b0fb013610c7", "holdType": "InternalReview" } ] }

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

id

string

The unique ID of the webhook event. This ID is in GUID format.

eventName

string

Webhook event being reported

status

string

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

createdAt

string

Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

resources

 

The resources related to the triggered event

details

object

The event details.

child attributes

paymentId

string

Payment ID. This ID is the same paymentId as in the resource field and is the value for this attribute in the response to the originate a payment call. This ID is in GUID format.

productId

string

quoteId

string

fromCurrency

string

Currency the payment is sent in.

toCurrency

string

Currency the payment is received in.

fromAmount

string

toAmount

string

feeAmount

string

Requested fee taken from the sending account for payment, earned by the COS partner into their specified account. The priority transaction fee is added onto platform fee to get the total Transaction Fee.

accountNumber

string

status

string

Status of the payment. Always Completed

reason

string

clientIdentifier

string

priority

string

beneficiaryEntityType

string

Legal status of the beneficiary entity:

  • Individual

  • Company

The default value is individual

beneficiaryCompanyName

string

Name of the beneficiary company.

beneficiaryFirstName

string

First name of the beneficiary of the funds

beneficiaryLastName

string

Last name of the beneficiary of the funds

beneficiaryAddress

string

Beneficiary street address

beneficiaryCity

string

Beneficiary city

beneficiaryStateProvince

string

Beneficiary state or province

beneficiaryPostalCode

string

Beneficiary postal code

beneficiaryCountryCode

string

Beneficiary country code
Extended webhook event { "id": "9370fa9b-3e1e-4077-a1f9-b0fb013a7568", "eventName": "International.Payment.Sent", "status": "Pending", "partnerId": "e30bfd38-907a-45f1-b5b7-af08014c8e79", "createdAt": "2024-01-18T14:04:54.533-05:00", "resources": [ "international/v1/payments/aefff994-148e-4f28-9ddc-b0fb013610c7" ], "details": [ { "paymentId": "aefff994-148e-4f28-9ddc-b0fb013610c7", "productId": "e8164629-96ad-47d9-ba6a-af08014dd6d1", "quoteId": "b7f05b12-3205-4328-8eb6-b0fb0135fa26", "fromCurrency": "usd", "toCurrency": "eur", "fromAmount": "1026", "toAmount": "1075", "feeAmount": "1510", "accountNumber": "2283489405", "status": "Completed", "reason": null, "clientIdentifier": "string", "priority": "True", "beneficiaryEntityType": "Individual", "beneficiaryCompanyName": null, "beneficiaryFirstName": "John", "beneficiaryLastName": "Doe", "beneficiaryAddress": "1234 somewhere lane", "beneficiaryCity": "seattle", "beneficiaryStateProvince": "WA", "beneficiaryPostalCode": "98001", "beneficiaryCountryCode": "us" } ] }

Payment Canceled

International payment canceled at partner request

Extended webhook event details

id

string

The unique ID of the webhook event. This ID is in GUID format.

eventName

string

Webhook event being reported.

status

string

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

createdAt

string

Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

resources

 

The resources related to the triggered event.

details

object

The event details.

child attributes

paymentId

string

Payment ID. This ID is the same paymentId as in the resource field and is the value for this attribute in the response to the originate a payment call. This ID is in GUID format.

productId

string

quoteId

string

fromCurrency

string

Currency the payment is sent in.

toCurrency

string

Currency the payment is received in.

fromAmount

string

toAmount

string

feeAmount

string

Requested fee taken from the sending account for payment, earned by the COS partner into their specified account. The priority transaction fee is added onto platform fee to get the total Transaction Fee.

accountNumber

string

status

string

Status of the payment. Always Canceled

reason

string

clientIdentifier

string

priority

string

beneficiaryEntityType

string

Legal status of the beneficiary entity:

  • Individual

  • Company

The default value is individual.

beneficiaryCompanyName

string

Name of the beneficiary company.

beneficiaryFirstName

string

First name of the beneficiary of the funds.

beneficiaryLastName

string

Last name of the beneficiary of the funds.

beneficiaryAddress

string

Beneficiary street address.

beneficiaryCity

string

Beneficiary city.

beneficiaryStateProvince

string

Beneficiary state or province.

beneficiaryPostalCode

string

Beneficiary postal code.

beneficiaryCountryCode

string

Beneficiary country code.
Extended webhook event { "id": "9370fa9b-3e1e-4077-a1f9-b0fb013a7568", "eventName": "International.Payment.Canceled", "status": "Pending", "partnerId": "e30bfd38-907a-45f1-b5b7-af08014c8e79", "createdAt": "2024-01-18T14:04:54.533-05:00", "resources": [ "international/v1/payments/aefff994-148e-4f28-9ddc-b0fb013610c7" ], "details": [ { "paymentId": "aefff994-148e-4f28-9ddc-b0fb013610c7", "productId": "e8164629-96ad-47d9-ba6a-af08014dd6d1", "quoteId": "b7f05b12-3205-4328-8eb6-b0fb0135fa26", "fromCurrency": "usd", "toCurrency": "eur", "fromAmount": "1026", "toAmount": "1075", "feeAmount": "1510", "accountNumber": "2283489405", "status": "Canceled", "reason": null, "clientIdentifier": "string", "priority": "True", "beneficiaryEntityType": "Individual", "beneficiaryCompanyName": null, "beneficiaryFirstName": "John", "beneficiaryLastName": "Doe", "beneficiaryAddress": "1234 somewhere lane", "beneficiaryCity": "seattle", "beneficiaryStateProvince": "WA", "beneficiaryPostalCode": "98001", "beneficiaryCountryCode": "us" } ] }

Payment Returned

International payment was returned from the receiving bank

Extended webhook event details

id

string

The unique ID of the webhook event. This ID is in GUID format.

eventName

string

Webhook event being reported.

status

string

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

createdAt

string

Date and time the webhook even was created. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

resources

 

The resources related to the triggered event.

details

object

The event details.

child attributes

paymentId

string

This GUID format ID is not the same as the payment ID in the resource field because a returned is treated like a new payment and gets a different payment ID.

productId

string

quoteId

string

fromCurrency

string

Currency the payment is sent in.

toCurrency

string

Currency the payment is received in.

fromAmount

string

toAmount

string

feeAmount

string

Requested fee taken from the sending account for payment, earned by the COS partner into their specified account. The priority transaction fee is added onto platform fee to get the total Transaction Fee.

accountNumber

string

status

string

Status of the payment. Always Rejected

reason

string

clientIdentifier

string

priority

string

beneficiaryEntityType

string

Legal status of the beneficiary entity:

  • Individual

  • Company

The default value is individual.

beneficiaryCompanyName

string

Name of the beneficiary company.

beneficiaryFirstName

string

First name of the beneficiary of the funds.

beneficiaryLastName

string

Last name of the beneficiary of the funds.

beneficiaryAddress

string

Beneficiary street address.

beneficiaryCity

string

Beneficiary city.

beneficiaryStateProvince

string

Beneficiary state or province.

beneficiaryPostalCode

string

Beneficiary postal code.

beneficiaryCountryCode

string

Beneficiary country code.
Extended webhook event { "id": "9370fa9b-3e1e-4077-a1f9-b0fb013a7568", "eventName": "International.Payment.Rejected", "status": "Pending", "partnerId": "e30bfd38-907a-45f1-b5b7-af08014c8e79", "createdAt": "2024-01-18T14:04:54.533-05:00", "resources": [ "international/v1/payments/aefff994-148e-4f28-9ddc-b0fb013610c7" ], "details": [ { "paymentId": "aefff994-148e-4f28-9ddc-b0fb013610c7", "productId": "e8164629-96ad-47d9-ba6a-af08014dd6d1", "quoteId": "b7f05b12-3205-4328-8eb6-b0fb0135fa26", "fromCurrency": "usd", "toCurrency": "eur", "fromAmount": "1026", "toAmount": "1075", "feeAmount": "1510", "accountNumber": "2283489405", "status": "Rejected", "reason": null, "clientIdentifier": "string", "priority": "True", "beneficiaryEntityType": "Individual", "beneficiaryCompanyName": null, "beneficiaryFirstName": "John", "beneficiaryLastName": "Doe", "beneficiaryAddress": "1234 somewhere lane", "beneficiaryCity": "seattle", "beneficiaryStateProvince": "WA", "beneficiaryPostalCode": "98001", "beneficiaryCountryCode": "us" } ] }