Solidgate Documentation
website·Indexed 35 days ago
https://docs.solidgate.comDeveloper documentation for integrating payment processing, including card payments, subscriptions 1.0, and a wide range of alternative payment methods (APMs) such as PayPal, Blik, Pix, and Alipay. Includes guides on payment form events for Svelte, Vue, and React SDKs, zero-amount authorization, and payment insights for troubleshooting error and decline codes.
What's inside Solidgate
- The Solidgate Hub uses role-based access control (RBAC) to manage who can view data and perform actions. Access control is managed via the account name menu in the top-left corner and is split into two main areas: Roles (defining what actions can be performed) and User Management (inviting users and assigning those roles). Two-factor authentication (2FA) is enabled by default for all users and cannot be disabled, though Merchant admins can reset it for users on the User details page.
Overview of Solidgate Financial Invoices
Financial invoices centralize all invoices issued by Solidgate and integrated providers (such as Adyen, Checkout, and Solidgate Acquiring) for accounting, bank reconciliation, and audit support. Each invoice record contains the following metadata:
- Provider: The provider who sent the report.
- Legal entity: The legal entity to which the report was sent.
- Public ID: A unique identifier for the invoice.
- Period: The date range of the report.
- Currency: The currency of the invoice.
- Uploaded at: The date the report was uploaded.
Overview of supported Alternative Payment Methods (APMs)
Solidgate supports a wide variety of Alternative Payment Methods (APMs) across different regions and categories. These methods can be filtered by region (APAC, Europe, Latin America, USA), category (A2A, Digital wallets, Cash-based, BNPL, Crypto-based, Carrier billing), payment flow (Direct, Redirect), and integration type (API, Payment Form, Payment Page, Payment Link). Supported APMs include:
- Digital Wallets/Apps: Alipay, Bizum, Cash App Pay, GCash, MB WAY, Mercado Pago, MobilePay, PayPal, WeChat Pay
- Bank Transfers/A2A: iDEAL | Wero, Pay by Bank, Pix, Przelewy24, PSE, UPI (Collect and Intent)
- Cash-based/Vouchers: Boleto, Efecty, Multibanco, OXXO, Sencillito, Servipag
- BNPL/Other: Klarna, Blik (One-time, Pay Later, Recurring)
- Regional Specifics: Webpay, SmartPix
Overview of UPI Intent payments
UPI Intent is an app-to-app redirect flow for payments in India (INR). It is the recommended integration over UPI Collect to improve mobile conversion and ensure compliance with NPCI guidelines (effective February 2026) which restrict manual VPA entry on mobile.
Key Constraints:
- Minimum Amount: 29.50 INR
- Maximum Amount: Bank dependent
- Session Window: 15 minutes
- Payment Flow: Must be set to
redirect.
Overview of BLIK Recurring payments
BLIK Recurring allows merchants to set up automatic payments for customers in Poland. During the first transaction, the customer grants a mandate in their banking app. Subsequent charges are processed as Merchant Initiated Transactions (MIT) without requiring further customer action or BLIK codes.
Key Constraints:
- Coverage: Poland (PL) only.
- Currency: Polish Zloty (PLN).
- Transaction Limits: Minimum 0.01 PLN; Maximum 2,000.00 PLN per recurring charge.
- Supported Banks: PKO BP, Bank Millennium, Erste Bank Polska, Spółdzielcza Grupa Bankowa, ING Bank Śląski, Nest Bank, Alior Bank, and Credit Agricole.
- Operations: Supports full and partial refunds. Chargebacks are not supported.
Overview of SmartPix payments
SmartPix allows merchants to collect one-time or recurring payments from customers' bank accounts in Brazil using Open Finance technology. It supports A2A (Account-to-Account) transfers with a redirect payment flow.
Key Constraints:
- Coverage: Brazil (BR)
- Currency: Brazilian Real (BRL)
- Minimum Amount: 0.50 BRL
- Maximum Amount: Dependent on the bank
- Expiration: Pix payments are real-time transfers that expire after 1 hour; unpaid transactions are automatically cancelled.
Overview of Solidgate Alternative Payment Methods (APM)
Alternative Payment Methods (APM) allow merchants to accept non-traditional payments beyond credit and debit cards, including digital wallets, bank transfers, mobile payments, and cash vouchers. These methods are often region-specific and enable a more diverse checkout experience. The Solidgate API v1 provides endpoints for method comparison, order creation, post-checkout operations, and lifecycle/decline reference data.Overview of Pix payment method
Pix is an instant account-to-account payment system regulated by the Central Bank of Brazil (BCB), enabling 24/7 transfers via QR codes. It supports both one-time payments (Pix QR) and recurring mandates (Pix Automático).Overview of UPI Collect payments
UPI Collect is a pull-based payment method for India (IN) using the Indian Rupee (INR). In this flow, the customer manually enters their Virtual Payment Address (VPA), and the merchant sends a collect request which the customer must approve via a push notification in their UPI app within 15 minutes.
Key Constraints:
- Minimum amount: 29.50 INR
- Maximum amount: Bank dependent
- Payment flow: Must set
payment_method_flowtodirector omit the field. - Refunds: Supports full and partial refunds, but does not support multiple partial refunds or chargebacks.
Deprecation Notice: NPCI plans to deprecate the UPI Collect flow. Merchants are encouraged to migrate to UPI Intent.
Overview of Solidgate Webhooks v1 vs v2
Solidgate provides two versions of webhooks to align with its API versions.
Webhooks v1 (Billing 1.0):
- Signature: HMAC-SHA512 using webhook public (
wh_pk_) and secret keys. - Identification: URL paired with a
channel_id. - Event Scope: Card payments, alternative payments, subscriptions, and taxes.
- Deduplication: Uses
solidgate-event-id,solidgate-event-created-at, andsolidgate-event-typeheaders. - Retries: Fixed schedule from 15 minutes up to 24 hours (up to 8 retries).
Webhooks v2 (Billing 2.0):
- Signature: HMAC-SHA256 using an endpoint secret, sent in the
signatureheader. - Identification: Endpoint ID with
included_channel_idsorexcluded_channel_idsscoping. - Event Scope: Invoices, subscriptions, customers, payment instruments, fraud/prevention alerts, and routing.
- Deduplication: Uses
event_id,event_type, andoccurred_atfields located inside the JSON payload body. - Management: Endpoints start as INACTIVE and must be activated. Supports secret rotation with a grace period.
- Signature: HMAC-SHA512 using webhook public (
Overview of Solidgate Subscriptions
Solidgate subscriptions provide automated recurring billing to connect customers to products and services. The system manages billing periods, trial configurations, payment retries, and real-time event notifications, allowing merchants to control the entire subscription lifecycle.Overview of Click to Pay integration with Solidgate
Click to Pay allows customers to pay using saved cards from Visa, Mastercard, or American Express without re-entering card details. The integration is powered by Unified Checkout Solutions (UCS) and is integrated directly into the Solidgate payment form.
Key operational details:
- Availability: Click to Pay works exclusively through Solidgate Acquiring. It is not available on other processing paths.
- Requirements: To use this feature, you must have a Solidgate Acquiring connector account and be onboarded to Unified Checkout Solutions (UCS).
- Onboarding: UCS onboarding is not self-serve; you must contact your Solidgate account manager to map your merchant legal entity to a UCS identifier.