get https://api.sandbox.payments.stonex.com/api/v/trade//status
The Status API retrieves the status of a Foreign Exchange (FX) payment using the fxId provided in the request URL. The response includes details such as the trade status, reimbursement status, payment status, and other relevant fields such as GPI code and GPI status (when available).
Request
URL: /api/v{version}/trade/{fxId}/status
Method: GET
fxId: Unique identifier of the FX payment for which the status is requested.
Response
The response will be in JSON format and contain the following fields:
| Field Name | Type | Description |
|---|---|---|
| fxId | String | Unique internal identifier for the trade generated by StoneX |
| clientReference | String | External client reference |
| tradeStatus | String | Status of the FX trade |
| uetr | String | End to End tracking code generated by StoneX |
| reimbursementStatus | String | Reimbursement status of the trade |
| paymentStatus | String | Payment status of the instruction |
| paymentStatusDescription | String | Detailed status of the payment instruction |
| gpiCode | String | Swift GPI code |
| gpiStatus | String | Swift GPI status |
| tradeDate | Date(YYYY-MM-DD) | Date |
| valueDate | Date(YYYY-MM-DD) | Value date of the payment |
Trade Status Values
| Value | Description |
|---|---|
| PENDING | We have received the trade but it hasn't been executed |
| PENDINGINSTRUCTION | The foreign exchange trade has been executed but payment instruction is not received |
| EXECUTED | Payment instruction has been received and executed for the trade |
| CANCELLATIONREQUESTED | You have requested to cancel the trade and this is under review |
| CANCELLED | The trade has been cancelled |
Reimbursement Status Values
| Value | Description |
|---|---|
| PENDING | Reimbursement for the trade is pending. |
| SETTLED | Reimbursement for the trade is completed. |
Payment Status Values
| Value | Description |
|---|---|
| Processing | StoneX processing the payment |
| Released | Released to the local banking network |
| InProgress | In progress within the local banking network |
| Completed | Delivered to the beneficiary’s account |
| Rejected | Rejected by the local banking network |
| Invalid | Issue encountered within Swift GPI |
| Cancelled | The payment has been cancelled |