# PayStar API Documentation ## Docs - [Merchant EN](https://apidoc.paystar.uk/merchant-en.md): - Merchant EN [Introduction | API PayStar.uk](https://apidoc.paystar.uk/introduction.md): 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. - Merchant EN [Glossary | API PayStar.uk](https://apidoc.paystar.uk/glossary.md): This section provides definitions and explanations of key terms and abbreviations used throughout the PayStar API documentation. Whether you're new to payment integrations or need clarity on specific technical concepts, this glossary is designed to help you quickly understand the terminology involved. - Merchant EN [Additional fields | API PayStar.uk](https://apidoc.paystar.uk/aadditionalfields.md): This section describes optional and context-specific fields that can be included in payment and payout requests. These fields allow for extended customization and support integration scenarios that require additional metadata or business logic parameters. - Merchant EN [Currencies | API PayStar.uk](https://apidoc.paystar.uk/currencies.md): This section lists all currencies supported by the PayStar platform for payment and payout operations. Use these currency codes when specifying transaction amounts in your API requests to ensure compatibility and successful processing. - Merchant EN [Bank name | API PayStar.uk](https://apidoc.paystar.uk/bank-name.md): The bank name is typically used for payment routing. If the bank is not specified in the request, it will be automatically determined based on the card's BIN. However, BIN-based detection cannot guarantee 100% accuracy. If your users are willing to specify the issuing bank of the card, it is recommended to include this field — doing so can improve payment success rates and enhance the reliability of financial flows. - Merchant EN [Telecom operator | API PayStar.uk](https://apidoc.paystar.uk/telecom-operator.md): The telecom operator name is typically used for routing payments. If the telecom operator is not specified in the request, it will be automatically determined based on the phone number. However, phone-based detection is often inaccurate and may not be available in certain regions. We strongly recommend including this field in your requests — doing so will improve payment success rates and enhance the reliability of financial flows. - Merchant EN [Sandbox | API PayStar.uk](https://apidoc.paystar.uk/sandbox.md): The PayStar Sandbox environment allows you to safely test API integrations without processing real payments or affecting production data. It replicates the behavior of the live system while providing controlled test scenarios for deposits, payouts, tokenization, and callbacks. - Merchant EN [Authorization | API PayStar](https://apidoc.paystar.uk/authorization.md): This section explains how to obtain authorization keys, generate a token, modify keys. Each flow (e.g., deposits and payouts) will have separate authorization keys. Make sure to use the correct key for each type of operation. - Merchant EN [Callbacks | API PayStar](https://apidoc.paystar.uk/callbacks.md): This section describes the capabilities of the PayStar platform's callback system — including how to configure callbacks, which fields can be received, and how to verify the callback signature. - Merchant EN [Status discriptions | API PayStar.uk](https://apidoc.paystar.uk/status-discriptions.md): This section describes the possible **HTTP error statuses** returned by the PayStar API. Each API method (such as deposit creation, payout initiation, or status check) may return a status code that indicates the current state of the request or highlights an issue that occurred during processing. ## API Docs - Merchant EN [GET Merchant balance | API PayStar.uk](https://apidoc.paystar.uk/merchant_balance.md): Current method is used to get 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. - Merchant EN [Creatre deposit | API PayStar.uk](https://apidoc.paystar.uk/deposit-h2h.md): PCI DSS REQUARIED If you have a valid PCI DSS certificate, you can use this method. In this case, you must collect the user's card details when creating the payment and include them in this request. Please note that before you can start using this method, you need to provide your Account manager with your AOC (Attestation of Compliance). - Merchant EN [Creatre deposit by Token | API PayStar.uk](https://apidoc.paystar.uk/deposit-by-token-h2h.md): Thanks to the tokenization of bank cards, you can simplify the payment process for end users. Here's how it works: - Merchant EN [Create deposit host to client | API PayStar.uk](https://apidoc.paystar.uk/deposit-h2c.md): PCI DSS NOT REQUARIED If you do not have a PCI DSS certificate, you can use this method. In this case, you must not collect the user's card details when creating the payment — the user will be presented with a Payment web page to enter their card information at the next step. - Merchant EN [Check status deposit | API PayStar.uk](https://apidoc.paystar.uk/get-deposit-status.md): When checking the status, provide the externalId that you received in the response to the deposit creation request. If you receive an error or a non-final status, repeat the status check every 5 minutes until you receive a final status. Additionally, please refer to the Callbacks section, which allows you to receive the payment status via callbacks. - Merchant EN [Payout | API PayStar.uk](https://apidoc.paystar.uk/create-payout-h2h.md): POST Withdrawal direct | PayStar integration - Merchant EN [Status payout | API PayStar.uk](https://apidoc.paystar.uk/get-patout-status.md): When checking the status, provide the externalId that you received in the response to the payout creation request. If you receive an error or a non-final status, repeat the status check every 5 minutes until you receive a final status. Additionally, please refer to the Callbacks section, which allows you to receive the payment status via callbacks. We recommend using both approaches — callbacks and the status check method — to ensure a more reliable integration.