Import Transfers
API Overview
This API enables the batch import of transfer records into the system, supporting the import of multiple data entries in a single request.
Request Method:
POST
Request URL:
https://openapi.elven.com/open/v3/transaction/transfer
Request Headers
Parameter Name | Type | Required | Description |
---|---|---|---|
elven-api-key | String | Yes | The API key assigned to you |
elven-api-sign | String | Yes | Request signature, used to verify the legitimacy of the request |
elven-api-timestamp | String | Yes | Request timestamp, in milliseconds |
Request Parameters
Body Parameters (JSON Format)
Parameter Name | Type | Required | Description |
---|---|---|---|
entityAccountId | String | Yes | The primary key of the account. |
sourceId | String | Yes | The primary key of the source. |
list | Array | Yes | Transaction record list, containing multiple transaction objects, with a maximum of 1000 records supported per request. |
list 数组元素
Parameter Name | Type | Required | Description |
---|---|---|---|
direction | String | Yes |
|
amount | Number | Yes | The transaction amount. |
currency | String | Yes | Transaction currency, which can be obtained from the currency query API. Case-sensitive. |
transactionID | String | No | A unique identifier for the transaction. |
type | String | Yes | The transaction type, determined by the |
datetime | String | Yes | Transaction time, formatted as It will be processed according to the time zone set for the Entity. |
counterpartyAccountNo | String | No | The counterparty’s address or account. |
counterpartyPlatformId | String | No | The counterparty’s platform ID. |
memo | String | No | Additional information or notes for the transaction. |
type Parameter Options
For
platform.type = CHAIN
CHAIN_TRANSFER_IN
CHAIN_TRANSFER_OUT
CHAIN_TRANSACTION_FEE
For
platform.type = BANK
BANK_DEPOSIT
BANK_WITHDRAW
BANK_FEE
BANK_INCOMING_FX
BANK_OUTGOING_FX
For
platform.type = EXCHANGE
EXCHANGE_DEPOSIT
EXCHANGE_WITHDRAW
EXCHANGE_TRADE_IN
EXCHANGE_TRADE_OUT
EXCHANGE_FEE
EXCHANGE_STAKE
EXCHANGE_UNSTAKE
EXCHANGE_REWARD
EXCHANGE_REALIZED_PNL
EXCHANGE_BORROW
EXCHANGE_REPAY
EXCHANGE_FUNDING_FEE
EXCHANGE_TRANSFER_IN
EXCHANGE_TRANSFER_OUT
For
platform.type = CUSTODY
CUSTODY_DEPOSIT
CUSTODY_WITHDRAW
CUSTODY_FEE
For
platform.type = PAYMENT
PAYMENT_COMPLETED
PAYMENT_CHARGE_BACK
PAYMENT_REFUND
PAYMENT_FEE
PAYMENT_PAYOUT
PAYMENT_INCOMING_FX
PAYMENT_OUTGOING_FX
Example Request
Response Parameters
Parameter Name | Type | Description |
---|---|---|
success | Boolean | Upload Task Status |
Example Response
Notes
Asynchronous Processing: This API only imports the transaction data into a pre-processing database. The system processes the data asynchronously, and the imported transactions will appear in the user's transaction list after processing is complete.
Record Limit: Each request supports importing up to 1000 transaction records. For larger datasets, split them into multiple requests.
Data Integrity: Ensure the transaction data is complete and accurate to avoid import errors.
Datetime Format: The
datetime
field must strictly follow the formatYYYY-MM-DD HH:mm:ss
. Parsing errors may occur if the format is incorrect.Time Zone Alignment: The imported data will be aligned with the time zone of the associated
Entity
. If the source data uses a different time zone, it must be adjusted before import.Transaction Type Validation: The
type
parameter must match the correct options based on theplatform.type
. Mismatched values may result in incorrect transaction classification.
Last updated