> For the complete documentation index, see [llms.txt](https://aliniex.gitbook.io/alix-pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aliniex.gitbook.io/alix-pay/api-reference.md). # API Reference - [Introduction](https://aliniex.gitbook.io/alix-pay/api-reference/introduction.md) - [Regulations and requirements](https://aliniex.gitbook.io/alix-pay/api-reference/introduction/regulations-and-requirements.md) - [Digital Signature](https://aliniex.gitbook.io/alix-pay/api-reference/introduction/digital-signature.md) - [Environment](https://aliniex.gitbook.io/alix-pay/api-reference/introduction/environment.md) - [Webhooks](https://aliniex.gitbook.io/alix-pay/api-reference/introduction/webhooks.md) - [Scan To Pay API](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api.md) - [Account](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account.md) - [Verify your account](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account/verify-your-account.md) - [Get account wallet balance](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account/get-account-wallet-balance.md) - [Check cryptocurrencies price](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account/check-cryptocurrencies-price.md) - [Verify bank account](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account/verify-bank-account.md) - [Get list of supported banks](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/account/get-list-of-supported-banks.md) - [User](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user.md) - [Submit User KYC Information](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user/submit-user-kyc-information.md): Create the end user account - [Get User KYC Information](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user/get-user-kyc-information.md): Create the end user account - [Check User Service Access](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user/check-user-service-access.md): Create the end user account - [Order](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/order.md) - [Create an order](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/order/create-an-order.md) - [Transactions](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/transactions.md) - [Get transaction details](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/transactions/get-transaction-details.md) - [Listen updates of transaction via webhook (IPN\_URL)](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/transactions/listen-updates-of-transaction-via-webhook-ipn_url.md) - [Public](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/public.md) - [Get Information of QR Code](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/public/get-information-of-qr-code.md) - [Generate a QR Code in Philippines](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/public/generate-a-qr-code-in-philippines.md) - [Alixpay Remittance API](https://aliniex.gitbook.io/alix-pay/api-reference/alixpay-remittance-api.md) - [Review the cash-out order](https://aliniex.gitbook.io/alix-pay/api-reference/alixpay-remittance-api/review-the-cash-out-order.md) - [Create the cash-out order](https://aliniex.gitbook.io/alix-pay/api-reference/alixpay-remittance-api/create-the-cash-out-order.md) - [Alix Card API](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api.md) - [Auth](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/auth.md) - [Access Token](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/auth/access-token.md) - [Refresh Token](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/auth/refresh-token.md) - [User](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/user.md) - [Submit Account KYC](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/user/submit-account-kyc.md): Create the end user account - [Get Account KYC Information](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/user/get-account-kyc-information.md): Create the end user account - [Cards](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards.md) - [Get Card Types](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-card-types.md): This api end-point will provide you the list of card types currently supported by Alix Pay - [Get Card Type details](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-card-type-details.md): This api end-point will provide you the details of a card currently supported by Alix Pay - [Create card](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/create-card.md) - [Check creating data](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/check-creating-data.md) - [Topup card](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/topup-card.md) - [Check topup fee](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/check-topup-fee.md) - [Lock card](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/lock-card.md) - [Unlock card](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/unlock-card.md) - [Get all cards](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-all-cards.md): This api end-point will provide you the list of your cards - [Get card's details](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-cards-details.md): This api end-point will provide you the information of a card - [Get card's private info](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-cards-private-info.md): This api end-point will provide you the private information of a card - [Get card's balance](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-cards-balance.md): This api end-point will provide you the current balance of a card - [Get card's transactions](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-cards-transactions.md): This api end-point will provide you the current balance of a card - [Get transaction details](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-transaction-details.md): This api end-point will provide you the current balance of a card - [Check the remaining spending limit of the account](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/check-the-remaining-spending-limit-of-the-account.md) - [Get Master Funds Information(only partner needed)](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-master-funds-information-only-partner-needed.md): This api end-point will provide you the current master funds balance and wallet address - [Get Master Funds Deposit History(only partner needed)](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/get-master-funds-deposit-history-only-partner-needed.md): This api end-point will provide you the history of master funds - [Notifications(Webhook)](https://aliniex.gitbook.io/alix-pay/api-reference/alix-card-api/cards/notifications-webhook.md) - [Card API](https://aliniex.gitbook.io/alix-pay/api-reference/card-api.md) - [Overview](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/overview.md) - [Making Request](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/making-request.md): This start guide will take you through making your first request to the Make API. - [Getting Your First Card](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/getting-your-first-card.md) - [KYC Verification Flow](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/kyc-verification-flow.md) - [API Reference](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/api-reference.md) - [Notifications (webhook)](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/notifications-webhook.md) - [On/Off Ramp API](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api.md) - [Pre-On/Off ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/pre-on-off-ramp-order.md) - [Get supported fiat currencies](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/pre-on-off-ramp-order/get-supported-fiat-currencies.md) - [Get price of crypto currency by fiat currency](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/pre-on-off-ramp-order/get-price-of-crypto-currency-by-fiat-currency.md) - [Get supported crypto currencies](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/pre-on-off-ramp-order/get-supported-crypto-currencies.md) - [Authenication](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/authenication.md) - [Register user email](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/authenication/register-user-email.md) - [Verify user email](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/authenication/verify-user-email.md) - [Refresh Token](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/authenication/refresh-token.md) - [User](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/user.md) - [Upload User KYC Information](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/user/upload-user-kyc-information.md) - [Get User KYC Information](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/user/get-user-kyc-information.md): Create the end user account - [On-ramp](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/on-ramp.md) - [Review on-ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/on-ramp/review-on-ramp-order.md) - [Create on-ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/on-ramp/create-on-ramp-order.md) - [Get on-ramp order detail](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/on-ramp/get-on-ramp-order-detail.md) - [Off-ramp](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/off-ramp.md) - [Review off-ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/off-ramp/review-off-ramp-order.md) - [Get purchase details of off-ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/off-ramp/get-purchase-details-of-off-ramp-order.md) - [Create off-ramp order](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/off-ramp/create-off-ramp-order.md) - [Get off-ramp order detail](https://aliniex.gitbook.io/alix-pay/api-reference/on-off-ramp-api/off-ramp/get-off-ramp-order-detail.md)