PayStar API Documentation
  1. Merchant EN
  • Merchant EN
    • Introduction
    • Glossary
    • Authorization key
    • Sandbox
    • Additional fields
    • Currencies
    • Bank names
    • Telecom operators
    • Callbacks
    • Error descriptions
    • Tech FAQ
    • Alerting
    • Payment history v2
      • Payment history - backward compatibility (legacy `X.Y.Z.W`)
    • Integratins
      • Stripe
      • Inwizo
      • 2Checkout
      • Adyen
      • AffiniPay
      • Alikassa
      • AlliancePay
      • Amazon Pay
      • AnyMoney
      • AstroPay
      • Aureavia
      • AurisMyChanger
      • Authorize.Net
      • Avatarix
    • Balance H2H
      GET
    • Deposit H2H - Card & P2P
      POST
    • Deposit H2H - Token
      POST
    • Deposit H2C - Card
      POST
    • Deposit status H2H - PayStar ID
      GET
    • Deposit status H2H - Merch ID
      GET
    • Payout H2H
      POST
    • Payout status H2H - PayStar ID
      GET
    • Payout status H2H - Merch ID
      GET
  1. Merchant EN

Introduction

INFO
Welcome to the PayStar API Documentation — your complete guide to integrating with PayStar’s secure and scalable payment gateway. This API enables seamless processing of online payments, payouts, and card tokenization through both host-to-host (H2H) and host-to-client (H2C) integration modes.
Whether you're building an e-commerce platform, a mobile app, or a fintech service, the PayStar API provides the tools you need to:
Accept payments via credit and debit cards;
Initiate payouts to users or partners;
Retrieve transaction statuses in real time;
Tokenize cards for recurring or one-click payments;
Support advanced scenarios like 3DS authentication and PCI DSS compliance.
This documentation includes:
Detailed descriptions of all available endpoints, parameters, and response formats;
Practical request/response examples (cURL, JSON);
Error codes and troubleshooting guidance;
Authentication mechanisms, including JWT handling and key management.
Our goal is to make your integration experience as smooth and secure as possible. For additional assistance, feel free to contact your account manager or our technical support team.

The system provides 3 main groups of API methods — Deposit, Payout and Balance.#

Balance#

A single method is used to check the balance, which returns both the overall merchant balance and the balance of the specific endpoint (authorization key) used for the request.
Please note that many limits and restrictions are tied specifically to the endpoint balance. If you have multiple authorization keys, we recommend checking the balance for each key individually.
GET Balance | H2H

Deposit#

The deposit methods are implemented within a single API contract and differ only in subdomains - different subdomains are used for different tasks:
Deposit H2H - Card & P2P — hosted on the secure subdomain. Requires the merchant to have a PCI DSS certificate and allows direct card data transmission between servers (host-to-host).
Deposit H2H - Token — hosted on the token subdomain. Enables recurring payments using previously obtained tokens.
Deposit H2С - Card — hosted on the init subdomain. Does not require PCI DSS. Used to initiate a payment without card data; the user is then redirected to a web form to enter card details.
Deposit status H2H — hosted on the secure subdomain.

Payout#

For payouts, the following methods are available:
Payout H2H — a server-to-server interaction method, similar to deposits.
Payout status H2H — used to getting the status of a payout.
Both status methods (Get Deposit Status and Get Payout Status) share the same contract but are available at different URLs.

Payment methods list#

DepositPayoutBalance
Deposit H2H - Card & P2PPayouts H2HGET Balance H2H
Deposit H2H - Token
Deposit H2С - Card
Deposit statusPayout status
CHECK

Before You Start#

Before beginning the integration, please complete the following steps:
1.
Obtain Authorization Keys (Bearer Token)
Contact your account manager to request Authorization keys. You can request either test or production access.
Environment switching can be done in two ways:
By changing the token (test / production).
By changing the token status without replacing the token itself.
🔎 Note: Test and production environments use the same base URL — the behavior depends solely on the authorization key status. More details are available in the Sandbox section.
2.
Whitelist Server IP Addresses
Provide the IP addresses of your servers to your account manager so they can be added to the IP whitelist. Only whitelisted IPs will be able to interact with the system.
3.
Confirm Required Additional fields
Depending on your planned payment flows, the list of required additional fields may vary. Please coordinate with your account manager to obtain and confirm the necessary parameters.
4.
Provide PCI DSS AOQ (If Using Acquiring H2H)
If you plan to use the Deposit H2H - Card & P2P method, you must provide a valid PCI DSS Attestation of Compliance (AOQ).
Previous
Merchant EN
Next
Glossary
Built with