API Reference
Start typing to search…

Devices

Integration from your software to PayPlus Devices

Step-by-Step Instructions for Clearing Device Payment Processing

1. Navigate to TransactionByDevice under API Endpoints > Devices

2. API Credentials

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

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

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

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

  • To retrieve the device_uid, please follow the below steps:
    • Log in to your PayPlus account.
    • Click 'Settings' (top left corner).
    • On the 'Settings' screen, choose 'Devices List'.
    • Copy the unique parameter assigned to your terminal device.

3. Required Parameters

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

4. Callbacks and redirects

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

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

ValueTypeDescription
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.
4RefundImmediate refund. The customer's card is refunded right away.

3. Including Extra Information with extra_info

To include additional data in your transaction—use the extra_info in your API request.

📌 The more_info value you send will also be returned to your system via a callback.

📄 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