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
      • Card
      • Klarna
      • Naver pay
      • Kakao Pay
      • Toss Pay
      • Payco
      • Affirm
      • Blik
      • Trustly
      • Cashapp
      • Pay with Link
      • AfterPay ClearPay
      • Pix
      • iDEAL
      • ApplePay
        • Apple Pay
        • Apple Pay Web Integration (API Integration)
      • GooglePay
        • Google Pay
        • Google Pay Web Integration (API Integration)
    • 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
    • Errors
    • Error code
      • last_payment_error documentation
    • 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 2026-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
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • About Testing
      • Test Cards
      • ApplePay&GooglePay
    • 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
      • 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
  • Reconciliation
    • SFTP Access for Reconciliation
  • Message
    • Messaging Element
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
  1. About Payment Methods

iDEAL

Type: Online Banking / Bank Redirect Payment Method (Netherlands)
Payment Flow:
1.
Customer selects iDEAL at checkout.
2.
The merchant creates or confirms a PaymentIntent with payment_method_data.type = ideal.
3.
UseePay returns next_action.redirect.url when customer action is required.
4.
The customer is redirected to the iDEAL payment page, or the iDEAL page is displayed in the checkout flow.
5.
Customer completes the payment using a Netherlands bank app or wallet.
6.
After payment completion, the user is returned to the merchant site, and the merchant receives the payment result by webhook.
Refunds: Supports full and partial refunds; refund processing time depends on channel and acquiring rules.
Notes:
Before enabling Ideal payments, please contact UseePay customer service to apply for Ideal activation.
iDEAL is available globally, but customers must have a Dutch bank account. The primary settlement currency is EUR; if another currency is provided, currency conversion will be performed and additional fees may apply.
Supported Transaction Types
Product Support
Supported Countries
One-time Payment

πŸ’³ Payment Methods and Amount Limits#

1. iDEAL#

CurrencyMinimum AmountMaximum Amount
EURDepends on channel configurationDepends on channel configuration
πŸ’‘ iDEAL amount limits may vary depending on the merchant configuration, acquiring channel, and risk rules.

Integration Guide#


Required Fields#

FieldRequiredDescription
currencyRequiredexample EUR
payment_method_data.typeRequiredMust be ideal.
payment_method_data.billing.address.countryRequiredexample NL.
payment_method_data.billing.address.fisrt_nameRequired.
payment_method_data.billing.address.last_nameRequired.
return_urlRequiredURL to return the customer after payment authentication.
device_data.ip_addressRequiredCustomer IP address for risk analysis.

Create and Confirm a PaymentIntent#

Create and confirm a PaymentIntent with payment_method_data.type = ideal.
{
  "amount": 10,
  "currency": "EUR",
  "merchant_order_id": "order_202606080001",
  "confirm": true,
  "auto_capture": true,
  "return_url": "https://example.com/return",
  "customer": {
    "email": "customer@example.com",
    "first_name": "Maria",
    "last_name": "Silva",
    "address": {
      "country": "NL"
    }
  },
  "payment_method_data": {
    "type": "ideal",
    "billing": {
      "email": "customer@example.com",
      "name": "Maria Silva",
      "first_name": "Maria",
      "last_name": "Silva",
      "phone": "+5511999999999",
      "address": {
        "country": "NL",
        "city": "Sao Paulo",
        "state": "SP",
        "postcode": "01001000",
        "line1": "Praca da Se 1"
      }
    }
  },
  "device_data": {
    "ip_address": "203.0.113.10",
    "browser": {
      "user_agent": "Mozilla/5.0"
    }
  }
}
When the PaymentIntent requires customer action, the response includes next_action.redirect.
{
  "id": "1012606080000000001",
  "status": "requires_customer_action",
  "currency": "EUR",
  "amount": 10,
  "next_action": {
    "type": "redirect",
    "redirect": {
      "method": "GET",
      "url": "https://pay.dlocal.com/gmf-apm/payments/N-example"
    }
  }
}
Redirect the customer to next_action.redirect.url to complete the payment

Flowchart#

One-time Payment#

Modified atΒ 2026-06-12 07:47:35
Previous
Pix
Next
Apple Pay
Built with