Manage APMs
Get in touch
Sign in
Manage APMs
Effectively handle alternative payments using the payment operations framework

By supporting a range of alternative payment solutions, Solidgate empowers businesses to expand their reach and boost customer satisfaction across diverse markets.

The features for managing payments with APMs include payment initiation, Guide
Explore Solidgate subscriptions for seamless recurring customer payments. subscription automation, refund processing, and real-time transaction tracking.


Init payment
anchor

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
anchor

Init payment API with future_usage object
Operation defines your intent for subsequent use of the customer's payment credentials, a recurring token.
It ensures compliance with scheme rules, reduces declines on future payments, and boosts the success rate of subsequent charges for PSPs and customer banks.

Description

Defines the usage of stored payment credentials.

Should be provided either future_usage or product_id for payment_method alipay , bizum , mbway , 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

one-time1-clickrecurringunscheduled
Guide
Alipay is a popular digital wallet in China providing simple and secure payment solutions. Alipay alipay		supportednot supportednot supportedsupported
Guide
Bizum enables instant bank-to-bank transfers in Spain. Bizum bizum		supportednot supportednot supportednot supported
Guide
MB WAY is a popular mobile payment solution in Portugal. MB WAY mbway		supportedsupportedsupportednot supported
Guide
WeChat Pay is a digital e-wallet service integrated into WeChat, China's largest social platform. WeChat wechatpay		supportednot supportednot supportedsupported

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-timeOKone-time
-recurringOKrecurring
one-time-OKone-time
one-timeone-timeOKone-time
one-timerecurringDECLINED-
1-click-OK1-click
1-clickone-timeOK1-click
1-clickrecurringDECLINED-
recurring-OKrecurring
recurringone-timeDECLINED-
recurringrecurringOKrecurring
unscheduled-OKunscheduled
unscheduledone-timeOKunscheduled
unscheduledrecurringOKunscheduled

Recurring
anchor

Recurring API
For alternative payment methods Guide
Alipay is a popular digital wallet in China providing simple and secure payment solutions. Alipay, Guide
WeChat Pay is a digital e-wallet service integrated into WeChat, China's largest social platform. WeChat Pay, Guide
GCash is the most popular electronic wallet in the Philippines with over 80% market share. GCash, Guide
PayPal provides a global online payment platform for secure transactions. PayPal, Guide
Cash App is a popular app in the US that allows customers to bank, invest, send, and receive money. Cash App, Guide
Mercado Pago ensures secure and versatile online payments in Latin America. Mercado Pago, Guide
Pix simplifies real-time payments in Brazil with secure and instant account-to-account transfers. Pix or Guide
UPI is a real-time mobile payment system by NPCI India for instant bank-to-bank transfers. UPI, a token-based recurring payment refers to an automatic charge applied to a customer's payment method at predetermined intervals.

After the first successful payment, you can leverage the token system for recurring transactions. The token containing essential payment method information is accessible via the order token field from:

With this token, initiate a recurring request using token with payment_method alipay , wechatpay , gcash , paypal-vault , cashapp , mercadopago , pix or upi .

For payment_method alipay , wechatpay , the token must be obtained from a previous successful transaction with future_usage payment_type set to unscheduled .

This process involves securely storing a token representing the customer’s payment details and using it for follow-up transactions without requiring input each time.

Refund
anchor

Refund APM order API
Solidgate handles refunds for both Guide
Accept and manage credit card payments from your customers. Cards are the most popular payment method globally, offering convenience and widespread acceptance. card payments and APMs through its secure payment gateway integration.

The APM refund request supports alternative payment methods, including PayPal, Pay by Bank, and others, allowing to initiate refunds for successfully processed orders.

It is vital to be aware that refunds in APMs, particularly in cash-based methods, may be limited or unavailable. PayPal does not provide an ARN for refunds. It is recommended to generate a Refund confirmation via Hub for orders.
To issue a refund

  1. Go to Payments > Orders.
  2. Select the needed order to go to the order details page.
  3. In the top-right corner, click on the Refund button.
  4. In the appeared form, complete the refund information:
    • Select Full refund or Partial refund
    • Specify the refund reason
  5. Click on Refund to confirm.
For currencies with 0 minor units, enter refund amounts without any punctuation to ensure correct processing.

Once the refund is successful , you can get the Refund confirmation on the Transactions section and share it with the customer. The refund confirmation serves as proof of a completed refund transaction and can be used for several purposes:
  • Share it with the customer as proof that the refund has been processed successfully, building trust and transparency in your business relationships.
  • Update your financial records to ensure accurate bookkeeping for tax purposes, track refund patterns, and maintain a clear financial history.
  • Present it to financial institutions if they have any inquiries about the transaction.

If a chargeback is opened, the refund option is disabled in both the Hub and the bank’s system to prevent duplicate payouts.

Refunds can be declined primarily because the cardholder’s account cannot accept them. The common reasons for a declined Guide
Effectively managing PayPal disputes and chargebacks. PayPal refund include:

  • Connection timed out: PayPal did not respond while processing the return. Please repeat the refund at a later time.
  • Channel to dispute the refund:
    • For dispute_channel internal make a refund through the Hub.
    • For dispute_channel external , the refund cannot be processed at this stage and can only be disputed. However, it can be successful if the bank reversal is confirmed in the PayPal admin panel.

Check status
anchor

Check status API
Request for receiving current order status.

The key benefit is that it allows merchants to efficiently monitor and manage their payments. It provides comprehensive information about the order's status, payment method, transaction details, and customer information.
Looking for help? Contact us
Stay informed with Changelog