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
      • 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
      • 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
  • 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

Pse

PSE (Pago Seguro en Línea) is a local bank transfer payment method in Colombia that allows customers to pay directly from their bank accounts. UseePay plans to make PSE
│ available in early September 2026.

Overview#

PropertyDetails
Markets (consumer)CO
Consumer currenciesCOP
Authentication methodsREDIRECT
Authentication timeout7 days
Minimum payment amount1,600 COP
Maximum payment amountSubject to channel rules
Payment instrumentBANK_TRANSFER
Recurring paymentsNo
Separate capturesNo
RefundYes
Refund validity180 Days
DisputesNo

Payment Flow#

1.
Customer selects PSE at checkout.
2.
Customer is redirected to the PSE payment page.
3.
Customer selects their bank and completes payment authorization.
4.
After payment is completed, the customer is returned to the merchant site.
5.
The merchant receives the payment result from UseePay.

Notes#

PSE is available for customers in Colombia.
The billing address country must be set to CO.
PSE supports one-time payments only. Recurring payments are not supported.
The customer name and identification number are required.
Provide either billing.name or both billing.first_name and billing.last_name.
payment_method_data.pse.identification_number must contain 6 to 11 digits.
The minimum payment amount is 1,600 COP.

Integration Guide#

Create a PaymentIntent#

Set payment_method_data.type to pse, set billing.address.country to CO, and provide the customer's name and identification number when creating the PaymentIntent.
**Request example **
You can provide the customer name as separate fields instead:
Response example — PSE (COP)
The following response is an illustrative example based on the PaymentIntent response model. IDs and URLs are placeholders; actual fields and values may vary by transaction.
{
    "id": "1012608270000000001",
    "code": "0000",
    "message": "Approved or completed successfully",
    "amount": 1600,
    "currency": "COP",
    "status": "requires_customer_action",
    "description": "Order payment",
    "confirm": true,
    "orderType": "sale",
    "mode": "payment",
    "sale": true,
    "merchant_no": "500000000000000",
    "app_id": "www.example.com",
    "create_at": "2026-08-27T10:00:00Z",
    "modify_at": "2026-08-27T10:00:00Z",
    "merchant_order_id": "your_order_id",
    "refunded_amount": 0,
    "next_action": {
        "type": "redirect",
        "redirect": {
            "method": "GET",
            "url": "https://payment-provider.example/redirect/example-token",
            "content_type": null,
            "app_url": null,
            "package_name": null
        }
    },
    "return_url": "https://your-site.com/payment/return",
    "client_secret": "example_client_secret",
    "auto_capture": true,
    "order_id": "1012608270000000001",
    "latest_payment_attempt": "pa_example0000001",
    "payment_attempt": {
        "id": "pa_example0000001",
        "billing": {
            "address": {
                "country": "CO"
            },
            "email": "juan.garcia@example.com",
            "name": "Juan Garcia"
        },
        "merchant_no": "500000000000000",
        "app_id": "www.example.com",
        "create_at": "2026-08-27T10:00:00Z",
        "modify_at": "2026-08-27T10:00:01Z",
        "api_version": null,
        "payment_intent_id": "1012608270000000001",
        "checkout_session_id": null,
        "merchant_order_id": "your_order_id",
        "order_id": "1012608270000000001",
        "payment_method_details": {
            "type": "pse"
        },
        "return_url": "https://your-site.com/payment/return"
    },
    "setup_future_usage": false
}
When status is requires_customer_action, redirect the customer to next_action.redirect.url using the specified HTTP method. After the customer completes or cancels the payment, they are returned to return_url.
Do not determine the final payment result only from the browser redirect. Retrieve the PaymentIntent or process the UseePay payment notification to obtain the latest transaction status.

Required Customer Information#

FieldRequirementDescription
billing.address.countryRequiredMust be CO.
billing.nameConditionally requiredCustomer's full name. Required unless both billing.first_name and billing.last_name are provided.
billing.first_nameConditionally requiredCustomer's first name. Use together with billing.last_name when billing.name is not provided.
billing.last_nameConditionally requiredCustomer's last name. Use together with billing.first_name when billing.name is not provided.
billing.emailRequired for CheckoutCustomer's email address.
payment_method_data.pse.identification_numberRequiredColombian customer identification number, containing 6 to 11 digits.
Previous
Pix
Next
Samsung Pay
Built with