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. Supported 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
    • Supported Payment Methods
      • Affirm
      • AfterPay_ClearPay
      • Bancontact
      • Bank Transfer
      • Blik
      • Boost
      • Card
      • Cashapp
      • Dana
      • GCash
      • iDEAL
      • Kakao Pay
      • Klarna
      • Konbini
      • Korean Card
      • Maya
      • MB_WAY
      • Mobilepay
      • Naver pay
      • P24
      • Payco
      • Pay with Link
      • Pix
      • Pse
      • Rabbit LINE Pay
      • Samsung Pay
      • Servipag
      • SPEI
      • Tmoney
      • Toss Pay
      • Trustly
      • TrueMoney
      • Webpay
      • RSA-Encrypted Card Payments
      • Zip
      • 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
    • Checkout session
      • Checkout Session Guide
    • Payment Capabilities
      • Currency Amount Unit Specification
      • Adaptive Price
  • 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
      • RabbitLinePay
  • Message
    • Messaging Element
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  • Reconciliation
    • SFTP Access for Reconciliation
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
    • Introduction
  1. Supported Payment Methods

Zip

Overview#

PropertyDetails
Markets (consumer)AU, US
Consumer currenciesAUD, USD
Minimum payment amountAUD 1 / USD 35
Maximum payment amountAUD 50,000 / USD 1,500
Authentication methodsREDIRECT
Authentication timeout2 hours
Payment instrumentBNPL
Recurring paymentsNo
Separate capturesNo
RefundFull, Partial
Refund validity180 days
DisputesYes (Only full disputes are supported)
Supported productsCheckout Session · Hosted Checkout · Embedded Checkout · API

Payment flow#

1.
Customer selects ZIP at checkout.
2.
Merchant creates and confirms a PaymentIntent; the response returns next_action.redirect.url.
3.
Redirect the customer to the Zip authorization page, where they log in and accept the payment plan.
4.
The customer is returned to return_url after authorization. The browser return only indicates the customer is back — the final result is delivered by webhook notification.

Notes#

Manual capture (authorize-then-capture) is not supported.
return_url is only the browser return address; it is not proof of payment success.
Only full disputes are supported; partial disputes are not supported. Dispute handling differs by market, as described in Dispute process.
Zip maintains a list of prohibited and restricted merchant category codes (e.g. gambling, financial services, certain software categories). Merchants in restricted categories must provide additional information before enabling Zip.

Buy Now Pay Later (BNPL)#

Australia (AU)
United States (US)
PlanScenarioRules
Zip PaySmall purchases with flexible repaymentCredit limit up to AUD 1,000; customer chooses weekly, fortnightly, or monthly repayment frequency; Zip charges the customer a monthly account fee, waived when the balance is fully repaid within the month.
Zip MoneyLarger purchases with long-term installmentsCredit from AUD 1,000–5,000 (up to AUD 50,000); interest-free for up to 36 months (merchant dependent); higher limits or longer interest-free periods require contacting UseePay.

Refund process#

United States: For a full refund, Zip cancels unpaid installments and returns payments the customer has already made to their original payment method. For a partial refund, Zip reduces the remaining unpaid installments by the refund amount. If the refund exceeds the amount the customer still owes, Zip returns the difference to their original payment method.
Australia: Zip credits the refunded amount to the customer's available Zip balance for both full and partial refunds.

Required Fields#

FieldRequiredDescription
payment_method_data.typeRequiredMust be zip.
payment_method_data.zipRequiredEmpty object {} marking the Zip payload.
payment_method_data.billing.address.countryRequiredCustomer's billing country, ISO alpha-2 (e.g. AU).
payment_method_data.billing.first_nameRecommendedCustomer's first name.
payment_method_data.billing.last_nameRecommendedCustomer's last name.
payment_method_data.billing.emailRecommendedCustomer's email.
return_urlRequiredBrowser return address after Zip authorization.

Create and Confirm a PaymentIntent#

The response contains a redirect instruction:
{
  "id": "1012609070000000002",
  "amount": 100.00,
  "currency": "AUD",
  "status": "requires_customer_action",
  "next_action": {
    "type": "redirect",
    "redirect": {
      "method": "GET",
      "url": "https://zip.example.test/checkout/session_token"
    }
  }
}
zip.png
Previous
RSA-Encrypted Card Payments
Next
Apple Pay
Built with