WebsiteTwitterDiscord

🔁Query Transactions via API

Get all transactions for your account, a Pay Link ID & parameters like date and public key of sender

Get all transactions linked to your Helio account

   {
        "id": "66d9bd0caf43fcae24cf36e9",
        "txSignature": "5pkkAVVB6GbnN87cGXJabopyAQmTYFfPGw22c7NJ93qC8sE5YjpbH31xZkj9adTR1756SpSpBzFC9zyhu8HJT6z",
        "solScanLink": "https://solscan.io/tx/5pkkAVVB6GbnN87cGXJabopyAQmTYFfPGw22c7NJ93qC8sE5YjpbH31xZkj9adTR1756SpSpBzFC9zyhu8HJT6z?cluster=mainnet",
        "time": "2024-09-05T14:15:40.921Z",
        "amount": "99000",
        "decimalAmount": "0.000099",
        "totalAmountAsUSD": "13278",
        "convertedAmount": 0.000099,
        "currency": "SOL",
        "blockchain": "SOL",
        "from": "3Ci626jHVmDpHAA4KqWyUNVBwbFjTp7y28nLkNqjQz6Z",
        "intervalUnit": null,
        "transactionStatus": "SUCCESS",
        "fee": 1000,
        "createdAt": "2024-09-05T14:15:43.206Z",
        "updatedAt": "2024-09-05T14:15:43.206Z",
        "quantity": 1,
        "paymentRequestId": "660fbcd25c4ed562ba957ea1",
        "paymentRequestName": "simple sol ",
        "paymentRequestUrl": "https://app.hel.io/pay/660fbcd25c4ed562ba957ea1",
        "paymentRequestUrlWithSlug": null,
        "cancelAt": null,
        "startAt": null,
        "endAt": null,
        "transactionType": "PAYLINK",
        "affiliateFee": "0"
    },

Get transactions by Pay Link

  • API Endpoint: https://api.hel.io/v1/transactions/{paylinkId}/transactions

    • GET /transactions/{paylinkId}/transactionsURL - - (Replace {paylinkId} with the actual paylinkId of the Pay Link whose transactions you are querying_

  • HTTP Method: GET

  • Required Headers: Authorization: Bearer {{Your API Token here}}

Query Parameters

Parameter
Type
Required
Description

apiKey

String

Yes

Your Public API Key

from

String

No

The start of the time range for filtering transactions, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ).

to

String

No

The end of the time range for filtering transactions, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ).

senderPK

String

No

The public key of the sender to filter transactions by sender. Leave empty if you want all records.

Example URL with Query Parameters

https://api.hel.io/v1/transactions/66f1767b8103efe983304eb6/transactions?apiKey=_b._cBQ3zH4f7S~.~zEIjLyG.~QlKnCyy0YWhP8~6qXqkQMNui~7F3z0gI0DsQcd&from=2024-09-09T11:49:16.767Z&to=2024-09-26T18:49:16.767Z&senderPK=

Sample Response

