Init APM

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 will be used later.

Init payment API
Operation for initiating a payment using an alternative payment method performs order creation and prepares the transaction for payment, allowing the customer to 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
BLIK Recurring enables automatic charges from a customer's Polish bank account after a one-time mandate setup, without re-authentication for each transaction.
Blik Recurring
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 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 Multibanco bank reference payments in Portugal with voucher-based checkout, settleable at ATMs, 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 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
Init payment API , create page API , create link API or Guide
Set up the Solidgate payment form with step-by-step instructions for script loading, container mounting, and payment request configuration.
init payment form
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.

Description

Defines the usage of stored payment credentials.

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

Example

1
2
3
4
5
{
  "future_usage": {
    "payment_type": "recurring"
  }
}

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

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.

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