Solidgate helps you operate alternative payments after checkout subscriptions, refunds, token lifecycle, and status tracking. To create orders and configure future usage, use init alternative payment.

Recurring

API Recurring API v1 endpoint initiates a token-based automatic charge at predetermined intervals for alternative payment methods Alipay, Blik Recurring, WeChat Pay, GCash, Klarna, PayPal, Mercado Pago, Pix, SmartPix, or UPI.

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 , blik , wechatpay , gcash , klarna-network , mbway , paypal-vault , mercadopago , pix , pix-automatico or upi .

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

For payment_method klarna-network , the token must be obtained from a previous successful transaction with future_usage.payment_type set to recurring .

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

API Revoke token API v1 endpoint cancels a recurring token and stops future charges for alternative payment methods Alipay, WeChat Pay, and MB WAY. After a successful revoke, expect the revoked recurring token Webhook . When a token is revoked, all subscriptions that use it are cancelled.
Use it when a customer revokes authorization or the recurring agreement is no longer needed.

Refund

API Refund APM order API v1 endpoint initiates refunds for successfully processed APM orders, including PayPal, Pay by Bank, and others. Solidgate handles refunds for both card payments and APMs through its secure payment gateway integration.

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. Hub 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 download the Refund confirmation PDF from the Transactions section in the customer’s language and share it with them. 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 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

API Check status API v1 endpoint retrieves the 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.