[
    {
        "id": "66f585081e8e50f5bc5b7edb",
        "paylinkId": "66f1767b8103efe983304eb6",
        "fee": "100",
        "quantity": 1,
        "createdAt": "2024-09-26T16:00:08.913Z",
        "paymentType": "PAYLINK",
        "paylink": {
            "id": "66f1767b8103efe983304eb6",
            "platform": "HELIO",
            "description": "",
            "template": "PRODUCT",
            "disabled": false,
            "inactive": false,
            "notifySenderByEmail": false,
            "notifyReceiverByEmail": false,
            "addDiscordRole": false,
            "helioPlayProperties": {
                "media": {
                    "hosted": false,
                    "type": "VIDEO"
                }
            },
            "features": {
                "canChangeQuantity": false,
                "canChangePrice": false,
                "requireQuantityLimits": false,
                "requireCountry": false,
                "requireEmail": false,
                "requireDeliveryAddress": false,
                "requireDiscordUsername": false,
                "requireDiscordLogin": false,
                "requireFullName": false,
                "requirePhoneNumber": false,
                "requireTwitterUsername": false,
                "requireProductDetails": false,
                "requireMaxTransactions": false,
                "requireNftGate": false,
                "requireDiscordAuth": false,
                "requireAccessCode": false,
                "requireXFollow": false,
                "requireRaffle": false,
                "splitRevenue": false,
                "splitEqually": true,
                "canSwapTokens": false,
                "isHelioPlay": false,
                "isTransparentWallet": true,
                "nftDropEnabled": false,
                "showDiscountCode": false,
                "isEscrowed": false,
                "requireAllowlist": false,
                "requireTradingViewUsername": false,
                "allowAffiliate": false,
                "requireAirdrop": false,
                "isEventEnabled": false,
                "enableCountdown": false,
                "requireCaptchaValidation": false,
                "shouldRedirectOnSuccess": false
            },
            "maxTransactions": 1,
            "name": "test zhiro (1)",
            "nftCollectionAddress": "",
            "discordAuthDetails": [],
            "dynamic": false,
            "affiliateDetails": null,
            "price": "10000",
            "normalizedPrice": "10000",
            "redirectUrl": "",
            "content": {},
            "creator": {
                "id": "664b1f3e9f028c7c89185fcc",
                "userType": "MERCHANT",
                "email": "abhinav.bhardwaj@helio.co",
                "name": "Abhinav Bhardwaj",
                "isDisabled": false,
                "kycVerified": true,
                "platformDetails": {
                    "platform": "HELIO"
                }
            },
            "company": {
                "id": "664b1f3e9f028c7c89185fce",
                "name": "Helio",
                "email": "abhinav.bhardwaj@helio.co",
                "websiteUrl": "hel.io",
                "address": "",
                "phoneNumber": "",
                "escrowFunds": false,
                "tradingViewDetails": "66719cea1494feb4b47ac7e1",
                "twitterUsername": "AbhinavBha91144",
                "twitterConfirmed": true,
                "kycVerified": true,
                "kybVerified": false
            },
            "currency": {
                "id": "6340313846e4f91b8abc519b",
                "blockchain": null
            },
            "wallet": {
                "id": "664b1f3e9f028c7c89185fd6",
                "name": "",
                "btcProperties": null
            },
            "recipients": [
                {
                    "currency": {
                        "id": "6340313846e4f91b8abc519b",
                        "blockchain": null
                    },
                    "wallet": {
                        "id": "664b1f3e9f028c7c89185fd6",
                        "name": "",
                        "btcProperties": null,
                        "blockchainEngine": null
                    }
                }
            ],
            "volume": 0,
            "sales": "0",
            "product": null,
            "discountCodes": [],
            "discordRoleIds": [],
            "pricingCurrency": {
                "id": "6340313846e4f91b8abc519b",
                "name": "USD Coin",
                "decimals": 6,
                "order": 1,
                "mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
                "coinMarketCapId": 3408,
                "symbol": "USDC",
                "symbolPrefix": "$",
                "type": "DIGITAL",
                "iconUrl": "USDC.svg",
                "features": [
                    "PAYMENT_PRICING",
                    "PAYMENT_RECIPIENT",
                    "SWAP"
                ],
                "blockchain": {
                    "id": "6340313846e4f91b8abc515c",
                    "engine": null
                }
            }
        },
        "meta": {
            "id": "66f585081e8e50f5bc5b7ed9",
            "amount": "9900",
            "senderPK": "2exCMr65jmyp48SfTv1iykqEV7A8b4kLiJGai4a6TejP",
            "recipientPK": "2exCMr65jmyp48SfTv1iykqEV7A8b4kLiJGai4a6TejP",
            "transactionType": "PAYLINK",
            "transactionSignature": "2qv1zdPLQVY3mcq352jdXtCrjSPpwTWaZ4izCpA8XZ3VQ9zuZ2wMN57gCCQPhFFzRef3qNUt9WcyTum2wRqgt83i",
            "transactionStatus": "SUCCESS",
            "splitRevenue": false,
            "totalAmount": "9900",
            "totalAmountAsUSD": "9900",
            "tokenQuote": {
                "from": "USDC",
                "fromAmountDecimal": "0.01",
                "to": "USDC",
                "toAmountMinimal": "10000"
            }
        },
        "paymentRequestCurrencySymbol": "USDC",
        "paymentRequestBlockchain": "SOL"
    }
]

Response Parameters

Parameter
Type
Description

id

String

Unique identifier for the transaction.

paylinkId

String

The ID of the paylink the transaction is associated with.

You can also query the number of transaction for any given paymentRequestId using the following endpoint: https://api.hel.io/v1/paylink/id/volume

PreviousCreate Charges via APINextQuick start code examples

Last updated