UseePay API
    UseePay API
    • Introduction
    • Product Overview
    • Authentication
    • Errors
    • Changelog
    • Integration
      • Get started with online payments
      • Get started with subscriptions
    • Payment Intents
      • Create a PaymentIntent
        POST
      • Retrieve a PaymentIntent
        GET
      • Update a PaymentIntent
        POST
      • Confirm a PaymentIntent
        POST
      • Cancel a PaymentIntent
        POST
      • Capture a PaymentIntent
        POST
      • List all payment intents
        GET
    • Customers
      • Create a customer
        POST
      • Retrieves a customer
        GET
      • Update a customer
        POST
      • List all customers
        GET
    • Subscriptions
      • Create a subscription
        POST
      • Retrieves a subscription
        GET
      • Update a subscription
        POST
      • List all subscriptions
        GET
      • Cancel a subscription
        POST
    • Invoices
      • Create a invoice
        POST
      • Retrieves a invoice
        GET
      • Update a invoice
        POST
      • List all invoices
        GET
      • Pay a invoice
        POST
    • Payment Methods
      • Create a payment method
      • Retrieves a payment method
      • Update a payment method
      • List all payment methods
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • Update a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • Update a refund
      • List all refunds
    • Webhooks
      • Webhook envents
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Payment Links
      • Create a payment link
      • Retrieves a payment link
      • Update a payment link
      • List all payment links
    • Embedded Checkout
      • Payment Elements
    • About Testing
      • Test Cards
      • ApplePay&GooglePay

    Introduction

    Welcome to UseePay.
    The UseePay API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
    The UseePay API doesn’t support bulk updates. You can work on only one object per request.
    We recommend you read through the API Documentation in full to familiarise yourself with the features and workflows associated with the product.
    💡
    Production Environment Description
    Sandbox: https://openapi1.uat.useepay.com/
    Production:https://openapi.useepay.com/
    You will be exposed to two environments Sandbox and Production. The two environments are independent of each other, with separate merchant numbers and account information. You need to first pass the joint debugging test in the Sandbox environment before proceeding with production validation.
    💡
    Integration steps

    1.Activate Sandbox environment#

    Provide an email address to UseePay operations and you will receive an activation email afterwards. Activate the account.

    2.Obtain merchant no and app key#

    If it is a self built website, you can apply for OpenApi key. If receiving Webhook messages, RSA key needs to be enabled
    SandBox Merchant System
    image.png

    3.Submit website appId#

    TIP
    The appId (website) in the interface corresponds to the domain name applied for through the following link. Please note that the appId needs to be consistent with the following submitted websites (exact match). It's better not to bring it【https://】【http://】
    SandBox Merchant System > Website management
    image.png

    4.Integrated API interface#

    Integrate corresponding interfaces according to your needs.

    5.System testing completed#

    After integrating the interface, you need to conduct a complete process test, which can be referred to test case.

    6.Activate production environment#

    Activating the production environment is like activating the testing environment.

    7.Starting production transactions#

    After activating the production environment, you can start trading. To ensure the quality of the transaction, please complete the following tasks.
    Complete a small-scale transaction test.

    important#

    The IP address of the webhook notification domain needs to be provided to Useepay for whitelisting.
    Modified at 2025-05-27 14:05:57
    Next
    Product Overview
    Built with