Conversions

Subscribe to webhook events for conversion status changes.

The following webhook events are available for your Transactional FX integration.

This page describes conversion webhooks for API version 2024-06-30 or later. For older API versions, see conversion webhooks (legacy API versions).

Event	Description
conversion.scheduled	The conversion has been booked and scheduled for settlement on the conversion date.
conversion.overdue	The settlement attempt has failed due to insufficient funds in the sell currency Wallet past settlement cut-off time for customers in post-funded mode.
conversion.settled	Funds have been settled in the wallet.
conversion.cancelled	Conversion was cancelled. Funds have returned to client's Wallet.

Payload examples

Relevant webhook events:

conversion.scheduled
conversion.overdue
conversion.settled
conversion.cancelled

Payload example:

JSON

1{
2    "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name":"conversion.scheduled",
6    "createdAt": "2024-06-30T00:20:09+0000"
7}

data is the response body of Get a specific conversion API:

The default style of the variables is camel case.

JSON

1{
2  "accountId": "acct_5yqx_Op2PfeQovpAh7f5sg",
3  "createdAt": "2024-07-02T10:19:50+0000",
4  "data": {
5    "requestId": "request1",
6    "conversionId": "e2adde18-9b6c-11ec-b909-0242ac120002",
7    "shortReferenceId": "C240702-2L07EVZ",
8    "status": "SCHEDULED",
9    "currencyPair": "AUDUSD",
10    "clientRate": 0.750002,
11    "awxRate": 0.75,
12    "midRate": 0.74998,
13    "buyCurrency": "USD",
14    "buyAmount": 10000,
15    "sellCurrency": "AUD",
16    "sellAmount": 7500.02,
17    "dealtCurrency": "USD",
18    "conversionDate": "2024-07-02",
19    "settlementCutoffTime": "2024-07-02T14:00:00+0000",
20    "createdAt": "2024-07-02T10:19:50+0000",
21    "updatedAt": "2024-07-02T10:19:50+0000",
22    "clientData": null,
23    "batchId": null,
24    "quoteId": null,
25    "rateDetails": [
26      {
27        "level": "AWX",
28        "rate": 0.75,
29        "buyAmount": 10000,
30        "sellAmount": 7500
31      },
32      {
33        "level": "PLATFORM",
34        "rate": 0.750002,
35        "buyAmount": 10000,
36        "sellAmount": 7500.02
37      },
38      {
39        "level": "PLATFORM_CLIENT",
40        "rate": 0.750005,
41        "buyAmount": 10000,
42        "sellAmount": 7500.05
43      }
44    ],
45    "fundingSource": {
46      "id": "fundingId1",
47      "debitType": "FASTERDD"
48    },
49    "funding": {
50      "fundingSourceId": "fundingId1",
51      "debitType": "FASTERDD",
52      "status": "PROCESSING"
53    },
54    "applicationFeeOptions": [
55      {
56        "sourceType": "CONVERSION",
57        "type": "PERCENTAGE",
58        "percentage": 0.1
59      }
60    ],
61    "applicationFees": [
62      {
63        "sourceType": "CONVERSION",
64        "currency": "AUD",
65        "amount": 0.03
66      }
67    ]
68  },
69  "id": "65104bee-8417-46b2-a3b4-3144ec90b0c2",
70  "name": "conversion.scheduled"
71}

Was this page helpful?