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

Authentication

The UseePay API uses x-merchant-no, x-api-key and x-app-id in the HTTP request header to authenticate requests. For x-merchant-no, x-api-key and x-app-id parameters, We define them as authentication headers.
Your x-api-key carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Use your authentication headers by setting it in the initial configuration of new \UseePay\UseePayClient(). The PHP library will then automatically send this key in each request.
You can also set a per-request key with an option. This is often useful for Connect applications that use multiple API keys during the lifetime of a process. Methods on the returned object reuse the same API key.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Request headerDescription
x-merchant-noMerchant no of useepay,see Introduction>2.Obtain merchant no and app key
x-api-keyApplication api key of merchant,see Introduction>2.Obtain merchant no and app key>pkey
x-app-idApplication id of merchant, see Introduction>3.Submit website appId
Modified at 2024-11-07 10:32:36
Previous
Introduction
Next
Errors
Built with