Deposit Parameter Setups Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of atm_group_deposit_configs.yaml (the query capability).

Child attributes

filters.region_idstring

Bank Region. Values are dynamically queried from atm_regions_cnname (not fixed); fetch them live via GET /v1/datasets/refs/regions_cn_name.

filters.region_bank_idstring

Bank Name. Values are dynamically queried from atm_region_banks_all (not fixed); fetch them live via GET /v1/datasets/refs/region_banks_all.

filters.simple_namestring

Abbreviation Of Deposit Bank

filters.bank_operation_idstring

Deposit Method. Values are dynamically queried from bank_operation_types_in (not fixed); fetch them live via GET /v1/datasets/refs/deposit_channel_types.

filters.languagestring

Language. Options: en = English; zh-CN = Simplified Chinese; zh-HK = Traditional Chinese

enzh-CNzh-HK

filters.org_idstring

Broker. Values are dynamically queried from member_organizations_map (not fixed); fetch them live via GET /v1/datasets/refs/member_organizations.

filters.audit_statusstring

Approval Status. Options: new_pending_review = New to approve; delete_pending_review = Delete to approve; update_pending_review = Edit to approve; on_pending_review = List to approve; off_pending_review = Delist to approve; init = Initial

new_pending_reviewdelete_pending_reviewupdate_pending_reviewon_pending_reviewoff_pending_reviewinit

filters.statestring

Publish Status. Options: 1 = Active; 2 = Inactive; 99 = New

1299

filters.currencystring

Currency. Values are dynamically queried from global_currency_which_support_deposit (not fixed); fetch them live via GET /v1/datasets/refs/tenant_deposit_currencies.

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_group_deposit_configs/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}