FX Conversion Failed

Triggered when an FX conversion between two currencies has failed.

https://<customerHost:Port>/webhook

Header

FieldDescription
Content-Typeapplication/json

Request example

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
        "customerHashId":"e9f74ac0-8fc5-4879-8ace-6ca2084ba250",
        "template":"FX_CONVERSION_FAILED_WEBHOOK",
        "cancellationFeeCurrencyCode":"USD",
        "systemReferenceNumber":"7526349341F",
        "errorMessage":"Partial failure",
        "walletHashId":"ebc26772-2d3e-4ab0-916a-3a7706a0c358",
        "conversionId":"conversion_1xVFhcSSdFLAyoKb9bKofR",
        "clientHashId":"8bf73eb1-99e7-4a76-8ef2-cdeac938593a",
        "status":"failed"
}'

Request body

FieldsDescriptionType
customerHashIdThe unique customer identifier that's generated on customer creation.UUID
templateSet to FX_CONVERSION_FAILED_WEBHOOK for this event.String
cancellationFeeCurrencyCodeThe currency code for the fee associated with the cancellation.String
systemReferenceNumberThe unique identifier that's generated by Nium to internally identify the conversion.UUID
errorMessageDetails the error that occurred during the FX conversion process.String
walletHashIdThe unique wallet identifier that's generated simultaneously with customer creation.UUID
conversionIdThe unique card identifier that's generated when creating a new conversion.UUID
clientHashIdThe unique client identifier that's generated and shared before API handshake.String
statusThe status of the conversion . This field is set to failed when the conversion of currencies has failed.String