🔁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

• API Endpoint: https://api.hel.io/v1/export/payments?apiKey=

• HTTP Method: GET

• Required Query Parameters: ?apiKey={{Your public key here}}

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

• Response body:

   {
        "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/paylink/{paylinkId}/transactions?apiKey=

Replace {paylinkId} with the actual ID of the Pay Link for which you are querying transactions.

• 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/paylink/675ad9efb3d52968361449bd/transactions?apiKey=0vGtLmJ0uf04hHLiARrs6vcY79GZWi9~D1W4_mjvKrMqnFpZ5w1MPo2NvrM9ZHYq&from=2024-01-16T15:30:00.000Z&to=2025-01-16T15:30:00.000Z

Sample Response

[
    {
        "id": "6788da72322ba9fa20315693",
        "paylinkId": "675ad9efb3d52968361449bd",
        "fee": "1000",
        "quantity": 1,
        "createdAt": "2025-01-16T10:07:46.671Z",
        "paymentType": "PAYLINK",
        "paylink": {
            "id": "675ad9efb3d52968361449bd",
            "platform": "HELIO",
            "description": "",
            "template": "OTHER",
            "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,
                "requireTelegramUsername": 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,
                "customThemeEnabled": false,
                "isSubscription": false
            },
            "maxTransactions": 1,
            "name": "SOL Test",
            "nftCollectionAddress": "",
            "discordAuthDetails": [],
            "dynamic": false,
            "affiliateDetails": null,
            "price": "100000",
            "normalizedPrice": "100000",
            "redirectUrl": "",
            "customTheme": {
                "primaryColor": "#F76C1B",
                "neutralColor": "#5A6578",
                "themeMode": "LIGHT",
                "textColorOnButton": "BLACK",
                "backgroundColor": "#F9F9F9"
            },
            "subscriptionDetails": {
                "renewalReminders": 3,
                "gracePeriod": 2,
                "annualDiscountBps": 0,
                "interval": "MONTH"
            },
            "content": {},
            "creator": {
                "id": "667c1f9352919e407156128a",
                "userType": "MERCHANT",
                "email": "[e-mail]",
                "name": "",
                "isDisabled": false,
                "kycVerified": false,
                "platformDetails": {
                    "platform": "HELIO"
                }
            },
            "company": {
                "id": "667c1f9352919e407156128c",
                "name": "Helio",
                "email": "[e-mail]",
                "websiteUrl": "",
                "discordUsername": "",
                "address": "",
                "phoneNumber": "",
                "escrowFunds": false,
                "tradingViewDetails": "66ab698681063452ebd41ba0",
                "twitterConfirmed": false,
                "kycVerified": false,
                "kybVerified": false
            },
            "currency": {
                "id": "6340313846e4f91b8abc5195",
                "blockchain": null
            },
            "wallet": {
                "id": "667c1f9352919e4071561294",
                "name": "",
                "btcProperties": null
            },
            "recipients": [
                {
                    "currency": {
                        "id": "6340313846e4f91b8abc5195",
                        "blockchain": null
                    },
                    "wallet": {
                        "id": "667c1f9352919e4071561294",
                        "name": "",
                        "btcProperties": null,
                        "blockchainEngine": null
                    }
                }
            ],
            "volume": 0,
            "sales": "0",
            "product": null,
            "discountCodes": [],
            "discordRoleIds": [],
            "pricingCurrency": {
                "id": "6340313846e4f91b8abc5195",
                "name": "Solana",
                "decimals": 9,
                "order": 2,
                "mintAddress": "11111111111111111111111111111111",
                "coinMarketCapId": 5426,
                "symbol": "SOL",
                "symbolPrefix": "",
                "type": "DIGITAL",
                "iconUrl": "SOL.svg",
                "features": [
                    "PAYMENT_PRICING",
                    "PAYMENT_RECIPIENT",
                    "SWAP"
                ],
                "blockchain": {
                    "id": "6340313846e4f91b8abc515c",
                    "engine": null
                }
            }
        },
        "meta": {
            "id": "6788da72322ba9fa20315691",
            "amount": "99000",
            "senderPK": "89ZFMYrbVFA8vwuw1wzPHQBHYCJsPuMpE9izfcKeb5Qp",
            "recipientPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
            "transactionType": "PAYLINK",
            "customerDetails": {
                "discordUser": null
            },
            "productDetails": null,
            "additionalProductDetails": [],
            "transactionSignature": "3SVuVuNFB7UNieU4ed7RbEZmaiNydywrEBQmfKeCLyGVUTvbbzRrgwRFCkugBgLDh9LGiFnG9RTgy7GLxPgM2EiY",
            "transactionStatus": "SUCCESS",
            "splitRevenue": false,
            "remainingAccounts": [],
            "totalAmount": "99000",
            "totalAmountAsUSD": "19880",
            "affiliateAmount": "0",
            "tokenQuote": {
                "from": "SOL",
                "fromAmountDecimal": "0.0001",
                "to": "SOL",
                "toAmountMinimal": "100000"
            },
            "shopifyPaymentDetails": null,
            "submitGeolocation": "GB",
            "currency": {
                "id": "6340313846e4f91b8abc5195",
                "name": "Solana",
                "decimals": 9,
                "order": 2,
                "mintAddress": "11111111111111111111111111111111",
                "coinMarketCapId": 5426,
                "symbol": "SOL",
                "symbolPrefix": "",
                "type": "DIGITAL",
                "iconUrl": "SOL.svg",
                "features": [
                    "PAYMENT_PRICING",
                    "PAYMENT_RECIPIENT",
                    "SWAP"
                ]
            }
        },
        "paymentRequestCreatorId": "667c1f9352919e407156128a",
        "paymentRequestName": "SOL Test",
        "paymentRequestCurrencySymbol": "SOL",
        "paymentRequestBlockchain": "SOL",
        "refunds": []
    }
]

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