The Get Status by Client Reference API allows clients to retrieve trade and payment status information using their own business reference instead of a StoneX fxId.
Many clients use their own unique payment identifiers throughout internal workflows, reconciliation systems and back-office processes. This endpoint removes the need to persist StoneX fxId and allows status information to be queried directly using the client reference supplied during trade booking or payment instruction submission
Clients can provide their own reference for a payment or trade using the clientReference field in the Book a Trade API.
Request:
URL: /api/v1/trade/status/?clientReference={clientReference}
Method: GET
clientReference: Unique identifier provided by the API client during trade booking.
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 |
For more details on each of the status values you can refer to the Get Status API.
Internal Server Error