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

Glossary

INFO
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.
It includes:
Technical terms used in requests and responses;
Payment industry concepts (e.g., 3DS, tokenization, H2H/H2C);
System-specific entities and fields relevant to PayStar;
Security-related definitions including authentication methods.
Use this page as a reference point when navigating other sections of the documentation to ensure accurate implementation and better communication with our platform.
NOTE Please note that the actual flow may vary slightly depending on the specific payment scenario — for example, whether 3DS authentication is required or not.

Fundamental schematic diagram of interaction#

General Terms#

User#

The individual or entity that initiates a payment transaction, typically a customer or end-user who wants to purchase goods or services.

Merchant#

An online business integrating with the PayStar platform via API to accept payments from customers.
The business or entity that provides goods or services and receives payments from users. The merchant initiates the creation of an order and interacts with payment services to process the transaction.

Pipline or Endpoint#

Merchant Authorization endpoint on the PayStar.uk platform for processing payments via API.
In the context of the PayStar.uk, authentication utilizes a Bearer Token mechanism based on JSON Web Token (JWT). To obtain a token, you need to use a publicKey and privateKey, where the publicKey is included in the token's payload, and the signature is generated using the privateKey.
For more detailed information on the authorization process and integration with the PayStar.uk API, please follow Authorization section
You can obtain the publicKey and privateKey or a Bearer Token from your account manager.

PSP or EMI#

An organization, typically an Electronic Money Institution (EMI), processing payments on the PayStar.uk.

Account Manager#

An manager of an PSP assisting a merchant in setting up or maintaining financial workflows

PayStar.uk platform#

Is a comprehensive payment management platform that simplifies online payment acceptance for businesses. It offers a unified interface enabling quick connections to numerous payment providers, facilitating efficient routing and cascading of payments worldwide. The platform supports over 200 currencies and cryptocurrencies, integrates with more than 1000 payment providers, and provides 24/7 security monitoring and technical support.

Authorization#

In the context of the PayStar.uk, authentication utilizes a Bearer Token mechanism based on JSON Web Token (JWT). To obtain a token, you need to use a publicKey and privateKey, where the publicKey is included in the token's payload, and the signature is generated using the privateKey. You can obtain the publicKey and privateKey or a Bearer Token from your account manager.

Callback#

The PayStar.uk offers the ability to receive payment change notifications via API.
Available notifications include:
Amount changes (in some payment flows);
Status updates such as Created, Processing, Successful and Failed.
There are two ways to set up callbacks:
By calling the PSP Manager: by specifying a static URL and notification types.
During payment creation via API: by providing a URL during payment initiation.
If both methods are used, the URL specified during payment creation takes precedence.

Sandbox#

The platform allows for test payments using production authorization keys.
Typically, during the integration phase, the account manager sets up a flow for testing. This enables safe testing and the receipt of real responses. Subsequently, after completing the tests, the settings are adjusted to facilitate actual payments.
The authorization keys may remain the same or be regenerated at the merchant's discretion.

Tokenization#

Tokenization is a method of securely storing cardholder data in a safe repository that fully complies with PCI DSS 4.0 requirements. It allows users to make repeat payments without re-entering card details.

Deposits#

A user's request to top up a user's account through various payment methods (e.g., card payments) involves transferring funds from the user's account into the merchant's system.

Payout#

A request made by the user to remove funds from their account, typically involving transferring money from the merchant’s system to the user’s external account (bank or other financial institution).

Get payment Status#

An API call to retrieve the current status of a transaction or order. Merchants use this to verify if a payment has been completed, failed, or is pending.

Access Control Server (ACS)#

Access Control Server is a component in the 3-D Secure protocol that authenticates cardholders during online transactions, enhancing security by verifying their identity before transaction approval.

Order#

A unique request generated by the merchant to initiate a payment process. The order contains details about the transaction, such as the amount, payment method, and associated user information.

Payment Form#

A web form or interface presented to the user by the merchant, where the user enters payment details such as credit card information, billing address, etc. This form is used to collect the necessary data to process the payment.

3DS URL#

Refers to the 3D Secure authentication form, which is a security protocol designed to reduce fraud and provide an extra layer of authentication for online credit and debit card transactions. During the payment process, the user is redirected to their bank's 3D Secure page to verify their identity, usually through a one-time password (OTP) or biometric authentication.

Payment Data#

The information provided by the user that is necessary to complete the payment transaction. This can include credit card numbers, expiration dates, security codes, and any other relevant payment-related details.
Previous
Introduction
Next
Authorization key
Built with