UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
  1. About Payment Methods
  • Integration
    • Welcome to the UseePay Demo Page
    • Payment Product Overview
      • Hosted Checkout Integration Guide
      • Embedded Checkout Integration Guide
      • Express Checkout Integration Guide
      • Server to Server Integration Guide
    • About Payment Methods
      • Affirm
      • AfterPay_ClearPay
      • Bank Transfer
      • Boost
      • Card
      • Cashapp
      • Dana
      • GCash
      • iDEAL
      • Kakao Pay
      • Klarna
      • Konbini
      • Korean Card
      • Maya
      • Naver pay
      • Payco
      • Pay with Link
      • Pix
      • Pse
      • Samsung Pay
      • Tmoney
      • Toss Pay
      • Trustly
      • TrueMoney
      • RSA-Encrypted Card Payments
      • ApplePay
        • Apple Pay
        • Apple Pay Web Integration (API Integration)
      • GooglePay
        • Google Pay
        • Google Pay Web Integration (API Integration)
      • common
        • _shared-client-os-type
      • alipay
        • Alipay CN
        • Alipay HK
        • Alipay
    • Subscription
      • Get started with Subscription
    • Online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
      • Supported Payment Methods for Checkout
    • Checkout session
      • Checkout Session Guide
  • Developer
    • Introduction
    • Authentication
    • Integrate Local Payment Methods
    • Error code
      • last_payment_error documentation
      • Errors
    • 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
      • Retieve Payment Method Session
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook Integration Guide(version 2026-04)
      • Integration details
        • Supported Webhook Events
        • Webhook Activation/Signature Verification Steps
        • Webhook events for example
        • Dispute Webhook Integration Document
        • Difference between version 2026-04 and 2024-10-10
      • archive
        • 2024-10-10
          • Webhook Integration Guide(version 2024-10-10)
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • UseePay Elements Appearance
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • Payment Method Configuration
      • Retieve Payment Method Configuration
    • Checkout Session
      • Create Checkout Session
      • Retrieve Checkout Session
    • Trackers
      • upload trackers
      • Retrieve a tracker
    • Capture
      • Capture Overview
      • List captures by intent id
    • Payement Attempt
      • ECI Indicator (3-D Secure) Reference
      • Retrieve PaymentAttempt
    • Schemas
      • CheckoutSessionCreateRequest
      • PaymentMethod
      • CreatePaymentIntentRequest
      • LineItem
      • Customer
      • Address
      • ProductData
      • Shipping
      • SubscriptionData
      • Error
      • DiscountPeriodConfig
      • DeviceData
      • CheckoutSessionResponse
      • ErrorResponse
      • Order
      • Product
      • PaymentMethodOptions
      • RiskControlOptions
      • Mandate
      • PaymentIntent
      • Billing
      • Card
      • AliPay
      • Wallet
      • Klarna
      • WechatPay
      • Refund
      • Subscription
      • Recurring
      • PriceData
      • SubscriptionItem
      • Invoice
      • NextAction
      • Webhook
      • CollectableOptions
      • PaymentLink
      • last_payment_error
      • discount_period_config
      • Capture
      • three_ds
      • PaymentAttempt
      • konbini
      • client_pm_options
      • pse
      • trial_period_config
      • Seller
  • Message
    • Messaging Element
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  • Reconciliation
    • SFTP Access for Reconciliation
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
    • Introduction
  1. About Payment Methods

Pay with Link

Type: E-wallet / Digital Payment Service
Payment Flow:
1.
The customer selects Link at checkout.
2.
A Link payment modal opens.
3.
The customer signs in to Link.
4.
Link authorizes the payment.
5.
UseePay returns the PaymentIntent result to the merchant.
Refunds: Supports full and partial refunds after the payment has been captured.
Notes:
Suitable for online and cross-border payment scenarios.
Link is currently unavailable in India.
Subscription payments are not currently supported.
Link supports both automatic capture and authorization followed by manual capture.
Supported Transaction Types
Product Support
Supported Countries
One-time payment with automatic capture
Authorization followed by manual capture

Integration Guide#

Link supports two transaction modes:
Modeauto_captureStatus after successful processingMerchant action
Automatic capturetruesucceededNo capture request is required
Authorization and capturefalserequires_captureCapture or cancel the PaymentIntent
Always set auto_capture explicitly. Do not rely on its default value.

Shipping information#

When using Link through Express Checkout, we recommend that you do not provide shipping when creating the PaymentIntent because Link can collect the customer's shipping information.
If shipping is provided when confirming the PaymentIntent, the merchant-provided shipping information overrides the information collected by Link.
For Link payments, billing_country must be provided where required by the PaymentMethod request.

One-time Link payment#

For a normal Link payment, create the PaymentIntent with automatic capture enabled:
{
  "amount": 100.00,
  "currency": "USD",
  "merchant_order_id": "ORDER_20260922001",
  "payment_method_types": [
    "link"
  ],
  "auto_capture": true
}
After the customer completes the Link flow, the PaymentIntent normally reaches succeeded.
The merchant should verify the PaymentIntent status or process the corresponding webhook before fulfilling the order.

