Skip to content
Longport WhaleLongport Whale
Assets

Get Currency Exchange Records

Queries the currency exchange records of the current account with pagination. Supports filtering by status, source currency, target currency, and time range. Used to display the exchange record list; the currency exchange page also uses it to count submitted and processing exchanges.

GEThttps://api.lbkrs.com/v1/forex/converts/records

Parameters

account_channelstringqueryRequired

Broker channel

pageintegerquery

Page number, starting from 1. Broker App omits it when querying by time range (begin/end)

sizeintegerquery

Number of records per page. Broker App omits it when querying by time range (begin/end)

statusstringquery

Status filter. Separate multiple values with commas, such as "0,1". Values are the same as the response state: 0 submitted, 1 processing, 2 exchanged, 3 failed, 4 rejected, 5 cancelled

source_currencysstringquery

Source currency filter. Separate multiple values with commas. Available values come from source_currencys of the “Get Exchange Record Filter Currencies” operation

target_currencysstringquery

Target currency filter. Separate multiple values with commas. Available values come from target_currencys of the “Get Exchange Record Filter Currencies” operation

beginintegerquery

Start time, as a Unix timestamp (in seconds)

endintegerquery

End time, as a Unix timestamp (in seconds). Broker App passes 00:00 of the day after the selected end date

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get currency exchange records” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

List of exchange records

Child attributes
idinteger

Exchange record id, passed as id when querying the exchange details

fromstring

Source currency

tostring

Target currency

amountstring

Amount submitted by the user: the source amount when direction=forward, or the target amount when direction=reverse

order_idstring

Exchange order number, passed as order_id when cancelling the exchange

created_atinteger

Submission time, as a Unix timestamp (in seconds)

updated_atinteger

Update time, as a Unix timestamp (in seconds)

stateinteger

Exchange status: 0 submitted, 1 processing, 2 exchanged, 3 failed, 4 rejected, 5 cancelled

Values
0
1
2
3
4
5
estimate_timestring

Estimated number of business days required for processing, such as "1 ~ 2". Broker App uses it to display the estimated completion time when finish_time is empty

estimate_amountstring

Estimated amount: the estimated target amount when direction=forward, or the estimated source amount when direction=reverse

finish_timestring

Completion time, as a Unix timestamp (in seconds). In the submitted and processing states, it is the estimated completion time

finish_amountstring

Actual executed amount: the actual target amount when direction=forward, or the actual source amount when direction=reverse. It is empty or 0 before execution, in which case Broker App displays the estimate from estimate_amount instead

admin_remarkstring

Back-office remarks

directionstring

Exchange direction: forward for a forward exchange (submitted by source amount), reverse for a reverse exchange (submitted by target amount)

Values
forward
reverse
convert_effectiveboolean

Whether the exchange has been settled and taken effect. When state=2 and this field is false, Broker App displays “Exchanged (pending settlement)”

show_timestring

Display time, as a Unix timestamp (in seconds)

can_cancelboolean

Whether the exchange can be cancelled

originstring

Display text of the exchange origin (localized). A non-empty value means the exchange was initiated by the system (for example, automatic repayment); it is empty for manual exchanges by the user

ratestring

Exchange rate

reversal_ratestring

Reverse exchange rate, that is, the source currency amount equivalent to 1 unit of the target currency

reserve_nointeger

Scheduled exchange number

audit_statusinteger

Review status

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs