Get FX Delivery Status

Endpoint: GET /v2/gc/fx/orders/{requestId}/delivery

Description: Query the settlement delivery status of a completed FX order to confirm that the converted funds have been credited to the account.

Request

Request Body Field Descriptions (JSON)

Field Name	Type	Required	Description
N/A	N/A	N/A	GET request does not require a JSON body.

Request sample

// No request body required for this GET endpoint.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
state	number	State of the response.
data	object	FX delivery status detail.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

data object fields:

Field Name	Type	Description
requestId	string	Merchant-assigned request ID of the originating FX order.
fxOrderNumber	string	Platform-assigned FX order number for this settlement delivery.
status	string	Settlement delivery status. Enum: PENDING | COMPLETED.
currency	string	ISO 4217 currency code of the delivered (credited) amount.
amount	number	Amount delivered and credited to the account in currency.
deliveryDt	date string	Timestamp when the delivery was completed or is expected to complete (ISO 8601).

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "requestId": "d4e5f6a7-4444-5555-6666-ddeeff001122",
    "fxOrderNumber": "FX-20240815-00223344",
    "status": "COMPLETED",
    "currency": "CNH",
    "amount": 72815.00,
    "deliveryDt": "2024-08-17T09:00:00Z"
  },
  "message": "Successful",
  "neoResponseId": "de7750c5-772e-4136-ac78-62c57a106cce"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/fx/orders/{requestId}/delivery" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en"

Notes

• Requires Bearer token in the Authorization header.

• The Accept-Language header can be used to specify the response language (Support: "vi", "en").

• No request body required.

• Replace {requestId} with the merchant-assigned requestId used when creating the FX order.

• Poll this endpoint after the FX order reaches status=DELIVERING (confirmed via the Get Detail FX Order API) to track when funds are fully settled.

• status=PENDING indicates the delivery is in progress; status=COMPLETED indicates the funds have been credited.