Link authorization and capture#

Link authorization separates the authorization of funds from the actual capture.
Create the PaymentIntent with auto_capture set to false:
{
  "amount": 100.00,
  "currency": "USD",
  "merchant_order_id": "ORDER_20260922002",
  "payment_method_types": [
    "link"
  ],
  "auto_capture": false
}
The authorization flow is:
Create PaymentIntent
        ↓
Customer completes the Link flow
        ↓
requires_customer_action / pending
        ↓
requires_capture
        ├── Capture → succeeded
        └── Cancel  → canceled
A PaymentIntent in requires_capture status has been successfully authorized, but the funds have not yet been captured.
Do not treat requires_capture as a completed payment or fulfill the order before the capture succeeds.

Capture the authorization#

When the PaymentIntent reaches requires_capture, call:
Example request:
{
  "amount": 100.00,
  "merchant_order_id": "ORDER_20260922002",
  "final_capture": true
}
Important considerations:
The PaymentIntent must be in requires_capture.
The capture amount must equal the full authorized amount.
Partial capture is not supported.
Multiple captures are not supported.
Only one full capture can be performed for each PaymentIntent.
final_capture must be set to true.
After a successful capture, the PaymentIntent reaches succeeded.
After capture succeeds, any subsequent adjustment must be processed through the Refund API.
See Capture a PaymentIntent.

Cancel the authorization#

If the authorization is no longer required, cancel the PaymentIntent before it is captured:
Example request:
{
  "cancellation_reason": "request_by_customer"
}
Canceling an authorization is different from issuing a refund:
Use Cancel before capture to release the authorization.
Use Refund after the payment has been captured.
A PaymentIntent that has already been captured cannot be canceled.
The time required for the authorized amount to become available again depends on Link and the customer's financial institution.
See Cancel a PaymentIntent.

Link authorization compared with card authorization#

ItemLink authorizationCard authorization
Payment methodLink account and eligible funding sourceCredit or debit card
Customer interactionCompleted in the Link modalCard entry and possible 3DS authentication
Authorization settingauto_capture=falseauto_capture=false
Successful authorization statusrequires_capturerequires_capture
Capture operationOne full captureDepends on the card capability enabled for the merchant
Capture APIPaymentIntent Capture APIPaymentIntent Capture API
Cancel APIPaymentIntent Cancel APIPaymentIntent Cancel API
Shipping informationCan be collected by Link in Express CheckoutUsually supplied by the merchant
Subscription supportNot currently supportedDepends on card and merchant capabilities
Although Link authorization and card authorization use the same PaymentIntent lifecycle, they differ in customer interaction, payment credentials, supported regions, and risk controls.

PaymentIntent status handling#

StatusDescriptionMerchant action
requires_payment_methodA payment method is requiredWait for the customer to select Link
requires_customer_actionThe customer must complete an action in LinkDisplay or continue the Link flow
pendingThe payment result is still being processedWait for a webhook or retrieve the PaymentIntent
requires_captureThe authorization succeededCapture or cancel the authorization
succeededThe full amount was captured successfullyFulfill the order
canceledThe PaymentIntent was canceledClose or restore the order
failedThe authorization or payment failedDisplay the failure and allow retry where applicable
Do not determine the final payment result only from the browser redirect. Use the PaymentIntent status and webhook events as the source of truth.
Relevant webhook events include:
payment_intent.requires_customer_action
payment_intent.pending
payment_intent.requires_capture
capture.succeeded
capture.failed
payment_intent.cancelled
payment_intent.failed
Webhook processing should be idempotent because events might be delivered more than once or arrive out of order.

Use Link in checkout#

1.
Wait for the Link button to appear on the checkout page.
Link button
2.
Click the Link button and enter the email address associated with the Link account.
Link account login
3.
Select a shipping address and an eligible funding source.
Link shipping and funding source
4.
Complete the Link payment or authorization.
5.
After the Link flow finishes, the customer is redirected back to the checkout page.
6.
Check the PaymentIntent status:
If the status is succeeded, the payment is complete.
If the status is requires_capture, submit a full capture request when the order is ready.
If the status is pending, wait for the final webhook notification.
If the status is failed or canceled, do not fulfill the order.

Integration checklist#

Before going live, make sure that:
auto_capture is explicitly set for every Link PaymentIntent.
The merchant system correctly handles requires_customer_action.
The merchant system does not treat requires_capture as a completed payment.
Only one full capture is submitted for each authorized PaymentIntent.
The capture amount equals the authorized amount.
Authorizations that are no longer required are canceled.
Captured payments are adjusted through the Refund API instead of the Cancel API.
PaymentIntent and Capture webhook events are verified and processed idempotently.
Order fulfillment is based on the final PaymentIntent status rather than the browser redirect.
Previous
Payco
Next
Pix
Built with