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.
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.
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.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. Payout#
For payouts, the following methods are available:Payout H2H — a server-to-server interaction method, similar to deposits. Payment methods list#
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.
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). Modified at 2025-05-02 07:30:43
