UseePay Open API
UseePay Portal
Product Docs
  • V2.0
  • V1.0
Mechant Dashboard
UseePay Portal
Product Docs
  • V2.0
  • V1.0
Mechant Dashboard
  1. developer
  • Intergration
    • About Payment Methods
      • Card
      • Apple Pay
      • Google Pay
      • Klarna
      • Naver pay
      • Kakao Pay
      • Toss Pay
      • Payco
      • Affirm
    • subscription
      • Get started with Subscription
    • online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
  • developer
    • Introduction
    • Authentication
    • Errors
    • error code
      • last_payment_error documentation
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
      • Create a PaymentIntent
      • Retrieve a PaymentIntent
      • Update a PaymentIntent
      • Confirm a PaymentIntent
      • Cancel a PaymentIntent
      • Capture a PaymentIntent
      • List all payment intents
    • Customers
      • Create a customer
      • Retrieves a customer
      • Update a customer
      • List all customers
    • Subscriptions
      • Create a subscription
      • Retrieves a subscription
      • Update a subscription
      • List all subscriptions
      • Cancel a subscription
    • Invoices
      • Create a invoice
      • Retrieves a invoice
      • List all invoices
      • Pay a invoice
    • 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
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook events
      • Webhook Activation/Signature Verification Steps
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • Payment Elements
    • case
    • objects
    • About Testing
      • Test Cards
      • ApplePay&GooglePay
  • message
    • Messaging Element
  • FAQ
    • Unable to receive Webhook notifications
  1. developer

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-10-11 06:43:17
Previous
Adaptive Price
Next
Authentication
Built with