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

Sandbox

INFO
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.
Use the sandbox to:
Validate request structures and authentication;
Simulate successful and failed transactions;
Test callback handling and status polling;
Experiment with various integration flows before going live.
To use the sandbox feature, follow these steps:

Contact Your Account Manager#

Reach out to your Aaccount Manager to switch your authorization keys to test mode.
Please note: the sandbox environment is fully identical to the production environment — the only difference is the status of your Authorization keys.
Once testing is complete, you can either request new keys or ask to switch the status of your existing keys back to production.

Use the expectedResult#

Use the expectedResult Key in Order requests - when creating an order, include the following key in the additionalFields array of your request:
{
  "key": "ExpectedResult",
  "value": "status=failed"
}
The value field can be set to the following options to simulate different responses:
status=failed: simulates a failed payment status.
status=success: simulates a successful payment status.
These configurations allow you to thoroughly test your integration with PayStar.uk and ensure your system correctly handles different scenarios.
⚠️ Please note: the expectedResult field does not work in the production environment.

CURL Example#

Modified at 2025-05-02 07:36:59
Previous
Authorization key
Next
Additional fields
Built with