DOCSEARCHbyAlgolia
Submit Docs

PayBy Developer Documentation

website·Indexed 33 days ago

https://developers.payby.com/

Developer resources for integrating PayBy payment services. Includes documentation for Online Payment SDKs (Java, PHP), In-App SDKs, and APIs for order creation, refunds, transfers, and balance queries. Features interactive demos for Hosted and Iframe Paypages, JSAPI, E-wallet, DYNQR, Smart Code, and Paylink.

Tokens
53.1K
Snippets
183
Records
303
Agent score
49%

What's inside PayBy

  1. Overview of Cash Top Up payments

    Cash Top Up allows online merchants to accept cash payments from customers without bank accounts (e.g., for game account top-ups). The customer pays cash to a participating store cashier, who then uses a PayBy POS system to scan a merchant-generated QR code. The transaction is funded by the store's PayBy e-wallet balance, bridging the gap between cash-based consumers and digital commerce.

  2. Overview of QRPAY customer-presented payments

    QRPAY is a payment method for physical retail environments (e.g., department stores, restaurants) where the customer presents a QR code from the PayBy or BOTIM app. The merchant scans this code using a standard QR scanner to initiate the payment process. This allows merchants to accept digital payments without investing in new hardware if they already possess barcode scanners.

  3. Overview of PayBy Direct Pay integration

    Direct Pay allows merchants to integrate card payment functionality directly into their own platform's user interface. Customers enter card details on the merchant's site, and PayBy encrypts and stores the information. This provides merchants full control over the checkout UI while leveraging PayBy's secure infrastructure for transaction processing and one-click payments.

  4. Overview of the PayBy Iframe Payment Page

    The Iframe Payment Page is a secure checkout interface hosted by PayBy that can be embedded directly into a merchant's website. This allows the payment to be processed on PayBy's secure servers while maintaining a seamless user experience for the cardholder, as the transition remains invisible.

  5. Integrate PayBy Hosted Paypage (Iframe Payment Page)

    The Iframe Payment Page is a secure checkout interface hosted by PayBy. It is designed to be embedded into a merchant's website to handle payment processing securely without requiring the merchant to handle sensitive payment data directly.

  6. Retrieve cashier URL and payer information

    Use the getCashierUrlInfo API to determine if a QR code has been scanned by a user and to retrieve details about the payer (scanner), such as their masked mobile number. This is used to track the status of a payment initiation process via a cashier URL.
    # Testing environment
POST https://uat.test2pay.com/sgs/api/acquire2/getCashierUrlInfo

# Production environment
POST https://api.payby.com/sgs/api/acquire2/getCashierUrlInfo

  7. Query member account balance using getBalance

    The getBalance interface allows merchants to retrieve detailed information about their account balance, including available, frozen, and total balance amounts for a specific currency.
    POST
UAT: https://uat.test2pay.com/sgs/api/member/getBalance
Production: https://api.payby.com/sgs/api/member/getBalance

  8. Choose a PayBy checkout integration method

    Depending on the desired user experience, PayBy offers three primary checkout integration methods:

    • Hosted paypage: Redirects the customer from your site to a PayBy-hosted payment page.
    • iFrame paypage: Embeds the PayBy checkout experience directly within your own website using an iframe.
    • In-App SDK: Integrates the checkout experience directly into a mobile application using the PayBy SDK.

  9. Create and use permanent payment links with Paylink

    Paylink allows you to create a permanent payment link by associating a product and a specific amount. These links are reusable for multiple payments and are designed to be shared via websites or social media platforms.

  10. Retrieve refund order details and status

    Use this API to check the status of a refund after a refund request has been submitted. The response provides detailed information about the refund order, including the refund status, amount, currency, and sharing information if applicable.
    // Example Response Body
{
  "head": {
    "applyStatus": "SUCCESS",
    "code": "0",
    "msg": "SUCCESS"
  },
  "body": {
    "refundOrder": {
      "refundMerchantOrderNo": "M818494241569",
      "orderNo": "191405406113002297",
      "originMerchantOrderNo": "M965739182419",
      "status": "SUCCESS",
      "amount": {
        "currency": "AED",
        "amount": 0.01
      },
      "feeRefunded": {
        "currency": "AED",
        "amount": 0.01
      },
      "reason": "refund",
      "reserved": "order desc",
      "refundSharingAmount": true,
      "sharingInfoList": [
        {
          "sharingAmount": { "amount": 1, "currency": "AED" },
          "sharingIdentitySeqId": 1,
          "sharingMemo": "bouns",
          "sharingMid": "100000047500",
          "sharingSettledAmount": { "amount": 1, "currency": "AED" }
        }
      ]
    },
    "refundSummary": {
      "acquireAmount": { "currency": "AED", "amount": 1.01 },
      "remainRefundAmount": { "currency": "AED", "amount": 1 },
      "sharingRemainRefundInfoList": [
        {
          "remainRefundAmount": { "amount": 1, "currency": "AED" },
          "memeberId": "100000047500"
        }
      ]
    }
  }
}

  12. Understand the Cash Top Up payment flow

    The Cash Top Up product enables online merchants to accept payments from users who do not have bank accounts. In this flow, a payer provides physical cash to a cashier at a participating store, and the cashier completes the online payment on the user's behalf. A common use case is topping up a gaming account.