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

    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
    Product Overview
    Next
    Errors
    Built with