Elven Docs
English
English
  • Getting Started
  • System Configuration
    • Getting started with Elven
    • Project and Entities
      • Choose an Accounting Start Date
    • Inviting team members
    • Viewing activity logs
  • Financial Configuration
    • Configure Chart of Accounts
    • Configure Journal types
    • Configure Auxiliary Accounting
    • Setting Account Opening Balance
  • ACOUNT MANAGEMENT
    • Importing account balances
    • Importing transactions
      • Importing derivatives transactions
    • Verifying account balances
    • Counterparty Accounts Management
      • Managing counterparties
      • Automated counterparty identification
  • Transactions management
    • Transactions overview
  • Bookkeeping
    • Accounting with transaction data
      • Tagging of transactions
      • Rule based tagging
    • Accounting with business data
      • Importing business data using API
      • Importing business data with CSV file
      • Automated bookkeeping of business data
  • ASSETS AND VALUATIONS
    • Assets management
      • Add tokens via smart contract
      • Customising price feeds for assets
    • Fair value of Crypto assets and adjustments
    • Currency exchange (FX) PnL adjustment
    • Derivatives unrealized PnL adjustment
    • Broker business inventory management
  • RECONCILIATION
    • Transaction Reconciliation
  • REPORTS
    • Trial balance
    • Account Balance sheet
    • Financial statements
    • Crypto assets disclosure form
    • Dashboard
  • OpenAPI
    • Obtaining API Authorization
    • Import Business Data
    • Create Account
    • Query Account
    • Create Source
    • Query Source
    • Import Transfer
    • Import Trade
    • Import Gain/Loss
    • Import Account Balances
    • Import Price
    • Query Platform
    • Query Currency
    • Timezone
Powered by GitBook
On this page
  • API Overview
  • Request Headers
  • Request Parameters
  • Response Parameters
  • Notes

Was this helpful?

  1. OpenAPI

Import Transfer

PreviousQuery SourceNextImport Trade

Last updated 5 months ago

Was this helpful?

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.

timezone

String

No

list

Array

Yes

Transaction record list, containing multiple transaction objects, with a maximum of 1000 records supported per request.

Elements in the List

Parameter Name
Type
Required
Description

direction

String

Yes

IN or OUT, representing the direction of the transaction.

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 platform.type.

datetime

String

Yes

Transaction time, formatted as YYYY-MM-DD HH:mm:ss

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

{
    "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": "this is 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": ""
        }
    ]
}

Response Parameters

Parameter Name
Type
Description

success

Boolean

Upload Task Status

Example Response

{
    "success": true
}

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 format YYYY-MM-DD HH:mm:ss. Parsing errors may occur if the format is incorrect.

  • Transaction Type Validation: The type parameter must match the correct options based on the platform.type. Mismatched values may result in incorrect transaction classification.

Time Zone: If left empty, it will default to the entity’s time zone.

View Details
View Details