Init APM

Create alternative payment orders and configure future payment usage for one-time, 1-click, recurring, and unscheduled flows

Payment initiation and future usage configuration are the first steps in the alternative payment lifecycle. Use the flows below to create orders and define how stored credentials are used later.

API

Init payment API v1 endpoint initiates a payment using an alternative payment method, creates the order, and prepares the transaction so the customer can proceed with the payment process.

Init future payment

Billing logic defines who initiates a payment and whether the customer is present.

Billing logic	payment_type
One-time	one-time 1-click recurring unscheduled
1-click	one-time 1-click recurring unscheduled
Recurring	one-time 1-click recurring unscheduled
Unscheduled	one-time 1-click recurring unscheduled

Payment type is the API value in future_usage.payment_type . The value can differ from the billing-logic label. unscheduled is a superset of Unscheduled, Recurring, and 1-click when the provider does not restrict token use. When a method supports both a native type and unscheduled , send the native type.

Method	payment_type
Guide Accept Alipay payments from Chinese consumers with QR code and redirect-based checkout flows for cross-border e-commerce transactions. Alipay alipay	one-time 1-click recurring unscheduled
Guide Integrate Bizum for the Spanish market to enable instant peer-to-peer bank payments directly from customer mobile banking applications. Bizum bizum	one-time 1-click recurring unscheduled
Guide Accept BLIK payments in Poland with one-time authorization codes that let customers pay directly from their bank accounts in real time. Blik One-time blik	one-time 1-click recurring unscheduled
Guide Offer BLIK Pay Later in Poland so customers can defer payment for 30 days while merchants receive funds upfront through existing BLIK infrastructure. Blik Pay Later blik-bnpl	one-time 1-click recurring unscheduled
Guide Accept BLIK Recurring in Poland with a one-time mandate setup that lets merchants charge a customer's bank account automatically without re-authentication for each transaction. Blik Recurring blik	one-time 1-click recurring unscheduled
Guide Accept Cash App Pay to let US customers check out using their Cash App balance or linked debit card with a seamless mobile experience. Cash App cashapp	one-time 1-click recurring unscheduled
Guide Accept GCash e-wallet payments to reach millions of Filipino consumers with mobile-first checkout and instant transaction confirmation. GCash gcash	one-time 1-click recurring unscheduled
Guide Accept Klarna payments globally with pay now, pay later, and financing options through a single redirect-based Solidgate integration. Klarna klarna-network	one-time 1-click recurring unscheduled
Guide Accept MB WAY mobile payments from Portuguese customers with instant bank-linked transactions and real-time authorization confirmation. MB WAY mbway	one-time 1-click recurring unscheduled
Guide Accept MobilePay to reach customers in Denmark and Finland with mobile wallet checkout via redirect and app-based authorization. MobilePay mobilepay	one-time 1-click recurring unscheduled
Guide Accept Multibanco bank reference payments in Portugal with voucher-based checkout, redeemable at ATMs, banks, and home banking. Multibanco multibanco	one-time 1-click recurring unscheduled
Guide Pix Automático is a BCB recurring payment mandate in Brazil. Pix Automático pix-automatico	one-time 1-click recurring unscheduled
Guide Accept UPI Collect payments in India where customers enter a Virtual Payment Address and approve a push notification in their UPI app. UPI Collect upi	one-time 1-click recurring unscheduled
Guide Accept UPI Intent payments in India where customers select their UPI app directly or scan a QR code on desktop for one-time and mandate-based checkout. UPI Intent upi	one-time 1-click recurring unscheduled
Guide Accept WeChat Pay to reach over one billion Chinese consumers with in-app and QR-code-based mobile payment flows for cross-border sales. WeChat wechatpay	one-time 1-click recurring unscheduled

API

Init payment API v1 , create page API v1 , create link API v1 or init payment form Guide with future_usage object
Use this flow to define intent for subsequent use of the customer's payment credentials, token-based future charges.
It ensures compliance with scheme rules, reduces declines on future payments, and improves success rates.

future_usage

object

Required

Description

Defines the usage of stored payment credentials.

Should be provided either future_usage or product_id for payment_method alipay , bizum , cashapp , gcash , klarna-network , mbway , mobilepay , multibanco , pix-automatico , wechatpay .

Example

1
2
3
4
5

{
  "future_usage": {
    "payment_type": "recurring"
  }
}

payment_type

string

Required

Description

Type of the token usage scenario.

one-time no token created, for one-off use. Maps only to One-time billing logic.
1-click token for future customer-initiated payments without re-entering details. Maps only to 1-click billing logic.
recurring token for fixed scheduled merchant-initiated charges, for subscriptions. Maps only to Recurring billing logic.
unscheduled token for unscheduled or variable merchant-initiated charges, for auto-top-up. Maps to Unscheduled, Recurring, and 1-click when the provider does not restrict token use.

Future usage

Init future payment calculation

Solidgate calculates the payment intent from payment_type and product_id. When both are sent and they conflict, the request is declined. A one-time payment with a recurring product is a conflict. When only product_id is sent, payment_type comes from the product type.

payment_type	Product type	Result	Calculated value
		DECLINED
	one-time	OK	one-time
	recurring	OK	recurring
one-time		OK	one-time
one-time	one-time	OK	one-time
one-time	recurring	DECLINED
1-click		OK	1-click
1-click	one-time	OK	1-click
1-click	recurring	DECLINED
recurring		OK	recurring
recurring	one-time	DECLINED
recurring	recurring	OK	recurring
unscheduled		OK	unscheduled
unscheduled	one-time	OK	unscheduled
unscheduled	recurring	OK	unscheduled

Looking for help? Contact us

Stay informed with Changelog