Initiate FX order

After initialising and getting the response ID for a quote request, we will initiate the FX order. Initiating refers to confirming the FX request which creates an FX order.

Use case

We will confirm an FX request that we created.

Use case data	API parameters with values
The first path parameter is the technical ID of the account to which the payment is being made.	".../ID-1026/fx-quotes/..."
The second path parameter is the FX quote request ID that we got from initialising the request.	".../ID-1263/confirm/..."
The third path parameter is the quote response ID.	".../ID-1217"

Sample API call

To confirm the FX request, use the following endpoint:

https://payment-api.sandbox.tuumplatform.com/api/v1/accounts/ID-1026/fx-quotes/ID-1263/confirm/ID-1217

Learn more about the initiate FX order endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "quoteOrderId": "ID-1127",
    "quoteRequestId": "ID-1273",
    "quoteResponseId": "ID-1217",
    "statusCode": "WAITING_FOR_PROCESSING",
    "orderDtime": "2023-07-20T10:53:38.716275Z",
    "reservationId": "ID-5958",
    "paymentServiceProviderCode": "BC"
  }
}

Result

We have now confirmed the FX request and created a quote order which is in the status WAITING_FOR_PROCESSING. After the quote order is processed successfully by the service provider (in this case, Banking Circle), the status of the order is CONFIRMED.