Payment charges

In your Dashboard, you can view and manage your payments processed through PPRO as well as get insights into your payment performance.

If you need to refund, void, or capture a payment, you can do that either using our APIs, or manually in your Dashboard.

In this guide, we explain how you can do the following in your Dashboard:

  • Look up detailed information about payments.
  • Refund, void, and capture payments.
  • View payment agreements, instruments and insights

Note on Permissions: If you encounter an error or can’t see a feature, please verify your user role has the required permissions. You can learn more about roles and capabilities here.

How to look up a payment charge

Through the Dashboard's left sidebar, go to the Digital payments group, and select Payment Charges.

For each payment charge, you can see the following information and more:

  • Merchant ID: PPRO’s ID for the merchant which processed this payment.
  • Merchant reference: Your reference for this payment.
  • Date: The timestamp of the payment.
  • Amount: The amount of the payment.
  • Payment method: The payment method used to process this payment.
  • Status: The current status of the payment.

You can customize the columns so that you see more information such as customer name, failure reason and card details.

You can use the Filter bar at the top of the page to filter payments by Date, Status, Amount, Currency, and other properties. You can also use the search box to look for a specific PPRO ID, your own payment reference, or information about the customer, such as email address.

Payment details

For more information about a payment, select the payment charge ID of that payment in the payments list. This opens the Payment charge details page, where you can view details such as:

  • Payment status lifecycle: The history of different statuses that the payment has gone through.
  • Operations: Here you can find the failure reason for an operation as well as additional IDs, such as the short code.
  • Webhook event history: An overview of all webhook events for the payment charge.

How to refund a payment

Once a payment has been successfully captured (either fully or partially), funds can be refunded to the consumer through a refund request. Refunds can be processed in full or in multiple partial amounts, as long as the total refunded amount does not exceed the original captured amount.

To refund a payment:

  1. Log in to Dashboard.
  2. Go to Digital Payments > Payments charges, and select the Payment Charge ID of the payment that you want to refund. This opens the Payment charge details page.
  3. Select the Refund button under the Payment Charge summary.
  4. Enter the details of the refund:
    1. Amount: The amount you want to refund. This must be either the same or, in case of a partial refund, less than the captured amount.
    2. Reference: Your reference for the refund request.
  5. Select the Refund payment button in the lower right corner of the page.

How to void a payment

For payment methods that support separate capture, you must void the payment before it has been captured (for example, when an item is out of stock). This prevents the amount from being captured and in some cases reverses the authorization, immediately releasing those funds back to the consumer.

To void a payment:

  1. Log in to Dashboard.
  2. Go to Digital Payments > Payments charges, and select the Payment Charge ID of the payment that you want to void. This opens the Payment charge details page.
  3. Select the Void button under the Payment Charge summary.
  4. Enter the details of the void:
    1. Amount: The amount you want to void. This must be either the same or, in case of a partial void, less than the authorized amount.
    2. Reference: Your reference for the void request.
  5. Select the Void payment button in the lower right corner of the page.

How to capture a payment

Once a payment charge has been authenticated and authorized, the movement of funds can be initiated through a capture request. Separate captures mean that this process can be delayed or voided. By using multiple partial captures, varying amounts can be captured at the time of split shipment.

To capture a payment:

  1. Log in to Dashboard.
  2. Go to Digital Payments > Payments charges, and select the Payment Charge ID of the payment that you want to capture. This opens the Payment charge details page.
  3. Select Capture button under the Payment Charge summary.
  4. Enter the details of the capture:
    1. Amount: The amount you want to capture. This must be either the same or, in case of a partial capture, less than the authorized amount.
    2. Reference: Your reference for the capture request.
  5. Select the Capture payment button in the lower right corner of the page.

View payment agreements, instruments and insights

You can also look up a payment instrument or payment agreement in the respective overviews in your Dashboard. You can use the search bar to enter a PPRO ID or your own reference. To see more details, you can click on the ID, the same as you would do for a payment charge.

Through the Dashboard's left sidebar, go to the Digital payments group, and select Payment Insights. Here you can get an overview of your payment’s performance based on common metrics, such as capture rate, refund rate and total captured volume. You can use the Filter bar at the top of the page to get more precise insights.