Payment Transaction · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/booking_bilateral_cash_transactions

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

tx_nostring

Filters results by Tx no.

from_acctstring

Filters results by Payer.

to_acctstring

Filters results by Beneficiary.

currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

from_account_typestring

Filters results by Payment Account Type.

Allowed values: SETTLEMENT, BUSINESS, INTERNAL, EXTERNAL, EXCHANGE, SETTLEMENT_INTERNAL (SETTLEMENT INTERNAL), TEMPORARY

SETTLEMENT · SETTLEMENTBUSINESS · BUSINESSINTERNAL · INTERNALEXTERNAL · EXTERNALEXCHANGE · EXCHANGESETTLEMENT_INTERNAL · SETTLEMENT INTERNALTEMPORARY · TEMPORARY

to_account_typestring

Filters results by Collecting Account Type.

Allowed values: SETTLEMENT, BUSINESS, INTERNAL, EXTERNAL, EXCHANGE, SETTLEMENT_INTERNAL (SETTLEMENT INTERNAL), TEMPORARY

SETTLEMENT · SETTLEMENTBUSINESS · BUSINESSINTERNAL · INTERNALEXTERNAL · EXTERNALEXCHANGE · EXCHANGESETTLEMENT_INTERNAL · SETTLEMENT INTERNALTEMPORARY · TEMPORARY

from_biz_codestring

Filters results by Payment Business Type.

Values are dynamic. Call GET /v1/datasets/refs/biz_code_details to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

to_biz_codestring

Filters results by Collecting Business Type.

Values are dynamic. Call GET /v1/datasets/refs/biz_code_details to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

dtobject

Filters results by Accounting Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Payment Transaction records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

tx_nostring

Returned value: Tx No.

dtstring

Returned value: Accounting Date.

ledger_datestring

Returned value: Transaction Date. The date or time format follows the value returned by the API.

busi_channelstring

Returned value: Busi Channel.

from_acct_broker_codestring

Returned value: Payment AE code.

from_orgin_idstring

Returned value: From Orgin Id.

payer_account_typestring

Returned value: Payer Account Type.

payer_account_type_valstring

Raw value of payer_account_type. The payer_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_account_typestring

Returned value: Payment Account Type.

from_account_type_valstring

Raw value of from_account_type. The from_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_biz_codestring

Returned value: Payment Business Type.

from_biz_code_valstring

Raw value of from_biz_code. The from_biz_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_acct_broker_codestring

Returned value: Payee AE code.

to_orgin_idstring

Returned value: To Orgin Id.

beneficiary_account_typestring

Returned value: Beneficiary Account Type.

beneficiary_account_type_valstring

Raw value of beneficiary_account_type. The beneficiary_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_account_typestring

Returned value: Collecting Account Type.

to_account_type_valstring

Raw value of to_account_type. The to_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_biz_codestring

Returned value: Collecting Business Type.

to_biz_code_valstring

Raw value of to_biz_code. The to_biz_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Returned value: Currency.

amountstring

Returned value: Amount.

ref_nostring

Returned value: Business Serial No..

created_atstring

Returned value: Payment Date. The date or time format follows the value returned by the API.

withdraw_details_check_numberstring

Returned value: Check Number.

quantitystring

Returned value: Quantity.

codestring

Returned value: Code.

exchange_ratestring

Returned value: Exchange Rate.

operational_periodstring

Returned value: Operational Period.

business_sourcesstring

Returned value: Business Sources.

business_sources_valstring

Raw value of business_sources. The business_sources field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_namestring

Returned value: Bank Name.

fee_typestring

Returned value: Fee Type.

exercising_pricestring

Returned value: Exercising price.

remarkstring

Returned value: Remark.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_bilateral_cash_transactions' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "tx_no": "string",
        "dt": "string",
        "ledger_date": "string",
        "busi_channel": "string",
        "from_acct_broker_code": "string",
        "from_orgin_id": "string",
        "payer_account_type": "string",
        "payer_account_type_val": "string",
        "from_account_type": "string",
        "from_account_type_val": "string",
        "from_biz_code": "string",
        "from_biz_code_val": "string",
        "to_acct_broker_code": "string",
        "to_orgin_id": "string",
        "beneficiary_account_type": "string",
        "beneficiary_account_type_val": "string",
        "to_account_type": "string",
        "to_account_type_val": "string",
        "to_biz_code": "string",
        "to_biz_code_val": "string",
        "currency": "string",
        "amount": "string",
        "ref_no": "string",
        "created_at": "string",
        "withdraw_details_check_number": "string",
        "quantity": "string",
        "code": "string",
        "exchange_rate": "string",
        "operational_period": "string",
        "business_sources": "string",
        "business_sources_val": "string",
        "bank_name": "string",
        "fee_type": "string",
        "exercising_price": "string",
        "remark": "string"
      }
    ],
    "total": 0
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_bilateral_cash_transactions/download

Export options Export records Download result