API Reference

FAQ

Whitelabel API

  1. How do I activate the Whitelabel API feature?
    • To activate the White Label API feature, you should contact your UPayments Account Manager.
  2. What are the benefits of the Whitelabel API ?
    • The White Label feature allows merchants to display the payment gateway on their Checkout page. This avoids redirecting users to the UInterface payment page.
    • KNET, Credit Card, Apple Pay, Samsung Pay, Google Pay are supported with the White Label feature in UInterface V2.
    • Refer Whitelabel & Non-whitelabeled API page

Non-whitelabel API

  1. How can we fetch track_id for Non-whitelabel API?
    • In Non-whitelabeled API, track_id can be fetched from the webhook, returnUrl or cancelUrl.
    • track_id is generated only on selection of the payment gateway by the cardholder

Multivendor API

  1. How can sub-vendors receive deposits from transactions made on their platform?
    • Sub-vendors receive payments directly to their accounts in the Multi-Vendor feature.
  2. Does the Multi-Vendor API support the KFAST feature for saving Debit card details?
    • Yes, all merchants who use UInterface can have the KFAST & Save Card Feature.
      This can be done by enabling their respective parameters in the API.

Save Cards, KFAST

  1. What distinguishes the KFAST feature from the Save Cards feature?
    • The KFAST feature is specific to KNET and enables cardholders to save their card details via tokenization, allowing for faster and more convenient future transactions.
    • The Save Card feature, on the other hand, is a feature that allows customers to save their credit card details via tokenization. Refer to the Tokenization section for more details.

Checking Payment Status

  1. What is the payment response? How can I get it?
    • Payment response fields is received in the success/cancel url after payment as well as in the webook. Refer webhook for more details on the response fields.
    • Payment status and payment details can also be got from checkpaymentstatus API
  2. Is there an endpoint to check whether a payment has been successfully captured or not?
    • Webhook can be used to check whether a payment has been successfully captured or not.
    • Payment status and payment details can also be got from checkpaymentstatus API
  3. How can we get the payment ID, transaction ID, order ID, Payment status, time?
    • Payment ID, track ID, Order ID, payment status, time, Webhook
    • Payment status and payment details can also be got from checkpaymentstatus API
    • Successful transactions will be redirected on returnUrl.
    • All other scenarios like failed or cancelled it will redirected on cancelUrl.

  1. What is the recommended approach for implementing a payment inquiry?
  • The recommended approach for implementing a payment inquiry using the UPayments API involves implementing the REST API with a notify URL and getting the payment URL. Then, you can update the transaction based on the same response that you receive on the success or error URL.
  • Webhook can also be used to retieve the Payments Status.

Testing, Test Cards and Test Environment

  1. Is there an endpoint to check whether a payment has been successfully captured or not?
    • Webhook can be used to check whether a payment has been successfully captured or not.
      However, this API will work only with production details.
  2. Are there any test credit card credentials available for testing UPayments' payment processing features?