After checkout, manage stored credentials and settled APM orders.

Operation Description
Recurring Charge a stored token without collecting payment details again.
Revoke token Cancel a stored token. Subscriptions that use the token are cancelled.
Refund Return funds for a successfully processed order. Cash-based methods can limit or block refunds.
Check status Read the current order, including token, method, and transaction details.

Create the first order and set future usage in init APM. Order statuses and webhooks are in track APMs. Recurring and revoke apply only to methods that issue a reusable token.

Recurring

The Recurring endpoint charges a stored token at a later time.

AlipayAlipay Blik RecurringBlik Recurring GCashGCash KlarnaKlarna MB WAYMB WAY Mercado PagoMercado Pago PayPalPayPal PixPix SmartPixSmartPix Pix AutomáticoPix Automático UPIUPI WeChat PayWeChat Pay API Recurring API v1 initiates a token-based charge. After the first successful payment, the token is in order.token from updated alternative order Webhook or check order status API v1 .
Send that token with the matching payment_method. Where the table lists a payment_type , the token must come from a successful init with that value.
Method payment_method Token from
Alipay alipay unscheduled
Blik Recurring blik unscheduled
GCash gcash unscheduled
Klarna klarna-network recurring
MB WAY mbway 1-click
Mercado Pago mercadopago —
PayPal paypal-vault —
Pix, SmartPix pix —
Pix Automático pix-automatico —
UPI upi —
WeChat Pay wechatpay unscheduled

Revoke token

Revoke token cancels a recurring token and stops later charges.

AlipayAlipay MB WAYMB WAY WeChat PayWeChat Pay API Revoke token API v1 cancels the token. After a successful revoke, expect the revoked recurring token Webhook . Subscriptions that use the token are cancelled.

Use this operation when the customer revokes authorization or the agreement is no longer needed.

Refund

Refund returns funds for a successfully processed APM order.

API Refund APM order API v1 initiates the refund. Send order_id, amount in the smallest currency unit, and refund_reason_code. A smaller amount is a partial refund when the method allows it. Cash-based methods can limit or block refunds. PayPal does not provide an ARN. Generate a refund confirmation in Hub for those orders. Hub To issue a refund

  1. Go to Payments > Orders.
  2. Select the order you need 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 , download the Refund confirmation PDF from the Transactions section in the customer language and share it with them. Share it with the customer as proof that the refund processed. Keep it for financial records and tax reporting. Present it to financial institutions if they inquire about the transaction.

If a chargeback is open, refund is inactive in Hub and in the bank system to prevent duplicate payouts.

Refunds can be declined when the account cannot accept them. Common PayPal decline reasons:

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

Check status

Check status returns the current APM order.

API Check status API v1 returns order status, payment method, transaction details, and customer information, including order.token when a token exists. Use it to poll when a webhook is delayed. Status values are in payment lifecycle.