Log In

Attributes


sessionId string
Unique identifier for the session.


orderId string
Unique identifier for the transaction.


successURL string
Upon completing transaction in the native browser, the user will be redirected to this URL to return to your app.


cancelURL string
Upon cancelling transaction in the native browser, the user will be redirected to this URL to return to your app.


userEmail string
Email address of the Securo user.


type string, value is "deposit", "withdraw", "dex_swap", "dex_liquidity"
API action type of the transaction.


status string, value is "open", "expired", "completed"
Session status of the transaction.


livemode boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.


createdDate string
Date of transaction session created in ISO-8601 format.


expiredDate string
Date of transaction session is going to expire in ISO-8601 format.


amount string
Transaction amount of the session. The amount unit is used as shares (token) in product.


publicSessionId string
Session ID used to retrieve the session details.


chainId number
Unique identifier of blockchain network. See blockchain list for more information.


product object
Product details in the transaction.

Child attributes

    id number
    Unique identifier of the product.


    shortDesc string
    Description of the product.


    name string
    Name of the product.


    symbol string
    Symbol of the product.


transactionHashes array in string
Transaction hash of the transactions executed via the session.


value number
USD value of the transaction executed.


url string
Gateway URL to complete the transaction. It is a webview used for transaction execution in native browser.


additionalParams object
Additional details in the session.

Child attributes

    chainId number
    Unique identifier of blockchain network. See blockchain list for more information. (This is used for dex_swap and dex_liquidity session)


    isNative string
    The token used in this transaction session is either a native token of the blockchain network or not. (This is used for dex_swap and dex_liquidity session)


    exactIn string
    Determine either token input or token output is used for amount swap in calculating the amount output. (This is used for dex_swap session)


    pair string
    Symbol of pair used for manage liquidity. (This is used for dex_liquidity session)


    amount0 string
    Amount of pool token0. (This is used for dex_liquidity session)


    amount1 string
    Amount of pool token1. (This is used for dex_liquidity session)


    addLiquidity boolean
    Indicate whether to add or remove liquidity. (This is used for dex_liquidity session)


transactions array of objects
Transaction details in this transaction session. It will be shown when retrieving the session details. Multiple blockchain transactions are carried out in bulk at the same session.

Child attributes

    id number
    Unique identifier of transaction.


    createAt string
    Date of transaction created in ISO-8601 format.


    lastUpdatedAt string
    Date of last updated in the transaction in ISO-8601 format.


    timestamp string
    Transaction created in the timestamp milliseconds unit.


    lastUpdatedBy string
    Person to update the transaction.


    actionType string, value is "DEPOSIT", "WITHDRAW", "APPROVE", "SWAP"
    Action Type of the transaction.

📘

actionType

"APPROVE" is for approve and increase the ERC-20 allowance in smart contract, so allow the token to spend on the smart contract. See here for more information. "DEPOSIT" and "WITHDRAW" are used for Index Funds, "SWAP" is used for DeX swap


    description string
    Description of the transaction.


    transactionCategory string, value is "PRODUCT"
    Transaction category.


    currency string
    Transaction currency.


    status string, value is "PENDING", "FAILED", "SUCCESS"
    Transaction status.


    chainId number
    Unique identifier of blockchain network. See blockchain list for more information.


    actionBy string, "USER"
    User role is to execute the transaction.


    createdBy string
    Person executed the transaction in email address.


    webhookStatus string
    Webhook sent status in the transaction.


    amount string
    Transaction amount.


    value string
    Transaction value in the product. (Currently only for Index Funds)


    data string
    Data received from blockchain network for the transaction in JSON format.


    hash string
    Transaction hash in blockchain.


    gasFee string
    Gas fee used in the transaction.


{
        "id": 95,
        "sessionId": "VTJGc2RHVmtYMS9QV2VwTHdVWGNjaXNrZktmY0tmRXFnKzZWdHBCQjhaQWV2S1gyS1pOTzhVL0RkU3VjdHc5MQ",
        "orderId": "0225-229861-4790",
        "successURL": "https://google.com",
        "cancelURL": "https://google.com",
        "userEmail": "[email protected]",
        "type": "dex_swap",
        "status": "expired",
        "livemode": false,
        "createdDate": "2022-11-05T15:40:05.429Z",
        "expireDate": "2022-11-06T15:40:05.000Z",
        "updatedDate": "2022-11-05T15:41:07.000Z",
        "transactionHashes": [
            "0x662596e740b4ad2129098891f62e6b42ae35b0a2c299aef00a87b795d7d05920"
        ],
        "amount": "1000.000000000000000000",
        "value": "0.000000000000000000",
        "currentStep": 1,
        "publicSessionId": "VTJGc2RHVmtYMS9QV2VwTHdVWGNjaXNrZktmY0tmRXFnKzZWdHBCQjhaQWV2S1gyS1pOTzhVL0RkU3VjdHc5MQ==",
        "chainId": 5,
        "params": null,
        "product": {
            "shortDesc": "shortDesc",
            "name": "DEX_SWAP",
            "symbol": "DEX_SWAP"
        },
        "transactions": [
            {
                "id": 119,
                "createAt": "2022-11-05T15:40:30.242Z",
                "lastUpdatedAt": "2022-11-05T15:41:06.000Z",
                "timestamp": "1667662830241",
                "lastUpdatedBy": null,
                "actionType": "SWAP",
                "description": null,
                "transactionCategory": "PRODUCT",
                "currency": null,
                "status": "S",
                "isPendingProcess": false,
                "isLocked": false,
                "actionBy": "USER",
                "openingBalance": "0.000000000000000000",
                "closingBalance": "0.000000000000000000",
                "chainId": null,
                "createdBy": "[email protected]",
                "webhookStatus": "pending",
                "amount": "1000.000000000000000000",
                "value": "0.000000000000000000",
                "data": "{\"sender\":\"0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506\",\"to\":\"0x46d5D81D9C855ed58f35447cD0c1Dd0e07e967D2\",\"amount0In\":\"1000000000\",\"amount1In\":\"0\",\"amount0Out\":\"0\",\"amount1Out\":\"1337487\",\"event\":{\"transactionIndex\":101,\"blockNumber\":7897362,\"transactionHash\":\"0x662596e740b4ad2129098891f62e6b42ae35b0a2c299aef00a87b795d7d05920\",\"address\":\"0x4787DE7c7d4a55a8437C873045fee6908d7a0BFe\",\"topics\":[\"0xd78ad95fa46c994b6551d0da85fc275fe613ce37657fb8d5e3d130840159d822\",\"0x0000000000000000000000001b02da8cb0d097eb8d57a175b88c7d8b47997506\",\"0x00000000000000000000000046d5d81d9c855ed58f35447cd0c1dd0e07e967d2\"],\"data\":\"0x000000000000000000000000000000000000000000000000000000003b9aca0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014688f\",\"logIndex\":329,\"blockHash\":\"0xc806f22eb9cf77172d95b21d10588a61edf5f9e58b2b51727d15d6401b11ba29\"},\"status\":1}",
                "hash": "0x662596e740b4ad2129098891f62e6b42ae35b0a2c299aef00a87b795d7d05920",
                "gasFee": "0.000000000000000000",
                "paymentMethod": null,
                "referenceNumber": null
            }
        ]
    }