Manage APMs

Sign in Hub
Get help
Manage APMs
Handle APM payment operations from initiation through settlement using consistent patterns for captures, refunds, and void actions

Solidgate helps you operate alternative payments after checkout Guide
Set up recurring payments with Solidgate subscriptions to create products, configure trial periods, and manage billing frequencies. subscriptions, refunds, token lifecycle, and status tracking. To create orders and configure future usage, use init alternative payment.

Recurring
anchor

Recurring API v1
For alternative payment methods Guide
Accept Alipay payments from Chinese consumers with QR code and redirect-based checkout flows for cross-border e-commerce transactions. Alipay, 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 Pay, Guide
Accept GCash e-wallet payments to reach millions of Filipino consumers with mobile-first checkout and instant transaction confirmation. GCash, Guide
Accept PayPal payments to offer customers a trusted global checkout option with buyer protection and multi-currency wallet support. PayPal, Guide
Accept Mercado Pago payments across Latin America with multi-method checkout supporting cards, wallets, and local payment options. Mercado Pago, Guide
Pix includes Pix Automático for token-based recurring charges and Pix QR documentation in Brazil. Pix, Guide
Accept SmartPix one-time and recurring payments in Brazil through Open Finance-powered direct bank connections with real-time settlement. SmartPix, or Guide
Accept UPI payments in India with instant bank-to-bank transfers through a government-backed real-time payment infrastructure network. 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 , mbway , paypal-vault , mercadopago , pix , pix-automatico 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 .

For payment_method mbway , the token must be obtained from a previous successful transaction with future_usage payment_type set to 1-click .

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.

Revoke token
anchor

Revoke token API v1
For alternative payment methods Guide
Accept Alipay payments from Chinese consumers with QR code and redirect-based checkout flows for cross-border e-commerce transactions. Alipay, 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 Pay, and Guide
Accept MB WAY mobile payments from Portuguese customers with instant bank-linked transactions and real-time authorization confirmation. MB WAY, revoke token is a request to cancel a recurring token and stop future charges. After a successful revoke, expect the revoked recurring token Webhook . When a token is revoked, all Guide
Set up recurring payments with Solidgate subscriptions to create products, configure trial periods, and manage billing frequencies. subscriptions that use it are cancelled.

Use it when a customer revokes authorization or the recurring agreement is no longer needed.

Refund
anchor

Refund APM order API v1
Solidgate handles refunds for both Guide
Execute card payment operations including authorization, capture, void, refund, and status queries through the unified API framework. 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 inactive 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
Analyze PayPal dispute data with detailed case breakdowns, reason code distributions, and resolution outcome metrics for informed decisions. 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 v1
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