API Reference
Start typing to search…

Website or App

Online Payment Integration for Websites and Applications

Step-by-Step Instructions for Online Payment Processing

1. Navigate to GenerateLink route under API Endpoints > Payment Pages

2. API Credentials

To test the API in Postman or by the Interactive API Explorer, you'll need the following:

  • payment_page_uid
  • Under the Headers section, include:
    • api-key
    • secret-key

🔒 These credentials are available only to registered users. Register here: Sign Up

For help locating your API credentials, follow this step-by-step guide.

3. Required Parameters

Fill in or copy to Postman the required parameters that can be found under the generateLink route.

4. Callbacks and redirects

To receive transaction updates and redirect users after payment:

  • Callback URL:
    Add refURL_callback to receive server-side updates regarding the transaction.

    📌 Successful transaction callbacks are sent automatically when this URL is set. If you want to receive callbacks for failed transactions as well, include the parameter send_failure_callback and set it to true.

  • Success URL:
    Add refURL_success to redirect users to your custom Thank You page after a successful transaction.

    📌 When this URL is triggered, your end user will be redirected and transaction data will be sent to the URL as either a GET or POST request—depending on the settings you've configured for your Payment Page in the PayPlus dashboard.

  • Failure URL:
    Add refURL_failure to redirect users to a custom Failure page after a failed transaction.

    📌 Just like the refUrl_success, data about the transaction attempt will be included in the request sent to this URL, using either GET or POST, based on your PayPlus page configuration.

Additional Notes

1. Security Requirement – Server-Side Calls Only

All API requests must be made server-side.
Client-side calls (e.g., from browsers or mobile apps) are strictly prohibited to protect sensitive information and prevent unauthorized access.

2. Charge Method Parameter Types

ValueType                       Description
0Card Check (J2)Verifies that the credit card number, expiration date, and CVV are correct and that the card is active. It doesn't hold any funds, but confirms the card's validity.
1Charge (J4)Immediate payment. The customer's card is charged right away. Best for one-time purchases.
2Approval (J5)Checks if there are sufficient funds available on the card and secures the amount for a potential purchase.
3Recurring PaymentsSet up automatic recurring billing. Ideal for subscriptions or memberships. (Requires an additional module.)
4RefundImmediate refund. The customer's card is refunded right away.

3. Including Extra Information with more_info

To include additional data in your transaction—such as an order number, shipping details, or other custom fields—use the more_info in your API request.

You can specify up to six fields:

  • more_info
  • more_info_1
  • more_info_2
  • more_info_3
  • more_info_4
  • more_info_5

These fields allow you to attach meaningful metadata to the transaction for tracking, reporting, or business logic purposes.

📌 Any more_info values you send will also be returned to your system via all callback and redirect URLs (refURL_callback, refURL_success and refUrl_failure).

📄 4. Enable Invoice Generation (Optional)

If you need to issue invoices:

  • Subscribe to the invoice module in your PayPlus dashboard.
  • Set up your invoice numbering preferences.
  • Once enabled, include this parameter in your request:
    initial_invoice: true

📘

Learn more: Invoice Setup Guide