Cancel a conversion
Use this step-by-step guide to amend an existing conversion booking. Only conversion cancellations are currently supported using the Conversion amendments API.
- Obtain your access token API by authenticating to Airwallex using your unique Client ID and API key. You will need the access token to make API calls.
- Only post-funding mode is currently supported for conversion amendments. Contact your Airwallex Account Manager to enable post-funding mode. For more information on funding modes, see Funding and Settlement models.
- Follow the Create a conversion tutorial to create a future-dated conversion and save the
conversion_idreturned in the response.
Call Create an amendment quote API to retrieve an indicative financial adjustment resulting from the amendment. The amendment must be created prior to the conversion’s value date - you can check this by retrieving the
conversion_date field using Retrieve a conversion API.
Call Create an amendment API API to create a conversion amendment on a booked but unsettled conversion. Provide the
conversion_id and specify
CANCEL to cancel the conversion.
The financial adjustment resulting from the amendment is returned in the
charges object. A charge type will either be a
FEE will debit your account with any associated FX loss and a
CREDIT will credit your with any associated FX Gain. See Conversion Amendments for more information on how this is calculated.
If the response returns any errors, see Error codes to learn about the troubleshooting steps.