API Reference

Website or App

Integration for Online Payment Processing (Website or App)

Step-by-Step Instructions:

  1. Navigate to the Payment Pages Section
    From the menu, select Payment Pages.
    Then choose the option: Generate Payment Link.
  2. Copy Essential Parameters to Postman
    You will need to copy the following key parameters:
    payment_page_uid
    Under the Headers section, ensure you include the following:
    api-key
    secret-key

    To retrieve these parameters, you must have an active account with us. Registration link
    Please refer to the attached link for a quick and easy guide on locating these parameters.
  3. Input Required Parameters
    Once you've copied the parameters, ensure that all required fields marked in red are filled:
    charge_method
    amount
    currency_code
    sendEmailApproval
    sendEmailFailure
    send_failure_callback
  4. Set Callback and Success URLs
    To receive callback information (e.g., payment confirmation), specify a URL in the object:
    refURL_callback
    To redirect customers to a custom Thank You Page after a successful transaction, specify a URL in the object:
    refURL_success
  5. Enable Invoice Generation (Optional)
    If your business requires invoices , you must subscribe to the invoice service and configure your numbering preferences in the PayPlus dashboard.
    For more information, click here.
    After completing this setup, set the parameter initial_invoice to True.

**Additional Notes:

  1. Security Requirement: Server-Side Calls Only**
    All API calls must be performed from your server (server-side) and not from client-side (e.g., browser, mobile app, or other local environments). This requirement exists to ensure data security, prevent unauthorized access, and protect sensitive API keys
  2. *Charge method Parameters type
    **This parameter specifies the type of transaction you wish to perform.
    For one-time immediate charges, choose: 1 (Charge)
    For delayed charges requiring approval (requires special authorization from your credit provider), choose: 2 (Approval)
    For recurring payments (e.g., credit card direct debit), choose: 3 (Recurring Payments)
    Note: Recurring payments require an additional module.
  3. Retrieving Additional Information in the Response
    If you want to include additional details (e.g., order number, shipping address) in the API response, use the more_info object.
    Within this object, specify which additional fields you'd like to send or receive during the transaction.