Triggered when an FX conversion between two currencies is cancelled.
https://<customerHost:Port>/webhook
Field | Description |
---|
Content-Type | application/json |
curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
"customerHashId":"e9f74ac0-8fc5-4879-8ace-6ca2084ba250",
"template":"FX_CONVERSION_CANCELLED_WEBHOOK",
"cancellationFeeCurrencyCode":"USD",
"cancellationReason":"insufficient_fund",
"systemReferenceNumber":"7526349341F",
"cancellationComment":"Insufficient Funds",
"cancellationFee":5.82",
"walletHashId":"ebc26772-2d3e-4ab0-916a-3a7706a0c358",
"conversionId":"conversion_1xVFhcSSdFLAyoKb9bKofR",
"clientHashId":"8bf73eb1-99e7-4a76-8ef2-cdeac938593a",
"status":"cancelled"
}'
Fields | Description | Type |
---|
customerHashId | The unique customer identifier that's generated on customer creation. | UUID |
template | Set to FX_CONVERSION_CANCELLED_WEBHOOK for this event. | String |
cancellationFeeCurrencyCode | The currency code for the fee associated with the cancellation. | String |
cancellationReason | The reason for the cancellation of the FX conversion. | String |
systemReferenceNumber | The unique identifier that's generated by Nium to internally identify the conversion . | UUID |
cancellationComment | Additional comments regarding the cancellation. | String |
cancellationFee | The fee amount charged for the cancellation of the FX conversion. | String |
walletHashId | The unique wallet identifier that's generated simultaneously with customer creation. | UUID |
conversionId | The unique card identifier that's generated when creating a new conversion . | UUID |
clientHashId | The unique client identifier that's generated and shared before API handshake. | String |
status | The status of the conversion . This field is set to cancelled when the conversion of currencies has failed. | String |