导入交易接口

接口概述

该接口用于批量导入交易记录到系统中,支持一次性导入多条交易数据。

  • 请求方式POST

  • 请求 URLhttps://openapi.elven.com/open/v3/transaction/transfer

请求头参数

参数名类型必填说明

elven-api-key

String

分配给您的API密钥

elven-api-sign

String

请求签名,用于验证请求合法性

elven-api-timestamp

String

请求时间戳,毫秒级

查看详细说明

请求参数

Body 参数(JSON 格式)

参数名类型必填说明

entityAccountId

String

账户的主键 ID

sourceId

String

Source 的主键 ID

list

Array

交易记录列表,包含多个交易对象,每次最多支持 1000 条记录

list 数组元素

参数名类型必填说明

direction

String

交易方向,IN(收入)或 OUT(支出)

amount

Number

交易金额

currency

String

交易币种,可从币种查询接口获取

区分大小写

transactionID

String

交易哈希或唯一标识

type

String

交易类型,根据平台类型(platform.type)进行区分,详见下方说明

datetime

String

交易时间,格式为 YYYY-MM-DD HH:mm:ss 将按照 Entity 设置的时区进行处理

counterpartyAccountNo

String

对手方的地址或账号

counterpartyPlatformId

String

对手方的平台 ID

memo

String

备注信息

type 参数说明

  • platform.typeCHAINtype 可选值:

    • CHAIN_TRANSFER_IN

    • CHAIN_TRANSFER_OUT

    • CHAIN_TRANSACTION_FEE

  • platform.typeBANKtype 可选值:

    • BANK_DEPOSIT

    • BANK_WITHDRAW

    • BANK_FEE

    • BANK_INCOMING_FX

    • BANK_OUTGOING_FX

  • platform.typeEXCHANGEtype 可选值:

    • 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

  • platform.typeCUSTODYtype 可选值:

    • CUSTODY_DEPOSIT

    • CUSTODY_WITHDRAW

    • CUSTODY_FEE

  • platform.typePAYMENTtype 可选值:

    • PAYMENT_COMPLETED

    • PAYMENT_CHARGE_BACK

    • PAYMENT_REFUND

    • PAYMENT_FEE

    • PAYMENT_PAYOUT

    • PAYMENT_INCOMING_FX

    • PAYMENT_OUTGOING_FX

请求示例

{
    "entityAccountId": "accountId123",
    "sourceId": "sourceId456",
    "list": [
        {
            "direction": "IN",
            "amount": 10,
            "currency": "BTC",
            "transactionID": "0xaaa",
            "type": "CHAIN_TRANSFER_IN",
            "datetime": "2024-01-01 01:11:11",
            "counterpartyAccountNo": "0xsss",
            "counterpartyPlatformId": "platformId789",
            "memo": "交易备注"
        },
        {
            "direction": "OUT",
            "amount": 5,
            "currency": "ETH",
            "transactionID": "0xbbb",
            "type": "CHAIN_TRANSFER_OUT",
            "datetime": "2024-01-02 02:22:22",
            "counterpartyAccountNo": "0xttt",
            "counterpartyPlatformId": "platformId012",
            "memo": "另一笔交易备注"
        }
    ]
}

响应参数

参数名类型说明

success

Boolean

导入任务是否成功

响应示例

{
    "success": true
}

注意事项

  1. 异步处理:该接口调用成功后只是将数据导入到预处理数据库,系统需要一段时间来处理导入的交易数据,处理完成后才会显示在用户交易列表内。

  2. 记录数量限制:每次请求最多支持导入 1000 条交易记录。

  3. 数据完整性:请确保提供的交易数据完整且准确,避免因数据错误导致导入失败。

  4. 时间格式datetime 参数的格式必须严格按照 YYYY-MM-DD HH:mm:ss,否则可能导致解析错误。

  5. 时区说明:数据导入时,时区将和 Entity 设置的时区保持一致。如原始数据的时区和 Entity 时区不一致,需在导入前处理。

  6. 交易类型type 参数必须根据对应的 platform.type 选择正确的值,否则可能导致交易分类错误。

最后更新于