Introduction to the ALPPAY Merchant API

Welcome to the documentation for the ALPPAY Merchant API. This API is designed to integrate the ALPPAY 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.

Version: 2.0.1
Data Format: JSON
Base URL: https://api.alppay.io/v2
Get Started
Part 1

Authentication

You need to know where you're starting from, before you can pretend to decide where you're going.

  1. API-KEY

    Your unique account-level API key.

  2. HMAC Signature Authentication

    Explore whether you're living your life or just reacting to everyone else's.

Part 2

Endpoints

You need to know where you're starting from, before you can pretend to decide where you're going.

  1. Create Payment

    How to create a new payment via the ALPPAY Merchant API.

  2. List Payments

    How to retrieve multiple payments via the ALPPAY Merchant API.

  3. Get Withdrawal

    How to retrieve a single withdrawal by its ID via the ALPPAY Merchant API.

  4. Create Withdrawal

    How to create a new withdrawal via the ALPPAY Merchant API.

  5. List Withdrawals

    How to retrieve multiple withdrawals via the ALPPAY Merchant API.

  6. Get Wallets Balances

Part 3

Webhooks

You need to know where you're starting from, before you can pretend to decide where you're going.

  1. Withdrawal Webhooks

    Notifies your server about creation or status changes of a withdrawal request.

  2. Payment Webhooks

    Notifies your server about creation or status changes of a payment.

  3. Transfer Webhooks

    Notifies your server about successful inbound or outbound transfers (e.g., wallet-to-wallet).