Introduction to the API

Welcome to the documentation for the API. It is designed to integrate the payment system into your application and provides the following features:
- Payment Creation: Initiate payments by specifying the amount, currency, customer data, and additional parameters.
- Withdrawal Management: Create and track withdrawal requests.
- Real-Time Notifications: Instantly receive updates on payment and withdrawal status changes via webhooks.

Last Updated: 2026-08-06
Data Format: JSON
Base URL: https://api.alppay.io/v2
Get Started
Part 1

General

Getting started with the payment gateway, supported assets and fee structure.

  1. Integration Guide

    Step-by-step guide to integrate with the payment gateway, from registration to production deployment.

  2. Available Assets

    Explore all supported cryptocurrencies and stablecoins across multiple networks for seamless payment processing.

  3. Transaction Fees

    Check detailed transaction fees for deposits, withdrawals, and network fees to optimize costs in our crypto payment gateway.

  4. Invoice Timeout

    Configure how long payment invoices stay open: custom merchant timeout, limits and default behavior.

  5. AML Checks

    How automatic AML screening works: triggering threshold, risk scores and levels, dangerous results and pricing.

Part 2

Authentication

API key and HMAC signature configuration for secure API access.

  1. API-KEY

    Your unique account-level API key.

  2. HMAC Signature Authentication

    Secure your API requests with HMAC-SHA256 signatures for data integrity and authentication.

Part 3

Endpoints

Create and manage payments, withdrawals and wallet balances.

  1. Create Payment

    How to create a new payment via the API.

  2. List Payments

    Retrieve and filter multiple payment records with full transaction details via the API.

  3. Get Payment

    Retrieve detailed information about a specific payment by its ID via the API.

  4. Get Withdrawal

    Retrieve detailed information about a specific withdrawal request by its ID via the API.

  5. Create Withdrawal

    How to create a new withdrawal via the API.

  6. Withdrawal to Whitelist

    Sweep funds from deposit wallets to pre-configured whitelist addresses with automatic resource management.

  7. List Withdrawals

    Retrieve and filter multiple withdrawal requests with full details via the API.

  8. Get Wallets Balances

  9. Estimate Network Fee

    Estimate the on-chain network fee for a withdrawal, for one currency or all coins of a network, without broadcasting a transaction.

Part 4

Webhooks

Real-time notifications about payment and withdrawal status changes.

  1. Withdrawal Webhooks

    Receive real-time notifications about withdrawal status changes with secure HMAC-verified webhooks.

  2. Payment Webhooks

    Receive real-time notifications about payment status changes, including partial payments and AML checks.

  3. Webhook sequence for AML‑enabled payments

    Webhook Sequence for AML Enabled Payments: Deposit Detection and Transaction Status

Part 5

Persistent Wallet Address Management

Persistent Wallet Address Management

  1. Client ID

    Client ID Feature for Persistent Wallet Address Management

  2. Client Wallet Balances & Transactions

    Client Wallet Balances & Transactions

  3. Get Wallets by Client

    Retrieve all deposit wallets with assigned clientId for the authenticated merchant.

  4. Create Deposit Address

    Generate persistent deposit wallet addresses with optional clientId for sticky address binding.