> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hel.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a Transaction by Shopify Payment ID
> Retrieve the details of a transaction using its Shopify payment ID.
**Note:** When using the production environment at [moonpay.hel.io](http://app.hel.io), set your API endpoint to `api.hel.io/v1` and generate API keys there. For the development environment, use `api.dev.hel.io/v1` and generate API keys from [moonpay.dev.hel.io](http://app.dev.hel.io).
## OpenAPI
````yaml GET /v1/transactions/shopify/paymentid/{id}
openapi: 3.0.0
info:
title: Helio Open API
description: |-
API schema and definitions for Helio API.
The API is using two types of Authentication, for dashboard endpoints we use JSON Web Token (JWT) that is generated by self custodial wallet signing a message from API.
We also support authentication with API Key and Secret which can be generated on Helio dashboard.
version: 1.0.0
contact: {}
servers:
- description: Helio API (Mainnet)
url: https://api.hel.io
- description: Helio API (Devnet)
url: https://api.dev.hel.io
security: []
tags:
- name: Webhooks
- name: Exports
- name: Currencies
description: >-
Supported currencies endpoint, includes fiat and digital assets
Authentication: None
externalDocs:
description: Helio product documentation
url: https://docs.hel.io/
paths:
/v1/transactions/shopify/paymentid/{id}:
get:
tags:
- Transactions
summary: Get a Transaction by Shopify Payment ID
description: Retrieve the details of a transaction using its Shopify payment ID.
operationId: TransactionsController_getTransactionByShopifyPaymentId
parameters:
- name: id
in: path
required: true
description: The Shopify payment ID used to look up the transaction.
schema:
type: string
- name: apiKey
in: query
required: true
description: >-
Your API key can be generated on the Helio Dashboard's settings
page.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
examples:
success:
summary: Shopify transaction details
value:
id: 664f2616061dddf20b640691
paylinkId: 664f25cdde5492e5c4640c08
fee: '1999'
quantity: 1
createdAt: '2024-05-23T11:18:46.478Z'
paymentType: PAYLINK
paylink:
id: 664f25cdde5492e5c4640c08
platform: HELIO
template: SHOPIFY
disabled: false
inactive: false
notifySenderByEmail: false
notifyReceiverByEmail: false
addDiscordRole: false
addTelegramGroup: false
addStripeApiKey: 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
requireAdditionalProductDetails: false
requireMaxTransactions: false
requireNftGate: false
requireDiscordAuth: false
requireAccessCode: false
requireXFollow: false
requireRaffle: false
splitRevenue: false
splitEqually: false
canSwapTokens: false
canPayWithCard: true
isHelioPlay: false
isTransparentWallet: false
nftDropEnabled: false
showDiscountCode: true
isEscrowed: false
requireAllowlist: false
requireTradingViewUsername: false
allowAffiliate: false
requireAirdrop: false
isEventEnabled: false
enableCountdown: false
requireCaptchaValidation: false
shouldRedirectOnSuccess: false
customThemeEnabled: false
isSubscription: false
hasRedirectQueryParams: false
hasStripeApiKey: false
showDetailsForCharge: false
maxTransactions: 1
name: Shopify Paylink
discordAuthDetails: []
dynamic: true
minQuantity: 1
maxQuantity: 1
affiliateDetails: null
price: '0'
normalizedPrice: '0'
redirectUrl: ''
redirectQueryParams: []
customTheme:
primaryColor: '#FE5300'
neutralColor: '#5A6578'
themeMode: LIGHT
textColorOnButton: BLACK
backgroundColor: '#F9F9F9'
content:
text: null
creator:
id: 664f24c9061dddf20b63fdf2
userType: MERCHANT
isDisabled: false
kycVerified: false
platformDetails: null
company:
id: 664f24c9061dddf20b63fdf4
escrowFunds: false
twitterConfirmed: false
kycVerified: false
kybVerified: true
onrampDirectlyToMerchant: true
currency:
id: 63430c8348c610068bcdc482
name: USD Coin
decimals: 6
order: 100
mintAddress: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
wallet:
id: 664f25cdde5492e5c4640bde
name: Shopify Wallet
publicKey: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
btcProperties: null
recipients:
- currency:
id: 63430c8348c610068bcdc482
name: USD Coin
decimals: 6
order: 100
mintAddress: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
wallet:
id: 664f25cdde5492e5c4640bde
publicKey: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
name: Shopify Wallet
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
- currency:
id: 63fdfb232c62da4b72b2d5b6
name: USD Coin
decimals: 6
order: 150
mintAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238'
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc443
name: ETH
symbol: ETH
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 63b6d8bc4ab42dc9df1d2042
name: USD Coin
decimals: 6
order: 200
mintAddress: '0x41E94Eb019C0762f9Bfcf9Fb1E58725BfB0e7582'
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
- SWAP
orderingType: NUMERIC
isNative: false
blockchain:
id: 63b574b9d07b6f6f21c13ed3
name: POLYGON
symbol: POLYGON
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 672a189115f34893ea4cad97
name: USD Coin
decimals: 6
order: 250
mintAddress: '0x036CbD53842c5426634e7929541eC2318f3dCF7e'
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
- SWAP
orderingType: NUMERIC
isNative: false
blockchain:
id: 671a2d7168ef24934ca70622
name: BASE
symbol: BASE
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 63430c8348c610068bcdc474
name: Solana
decimals: 9
order: 300
mintAddress: '11111111111111111111111111111111'
coinMarketCapId: 5426
symbol: SOL
symbolPrefix: ''
type: DIGITAL
iconUrl: SOL.png
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/SOL.png
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
- USD_RATE
orderingType: NUMERIC
isNative: true
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
wallet:
id: 664f25cdde5492e5c4640bde
publicKey: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
name: Shopify Wallet
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
- currency:
id: 63430c8348c610068bcdc496
name: USD Tether
decimals: 6
order: 400
mintAddress: EJwZgeZrdC8TXTQbQBoL6bfuAnFUUy1PVCMB4DYPzVaS
coinMarketCapId: 825
symbol: USDT
symbolPrefix: $
type: DIGITAL
iconUrl: USDT.png
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDT.png
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
wallet:
id: 664f25cdde5492e5c4640bde
publicKey: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
name: Shopify Wallet
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
- currency:
id: 6426bd3f9a969530039a1a86
name: USDT (FAKE)
decimals: 6
order: 450
mintAddress: '0xbDeaD2A70Fe794D2f97b37EFDE497e68974a296d'
coinMarketCapId: 825
symbol: USDT
symbolPrefix: ''
type: DIGITAL
iconUrl: USDT.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDT.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc443
name: ETH
symbol: ETH
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 6426bd599a969530039a1a87
name: USDT (FAKE)
decimals: 6
order: 450
mintAddress: usdtpolygon
coinMarketCapId: 825
symbol: USDT
symbolPrefix: ''
type: DIGITAL
iconUrl: USDT.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDT.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63b574b9d07b6f6f21c13ed3
name: POLYGON
symbol: POLYGON
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 63d7d3fe81c7f9e193bcdad6
name: Ethereum
decimals: 18
order: 500
mintAddress: '0xD76b5c2A23ef78368d8E34288B5b65D616B746aE'
coinMarketCapId: 1027
symbol: ETH
symbolPrefix: ''
type: DIGITAL
iconUrl: ETH.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/ETH.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: true
blockchain:
id: 63430c8348c610068bcdc443
name: ETH
symbol: ETH
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 63d7d3b681c7f9e193bcdad5
name: Bitcoin
decimals: 8
order: 550
mintAddress: btc
coinMarketCapId: 1
symbol: BTC
symbolPrefix: ''
type: DIGITAL
iconUrl: BTC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/BTC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: true
blockchain:
id: 63da349c7a40a721a6e0a221
name: BITCOIN
symbol: BITCOIN
engine:
id: 63da34127a40a721a6e0a21d
type: BTC
wallet:
id: 671663a9093e3fcfb979d32e
name: ''
publicKey: 2N4rCoyCMkUk6jwUmb6JU6xGPqojbo3CrnK
btcProperties:
paymentAddresses:
- address: 2N4rCoyCMkUk6jwUmb6JU6xGPqojbo3CrnK
version: SEGWIT
ordinalsAddresses:
- >-
tb1pejt93q6nknel0ha9an4v7p3vl9serrtl2nhxhrgzk9jmmdrxa0mqrjkdqn
type: EXTENSION
blockchainEngine:
id: 63da34127a40a721a6e0a21d
type: BTC
- currency:
id: 658053e5c772b08e72a565ea
name: EURC
decimals: 6
order: 900
mintAddress: HzwqbKZw8HxMN6bF2yFZNrht3c2iXXzpKcFu7uBEDKtr
coinMarketCapId: 20641
symbol: EURC
symbolPrefix: €
type: DIGITAL
iconUrl: EURC.png
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/EURC.png
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
wallet:
id: 664f25cdde5492e5c4640bde
publicKey: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
name: Shopify Wallet
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
- currency:
id: 6729d9a415f34893ea4cad91
name: Ethereum Base
decimals: 18
order: 250
mintAddress: '0x1b44F3514812d835EB1BDB0acB33d3fA3351Ee43'
coinMarketCapId: 1027
symbol: ETH
symbolPrefix: ''
type: DIGITAL
iconUrl: BASE.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/BASE.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
- SWAP
orderingType: ALPHABETICAL
isNative: true
blockchain:
id: 671a2d7168ef24934ca70622
name: BASE
symbol: BASE
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
- currency:
id: 63b6d9394ab42dc9df1d2043
name: Polygon
decimals: 18
order: 150
mintAddress: '0x0000000000000000000000000000000000001010'
coinMarketCapId: 3890
symbol: MATIC
symbolPrefix: ''
type: DIGITAL
iconUrl: MATIC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/MATIC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
orderingType: ALPHABETICAL
isNative: false
blockchain:
id: 63b574b9d07b6f6f21c13ed3
name: POLYGON
symbol: POLYGON
engine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
wallet:
id: 6716633e6b22b5a5f9f8c34f
name: ''
publicKey: '0xb6F8291C2Bf64bb12A757fd3C36AA3D60D0d1566'
btcProperties: null
type: EXTENSION
blockchainEngine:
id: 63b574b9d07b6f6f21c13eb0
type: EVM
volume: 0
sales: '0'
discountCodes:
- id: 68a486abe6fe7323540d8f01
percent: 10
tokenType: CODE
discordRoleIds: []
telegramGroupIds: []
pricingCurrency:
id: 63430c8348c610068bcdc482
name: USD Coin
decimals: 6
order: 100
mintAddress: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
engine:
id: 63b574b9d07b6f6f21c13eb2
type: SOL
product: null
additionalProducts: []
createdAt: '2024-05-23T11:17:33.931Z'
meta:
id: 664f2616061dddf20b64068e
amount: '97994'
senderPK: 9tarbZyg2s2g18sarJjn5vsWwS8gbewWXRcFszuiT1Wn
recipientPK: Agaqj6Mo6aPX5aEUeCFQYTVrxH71Nv5wh5JoMDkjVayw
transactionType: PAYLINK
customerDetails:
discordUser: null
telegramUser: null
productDetails: null
additionalProductDetails: []
transactionSignature: >-
47P7DJmKHvTpVRKFyzLuyBDgZvFUvNvNGP6V7v4tXTcbkHDTNn9qzd4s3Qouqf9TbrMJxzWrKJ7Ytc57DA8rrztV
transactionStatus: SUCCESS
splitRevenue: false
remainingAccounts: []
totalAmount: '97994'
totalAmountAsUSD: '97994'
affiliateAmount: '0'
tokenQuote: null
shopifyPaymentDetails:
shopifyPaymentGid: gid://shopify/PaymentSession/rj9wfWbgRslR2rJ2wypRhikGp
shopifyPaymentId: rj9wfWbgRslR2rJ2wypRhikGp
currency:
id: 63430c8348c610068bcdc482
name: USD Coin
decimals: 6
order: 100
mintAddress: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
coinMarketCapId: 3408
symbol: USDC
symbolPrefix: $
type: DIGITAL
iconUrl: USDC.svg
iconUrlFull: >-
https://helio-assets.s3.eu-west-1.amazonaws.com/USDC.svg
features:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
- DEPOSIT_MERCHANT_RECIPIENT
- DEPOSIT_CUSTOMER_CHECKOUT
orderingType: NUMERIC
isNative: false
paymentRequestCreatorId: 664f24c9061dddf20b63fdf2
paymentRequestName: Shopify Paylink
paymentRequestCurrencySymbol: USDC
refunds:
- id: 664f265dde5492e5c4640f4e
meta: null
paymentRequest: undefined
paymentRequestTx: undefined
- id: 664f268a061dddf20b640904
meta: null
paymentRequest: undefined
paymentRequestTx: undefined
'401':
description: Provided API key has no access to the resource.
content:
application/json:
examples:
unauthorized:
summary: Invalid or missing API key
value:
message: Api key or token is invalid
code: 401
security:
- bearer: []
components:
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Authentication using JWT token
````