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

Deposit direct

Deposit direct - group of method for merchant initiated deposit orders. The mots popular case - aquaring: on the merchant's website, the user pays for his purchases.

Сonceptual interaction diagram#

To make deposit payment please use follow methods:#

Create payment: POST /api/v1/integration/deposit-order/
Check payment status: GET /api/v1/integration/deposit-order/{externalId}/status

Deposit Sequence diagram#

Check status deposit order - callback and Polling#

Polling - every 2 min before getting the final status.
Callback

Entities#

1.
User:
The individual or entity that initiates a payment transaction, typically a customer or end-user who wants to purchase goods or services.
2.
Merchant:
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.
3.
PayStar:
A payment processing platform that facilitates the creation and management of payment orders, handles payment status verification, and communicates with both merchants and payment gateways.
4.
Gateway (Bank or PSP):
A financial service provider that processes payment transactions by connecting the payment request from the merchant (via PayStar) to the acquiring bank or payment networks, ensuring the transfer of funds.

Terms#

1.
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.
2.
Payment:
The process of transferring money from the user to the merchant as part of a purchase transaction. The payment can involve various methods, such as credit cards, bank transfers, or digital wallets.
3.
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.
4.
Form 3DS:
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.
5.
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.
6.
Callback:
A server-to-server notification sent by PayStar to the Merchant, informing them of the final status of the order. The callback allows the Merchant to update the order status on their system without relying on the user to return to the site after payment. It is typically used to confirm whether a payment has been successfully completed, failed, or if any other final status has been reached.
Modified at 2024-12-12 13:18:26
Previous
Bank names
Next
Create | Deposit order
Built with