InstantTransfer
  1. PayStar API Documentation
InstantTransfer
  • PayStar API Documentation
    • Introduction
    • Authorization Bearer
    • Sandbox
    • Callbacks
    • Glossary
    • Dictionarys
      • Currencys
      • Telecom operators
      • Bank names
    • Deposit direct (Merch)
      • Create | Deposit order
      • Check status | Deposit order
    • Deposit reverse (Gateway)
      • Create | Reverse deposit order
      • Check status | Deposit order
    • Withdrawal direct (Merch)
      • Create | Withdrawal order
      • Check status | Withdrawal order
    • Balance
      • GET Merchant balance
  • Armax API
    • POST Armax Order
      POST
  • Butler API Bridge
    • Authorization Bearer
    • Withdrawal direct | PDO API Bridge
      • Check status | Withdrawal order
      • Create | Withdrawal Order
    • PSP Deposit Order
      • PSP Deposit Order
      • PSP Deposit Order status
    • Merch Deposit Order
      • Merch Deposit Order
      • Merch Deposit Order status
  • CoreFy API
    • Withdrawal Order
      POST
    • Payment Order
      POST
  • PayNetEasy API Bridg
    • Introduсtion
    • Autorization
    • Glossary
    • POST order
      POST
    • POST Status order
      POST
  1. PayStar API Documentation

Glossary

PayStar API Glossary#

General Terms#

Authorization (Bearer)#

An authentication mechanism where the client must provide a token (JWT) in the HTTP Authorization header to authenticate requests. More information here

Callback URL#

A URL where the payment gateway sends updates about the transaction status after processing. The merchant must set this URL to receive notifications about payment results.

Sandbox#

A testing environment that mimics the live production environment but does not execute real transactions. It allows developers to simulate transaction scenarios without financial impact.

Deposit Order#

A request made by the client to add funds to a user's account through various payment methods (e.g., card payments). This involves transferring funds from the client’s account into the merchant’s system.

Withdraw Order#

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

Check 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.

Gateway#

A service that processes payment information between the merchant and financial institutions. It handles transaction authorization, routing, and settlement of funds.

Merchant#

The business or entity using the PayStar system to accept payments from customers. Merchants configure their API settings and handle transactions for their products or services.

Client#

The end-user interacting with the merchant’s website or application, typically to make a payment or request a refund.

Request Parameters from additionalFields#

CardNumber#

The card number provided by the client for the transaction. This is a 16-digit number uniquely identifying the card.

CardCvv#

The Card Verification Value, a 3- or 4-digit code, typically found on the back of the card. It is used as a security measure to verify that the card is in the possession of the cardholder.

CardHolder#

The name of the individual to whom the card is issued. This should match the name registered with the card issuer.

CardExpireMonth#

The expiration month of the card in MM format. For example, if the card expires in May, this value will be 05.

CardExpireYear#

The expiration year of the card in YY format. For example, if the card expires in 2026, this value will be 26.

IP#

The IP address of the client making the request. It can be used for security and fraud detection.

BrowserAcceptHeader#

The Accept header sent by the client’s browser. This defines the types of media the client is willing to accept (e.g., text/html, application/xml).

BrowserJavaEnabled#

A boolean value indicating whether Java is enabled in the client’s browser. It can be used for additional fraud checks.

BrowserJavascriptEnabled#

A boolean value indicating whether JavaScript is enabled in the client’s browser, commonly used to detect modern browser capabilities.

BrowserLanguage#

The language setting of the client’s browser, in the format of a language tag (e.g., en-US, ru-RU).

BrowserColorDepth#

The color depth (in bits) of the client’s browser. For example, 24 refers to 24-bit color depth.

BrowserScreenWidth#

The screen width of the client’s device in pixels. Useful for determining the client’s display capabilities.

BrowserScreenHeight#

The screen height of the client’s device in pixels.

browserTZ#

The client’s browser time zone offset in minutes from UTC. Negative values indicate time zones west of UTC.

BrowserChallengeWindowSize#

This defines the size of the challenge window used in 3D Secure authentication, with codes like 01, 02, 03, etc., corresponding to specific window sizes.

BrowserUserAgent#

The User-Agent string sent by the client’s browser. It provides information about the client’s browser, operating system, and device type.

PayeerIdentifier#

The unique identifier of the payer in the merchant's system.

BankName#

The name of the bank issuing the card, useful for identification purposes.

Email#

The email address of the client making the transaction. This can be used for transaction receipts and communication.

Type#

Specifies the type of payment method used, in this case card indicates a card-based transaction.

ProductCode#

A unique code representing the product or service being purchased, which the merchant defines for their own records.
Modified at 2024-12-12 13:18:26
Previous
Callbacks
Next
Currencys
Built with