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

Use the Host-to-host, Payment Page, Payment Link, or Payment Form flow to initiate a future payment.

	one-time	1-click	recurring	unscheduled
Guide Accept Alipay payments from Chinese consumers with QR code and redirect-based checkout flows for cross-border e-commerce transactions. Alipay alipay	supported	not supported	not supported	supported
Guide Integrate Bizum for the Spanish market to enable instant peer-to-peer bank payments directly from customer mobile banking applications. Bizum bizum	supported	not supported	not supported	not supported
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	supported	not supported	not supported	not supported
Guide Accept BLIK payments in Poland with one-time authorization codes and unscheduled recurring charges after a one-time mandate setup. Blik blik	supported	not supported	not supported	supported
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	supported	not supported	not supported	not supported
Guide Accept GCash e-wallet payments to reach millions of Filipino consumers with mobile-first checkout and instant transaction confirmation. GCash gcash	supported	not supported	not supported	supported
Guide Accept Klarna payments globally with pay now, pay later, and financing options through a single redirect-based Solidgate integration. Klarna klarna-network	supported	not supported	supported	not supported
Guide Accept MB WAY mobile payments from Portuguese customers with instant bank-linked transactions and real-time authorization confirmation. MB WAY mbway	supported	supported	supported	not supported
Guide Accept MobilePay to reach customers in Denmark and Finland with mobile wallet checkout via redirect and app-based authorization. MobilePay mobilepay	supported	not supported	not supported	not supported
Guide Accept Multibanco bank reference payments in Portugal with voucher-based checkout, redeemable at ATMs, banks, and home banking. Multibanco multibanco	supported	not supported	not supported	not supported
Guide Pix Automático is a BCB recurring payment mandate in Brazil. Pix Automático pix-automatico	not supported	not supported	supported	not supported
Guide Accept UPI payments in India with instant bank-to-bank transfers through a government-backed real-time payment infrastructure network. UPI upi	not supported	not supported	supported	supported
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	supported	not supported	not supported	supported

API

Init payment API v1 , create page API v1 , create link API v1 or 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 .

For payment_method upi , future_usage is always required. When using a product, provide both future_usage and product_id.

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
1-click token for future CIT without re-entering details
recurring token for fixed scheduled MIT, for subscriptions
unscheduled token for unscheduled/variable MIT, for auto-top-up

For upi :

unscheduled for one-time payments with Collect ( direct ) and Intent ( redirect ). Omit billing_period.

recurring for Autopay mandates with Intent ( redirect ) only. Requires max_amount and billing_period unless a subscription product_id supplies the billing plan. See

        <span class="tooltip_content tooltip_content__hasTitle">
            <span class="tooltip_icon">

            </span>
            <span>
                <span class="tooltip_title">
                    Guide
                </span>
                <br />
                <span class="tooltip_text__boldGrey">
                     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.
                </span>
            </span>
        </span>
    
</span>
      
          <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/upi-intent/">UPI Intent</a>

max_amount

integer

Conditional

Description

Maximum authorized charge amount per billing cycle in the

        <span class="tooltip_content tooltip_content__hasTitle">
            <span class="tooltip_icon">

            </span>
            <span>
                <span class="tooltip_title">
                    Guide
                </span>
                <br />
                <span class="tooltip_text__boldGrey">
                     Review currency codes and the smallest currency unit used for amount fields in Solidgate payment requests.
                </span>
            </span>
        </span>
    
</span>
      
          <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/">smallest currency unit</a>

for INR.

Required for payment_method upi when payment_type is recurring and no product_id or product_price_id is provided. Optional for UPI subscription product payments to set a custom authorization ceiling.

billing_period

object

Conditional

Description

Recurring billing interval for the UPI Autopay mandate.

Required for payment_method upi when payment_type is recurring and no product_id or product_price_id is provided. Do not send billing_period for UPI subscription product payments. The billing plan is taken from the product. Omit when payment_type is unscheduled .

Allowed unit and value combinations are listed in

        <span class="tooltip_content tooltip_content__hasTitle">
            <span class="tooltip_icon">

            </span>
            <span>
                <span class="tooltip_title">
                    Guide
                </span>
                <br />
                <span class="tooltip_text__boldGrey">
                     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.
                </span>
            </span>
        </span>
    
</span>
      
          <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/upi-intent/#billing-periods">UPI Intent</a>

To streamline integration for merchants using product services, the system automatically calculates the appropriate payment intent by combining payment_type and product_id.

When both are provided, the system ensures no conflict between them. In the case of a conflict, such as a one-time payment with a recurring product, the request is declined. If only the product_id is provided, the payment_type is determined based on the product type.

Init future payment calculation

Future usage `payment_type`	Product type by `product_id`	Validation 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