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
      • Servipag
      • SPEI
      • Webpay
      • 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

SPEI

This payment method is currently available for integration testing only in the sandbox environment and is scheduled to go live in production by the end of October.

Overview#

PropertyDetails
Markets (consumer)MX
Consumer currenciesMXN
Authentication methodsREDIRECT
Authentication timeout1 day
Minimum payment amount1 MXN
Maximum payment amountSubject to channel rules
Payment instrumentBANK_TRANSFER
Recurring paymentsNo
Separate capturesNo
RefundFull / Partial
Refund validity180 Days
DisputesNo

Payment flow#

1.
Customer selects SPEI at checkout.
2.
Customer is redirected to the UseePay-hosted SPEI payment instruction page to get the CLABE account and reference.
3.
Customer completes the transfer through their online banking or bank app.
4.
After the bank confirms the transfer, the customer is returned to the merchant site and the merchant receives the payment result by webhook.

Notes#

SPEI is available for customers with a Mexican bank account.
The billing address country must be set to Mexico (MX).
The payment instruction is valid for 1 day. Unpaid instructions expire and UseePay sends a failed webhook.
The browser return to return_url does not mean the payment succeeded. Treat the webhook as the final status.
Supported Transaction Types
Product Support
Supported Countries
One-time Payment

Required Fields#

FieldRequiredDescription
payment_method_data.typeRequiredMust be spei.
payment_method_data.spei.identification_numberRequiredPayer's Mexican national ID number (CURP 10–18 or RFC 12–13 characters).
payment_method_data.billing.emailRequiredPayer email address.
payment_method_data.billing.first_nameRequiredPayer first name.
payment_method_data.billing.last_nameRequiredPayer last name.
payment_method_data.billing.address.countryRequiredUse MX.
return_urlRequiredURL to return the customer after payment.
device_data.ip_addressRequiredCustomer IP address for risk analysis.

Create and Confirm a PaymentIntent#

When the PaymentIntent requires customer action, the response includes next_action.redirect pointing to the UseePay-hosted SPEI payment instruction page.
{
  "id": "1012609070000000001",
  "status": "requires_customer_action",
  "currency": "MXN",
  "amount": 100,
  "next_action": {
    "type": "redirect",
    "redirect": {
      "method": "GET",
      "url": "https://checkout.useepay.com/spei?session=pmr_xxx&pid=pi_xxx"
    }
  }
}

Hosted Checkout Example#

image.png

Previous
Servipag
Next
Webpay
Built with