Deposit
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
H2C
sequenceDiagram
User->>Merchant: Initiates Payment
Merchant->>Paystar: Creates Deposit via API
Paystar-->>Merchant: Deposit Created Response
Merchant-->>User: Payment Form
User->>Paystar: Payment Data
Paystar->>Gateway: Send Payment Data
Gateway-->>Paystar: Payment Parameters
Paystar-->>Merchant: 3DS Form URL
Merchant-->>User: 3DS Form URL
rect rgb(191, 223, 255)
note right of Merchant: 3DS completion
User->>Paystar: 3DS completion
Paystar->>Gateway: 3DS completion
end
Gateway->>Gateway: Finalize Order
```
**H2H**
```mermaid
sequenceDiagram
User->>Merchant: Initiates Payment
Merchant->>Paystar: Creates Deposit Order via API
Paystar->>Gateway: Send Payment Data
Gateway-->>Paystar: Payment Parameters
Paystar-->>Merchant: Deposit Created Response
Merchant-->>User: 3DS Form URL
rect rgb(191, 223, 255)
note right of Merchant: 3DS completion
User->>Paystar: 3DS completion
Paystar->>Gateway: 3DS completion
end
Gateway->>Gateway: Finalize Order
```
**Deposit Callback and Polling**
```mermaid
sequenceDiagram
rect rgb(245, 245, 245)
Note right of Merchant: Deposit Finalization (Polling)
Merchant->>Paystar: Poll for Status
Paystar-->>Merchant: Status Response (Final Status)
Merchant->>Merchant: Finalize Order
end
rect rgb(245, 245, 245)
Note right of Merchant: Deposit Finalization (Callback)
Paystar->>Merchant: Final Status Callback
Merchant->>Paystar: Verify Status
Paystar-->>Merchant: Confirm Final Status
Merchant->>Merchant: Finalize Order
end
Entities
User:
- The individual or entity that initiates a payment transaction, typically a customer or end-user who wants to purchase goods or services.
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.
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.
Gateway (Bank):
- 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
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:
- 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.
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.
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.
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.
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.
Last modified: a month ago