API-only integration
This topic describes how to integrate Pix Automático enrollment and submit the first payment through the API-only integration.
User experience
The following images illustrate the user experience for enrollment and first payment:
Web
Pay by scanning the QR code:
Pay by the code:
Mobile
Enrollment and first payment flow
The enrollment and first payment flow is composed of the following steps:
Integration preparations
Before you start integrating, read the Integration Guide and API Overview documents to understand the integration steps of the server-side API and the precautions for calling the API. Furthermore, ensure that the following prerequisites are met:
- Obtain a client ID
- Complete the key configuration
- Complete the configuration of paymentNotifyUrl to receive the asynchronous notification
- Integrate the server-side SDK package, install the server-side library, and initialize a request instance. For more details, refer to Server-side SDKs.
Integration steps
- Initiate an enrollment and first payment request
- Redirect to the normalUrl
- Obtain the enrollment result
- Obtain the first payment result
Step 1: Initiate an enrollment and first payment request Server-side
Call the pay (One-time Payments) API to initiate an enrollment and first payment request. The following are key parameters:
Parameter name | Required | Description |
subscriptionInfo.allowRetry | No | Indicates whether you are allowed to initiate a retry when a recurring payment fails due to insufficient balance. Valid values are:
|
subscriptionInfo.retryMode | No | The retry mode. Valid value is:
|
subscriptionInfo.subscriptionDescription | Yes | The description of the subscription, used for displaying user consumption records and other actions. |
subscriptionInfo.subscriptionStartTime | Yes | The date and time when the subscription becomes active. Note: The start time has to be at least 48 hours in the future. |
subscriptionInfo.periodRule.periodType | Yes | The frequency at which the buyer will be charged. Valid values are:
|
subscriptionInfo.periodRule.periodCount | Yes | The number of period types within one subscription period. Please set the value to 1. Note: Currently, only the value 1 is supported; values such as 2 and 3 are not supported. |
subscriptionInfo.subscriptionNotifyUrl | Yes | The URL that is used to receive the subscription result notification. |
env.terminalType | Yes | Terminal type of which the merchant service applies to. Valid values are:
|
order.orderAmount | Yes | The order amount of the merchant that directly provides services or goods to the customer. |
order.referenceOrderId | Yes | The unique ID to identify the order on the merchant side, which is assigned by the merchant that provides services or goods directly to the customer. |
order.orderDescription | Yes | Summary description of the order. |
paymentRequestId | Yes | The unique ID assigned by a merchant to identify a payment request. |
paymentAmount | Yes | Indicates the initial payment amount to be charged to the user. Note: Discount scenarios require passing the final value after discount. |
settlementStrategy.settlementCurrency | Yes | The ISO currency code of the currency that the merchant wants to be settled against. |
paymentMethod.paymentMethodType | Yes | Set the value of this parameter as PIX_AUTOMATICO. |
paymentMethod.paymentMethodMetaData.maxAmountFloor | No | This value represents the minimum amount merchants can deduct from users for recurring payments. Notes:
|
paymentMethod.paymentMethodMetaData.fixedAmount.currency | No | The currency of the fixed subscription amount. The transaction currency, which is a 3-letter currency code that follows the ISO 4217 standard. |
paymentMethod.paymentMethodMetaData.fixedAmount.value | No | The value of the fixed subscription amount. |
paymentRedirectUrl | Yes | The merchant page URL that the user is redirected to after the payment is completed. |
productCode | Yes | Represents the payment product that is being used, which is stipulated in the contract. For One-time Payments, the value is fixed as CASHIER_PAYMENT. |
public static void payWithPIXAutomatico() {
AlipayPayRequest request = new AlipayPayRequest();
// replace with your paymentRequestId
request.setPaymentRequestId("PAYMENT_" + UUID.randomUUID());
// set product code
request.setProductCode("CASHIER_PAYMENT");
// set payment amount
Amount paymentAmount = Amount.builder().currency("BRL").value("100").build();
request.setPaymentAmount(paymentAmount);
// set env info
Env env = Env.builder().terminalType(TerminalType.WEB).build();
request.setEnv(env);
// set order info
Amount orderAmount = Amount.builder().currency("BRL").value("100").build();
Merchant merchant = Merchant.builder().referenceMerchantId(new Random().nextInt(100000)).build();
Order order = Order.builder()
.orderAmount(orderAmount)
.orderDescription("Order description")
.referenceOrderId("ORDER_" + UUID.randomUUID())
.merchant(merchant)
.build();
request.setOrder(order);
// set payment method with PIX_AUTOMATICO
Map<String, Object> paymentMethodMetaData = new HashMap<>();
paymentMethodMetaData.put("cpf", "02859464980");
paymentMethodMetaData.put("fullName", "full name");
Map<String, String> fixedAmount = new HashMap<>();
fixedAmount.put("currency", "BRL");
fixedAmount.put("value", "200");
paymentMethodMetaData.put("fixedAmount", fixedAmount);
PaymentMethod paymentMethod = PaymentMethod.builder()
.paymentMethodType("PIX_AUTOMATICO")
.paymentMethodMetaData(paymentMethodMetaData)
.build();
request.setPaymentMethod(paymentMethod);
// set subscription info
PeriodRule periodRule = PeriodRule.builder().periodType("YEAR").periodCount(1).build();
SubscriptionInfo subscriptionInfo = SubscriptionInfo.builder()
.periodRule(periodRule)
.subscriptionDescription("Standard Annual Membership")
.subscriptionNotifyUrl("https://api.subscription.ai/pay/antom/subscription/webhook")
.subscriptionStartTime("2026-08-07T10:00:00+08:00")
.allowRetry(true)
.retryMode("MANUAL")
.build();
request.setSubscriptionInfo(subscriptionInfo);
// set settlement strategy
SettlementStrategy settlementStrategy = SettlementStrategy.builder()
.settlementCurrency("SGD")
.build();
request.setSettlementStrategy(settlementStrategy);
// set notification and redirect URLs
request.setPaymentNotifyUrl("https://www.example.com/notify");
request.setPaymentRedirectUrl("https://www.example.com/result");
// execute payment
AlipayPayResponse response = null;
try {
response = CLIENT.execute(request);
} catch (AlipayApiException e) {
String errorMsg = e.getMessage();
// handle error condition
}
}The following code shows a sample of the request message:
{
"env": {
"terminalType": "WEB"
},
"order": {
"orderAmount": {
"currency": "BRL",
"value": "100"
},
"orderDescription": "Cappuccino #grande (Mika's coffee shop)",
"referenceOrderId": "ORDER_{{$randomUUID}}"
},
"paymentAmount": {
"currency": "BRL",
"value": "100"
},
"paymentMethod": {
"paymentMethodType": "PIX_AUTOMATICO",
"paymentMethodMetaData": {
"cpf": "02859464980",
"fullName": "full name",
"fixedAmount": {
"currency": "BRL",
"value": "200"
}
}
},
"subscriptionInfo": {
"periodRule": {
"periodCount": 1,
"periodType": "YEAR"
},
"subscriptionDescription": "Standard Annual Membership",
"subscriptionNotifyUrl": "https://api.subscription.ai/pay/antom/subscription/webhook",
"subscriptionStartTime": "{{$isoTimestamp}}",
"allowRetry": true,
"retryMode": "MANUAL"
},
"settlementStrategy": {
"settlementCurrency": "SGD"
},
"paymentNotifyUrl": "https://www.example.com/notify",
"paymentRedirectUrl": "https://www.example.com/result",
"paymentRequestId": "PAYMENT_{{$randomUUID}}",
"productCode": "CASHIER_PAYMENT"
}The following code shows a sample of the response:
{
"normalUrl": "https://checkout.antom.com/checkout-page/pages/payment/index.html?sessionData=TWArTbEFJoHgO9N239RwW6pcBjDPvlFCZzCXmpxVwO6vsZX1NqR%2BFwiz8nY60vEd75NMSR8POVRxFUJaOFGOew%3D%3D%26%26US%26%26188%26%26eyJlbGlnaWJsZUVhc3lQYXlNYXJrZXRpbmciOmZhbHNlLCJleHRlbmRJbmZvIjoie1wiZGlzcGxheUFudG9tTG9nb1wiOlwidHJ1ZVwifSIsIm5lZWRBY2NvdW50Q29uZmlybVBhZ2UiOmZhbHNlLCJwYXltZW50U2Vzc2lvbkNvbmZpZyI6eyJwYXltZW50TWV0aG9kQ2F0ZWdvcnlUeXBlIjoiQUxMIiwicHJvZHVjdFNjZW5lIjoiQ0hFQ0tPVVRfUEFZTUVOVCIsInByb2R1Y3RTY2VuZVZlcnNpb24iOiIxLjAifSwic2tpcFJlbmRlclBheW1lbnRNZXRob2QiOmZhbHNlfQ%3D%3D",
"orderCodeForm": {
"codeDetails": [
{
"codeValue": "https://global.alipay.com/281002040091jivNzSOJwzTlES490gMv31ls",
"displayType": "TEXT"
},
{
"codeValue": "https://global.alipay.com/merchant/order/showQrImage.htm?code=https%3A%2F%2Fglobal.alipay.com%2F281002040091jivNzSOJwzTlES490gMv31ls&picSize=L",
"displayType": "BIGIMAGE"
},
{
"codeValue": "https://global.alipay.com/merchant/order/showQrImage.htm?code=https%3A%2F%2Fglobal.alipay.com%2F281002040091jivNzSOJwzTlES490gMv31ls&picSize=M",
"displayType": "MIDDLEIMAGE"
},
{
"codeValue": "https://global.alipay.com/merchant/order/showQrImage.htm?code=https%3A%2F%2Fglobal.alipay.com%2F281002040091jivNzSOJwzTlES490gMv31ls&picSize=S",
"displayType": "SMALLIMAGE"
}
],
"expireTime": "2023-04-27T23:33:09-07:00"
},
"paymentAmount": {
"currency": "BRL",
"value": "100"
},
"paymentCreateTime": "2026-01-18T20:42:58-08:00",
"paymentId": "20260119114010800100188430252110586",
"paymentRequestId": "PAYMENT_20260119124256088_AUTO",
"redirectActionForm": {
"method": "GET",
"redirectUrl": "https://checkout.antom.com/checkout-page/pages/payment/index.html?sessionData=TWArTbEFJoHgO9N239RwW6pcBjDPvlFCZzCXmpxVwO6vsZX1NqR%2BFwiz8nY60vEd75NMSR8POVRxFUJaOFGOew%3D%3D%26%26US%26%26188%26%26eyJlbGlnaWJsZUVhc3lQYXlNYXJrZXRpbmciOmZhbHNlLCJleHRlbmRJbmZvIjoie1wiZGlzcGxheUFudG9tTG9nb1wiOlwidHJ1ZVwifSIsIm5lZWRBY2NvdW50Q29uZmlybVBhZ2UiOmZhbHNlLCJwYXltZW50U2Vzc2lvbkNvbmZpZyI6eyJwYXltZW50TWV0aG9kQ2F0ZWdvcnlUeXBlIjoiQUxMIiwicHJvZHVjdFNjZW5lIjoiQ0hFQ0tPVVRfUEFZTUVOVCIsInByb2R1Y3RTY2VuZVZlcnNpb24iOiIxLjAifSwic2tpcFJlbmRlclBheW1lbnRNZXRob2QiOmZhbHNlfQ%3D%3D"
},
"result": {
"resultCode": "PAYMENT_IN_PROCESS",
"resultMessage": "payment in process",
"resultStatus": "U"
}
}The table below shows the possible values of result.resultStatus in the response. Please handle the result according to the guidance provided:
result.resultStatus | Message | Further action |
S | Indicates that enrolment request is initiated successfully | Redirect to normalUrl to proceed the next step. |
U | Indicates that enrolment request creation failed for unknown reasons. | Please call the API again to resolve the issue. Please contact Antom technical support if the problem persists. |
F | Indicates that the enrolment request failed to be initiated | Refer to the result.resultCode and result.resultMessage for the error details. |
Note: If you did not receive a response message, it might be due to a network timeout. Please change the paymentRequestId and call the API again to resolve the issue.
Step 2: Redirect to the normalUrl Client-side
After the merchant server obtains normalUrl and passes it to front end, it will redirect from the merchant front end to the enrollment and first payment page.
Web
if (serverResponse.normalUrl != null) {
window.open(serverResponse.normalUrl, '_blank');
}
WAP
window.location.href = URL;
iOS
import SafariServices
// After receiving normalUrl from your backend
func redirectToSubscription(normalUrl: String) {
guard let url = URL(string: normalUrl) else { return }
// Option A: Open in SFSafariViewController (recommended, stays in-app)
let safariVC = SFSafariViewController(url: url)
present(safariVC, animated: true)
// Option B: Open in external browser
// UIApplication.shared.open(url)
}
Android
import android.content.Intent
import android.net.Uri
import androidx.browser.customtabs.CustomTabsIntent
// After receiving normalUrl from your backend
fun redirectToSubscription(normalUrl: String) {
// Option A: Open in Chrome Custom Tabs (recommended, stays in-app)
val customTabsIntent = CustomTabsIntent.Builder().build()
customTabsIntent.launchUrl(this, Uri.parse(normalUrl))
// Option B: Open in external browser
// val intent = Intent(Intent.ACTION_VIEW, Uri.parse(normalUrl))
// startActivity(intent)
}
Step 3: Obtain the enrollment result Server-side
You can obtain the enrollment result using one of the following methods:
- Receive asynchronous notifications from Antom
- Inquire about the enrollment result
Receive asynchronous notifications
Follow the steps below to receive and process asynchronous notifications from Antom:
- Configure the webhook URL to receive asynchronous notifications
Once the buyer confirms their subscription, Antom will send a subscription creation notification to the webhook URL you set. You will need to store the subscriptionId for subsequent subscription deductions initiation. You can choose one of the following two methods to configure the webhook URL for receiving notifications:
- If each of your orders has a unique notification URL, it is recommended to set the webhook URL in each request. You can pass the asynchronous notification receiving URL for the specific order through subscriptionInfo.subscriptionNotifyUrl in the pay (One-time Payments) API.
- If all your orders share a unified notification URL, you can set the webhook URL on Antom Dashboard through Developer > Notification URL. For detailed steps, refer to Notification URL.
Notes:
- If you specify this URL in both this API and Antom Dashboard, the URL configured in the API takes precedence.
- Once the initial enrollment is completed, subscription deductions cannot be initiated on the same day; they can only be initiated the following day.
The following code shows a sample of the asynchronous notification request:
{
"periodRule": {
"periodCount": 1,
"periodType": "WEEK"
},
"subscriptionEndTime": "2028-08-08T23:55:16-07:00",
"subscriptionId": "20260115110000000000000700000014071",
"subscriptionNotificationType": "CREATE",
"subscriptionRequestId": "SUBSCRIPTION_20260115194530778_AUTO",
"subscriptionStartTime": "2026-01-15T04:00:00-08:00",
"subscriptionStatus": "ACTIVE"
}- Verify the asynchronous notification
When you receive an asynchronous notification from Antom, you are required to return the response in the Sample codeformat, but you do not need to countersign the response.
You need to verify the signature of the enrollment notification sent by Antom:
import com.alipay.global.api.model.Result;
import com.alipay.global.api.model.ResultStatusType;
import com.alipay.global.api.response.AlipayResponse;
import com.alipay.global.api.tools.WebhookTool;
import javax.servlet.http.HttpServletRequest;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class PaymentNotifyHandleBySDK {
/**
* alipay public key, used to verify signature
*/
private static final String SERVER_PUBLIC_KEY = "";
/**
* payment result notify processor
* using <a href="https://spring.io">Spring Framework</a>
*
* @param request HttpServletRequest
* @param notifyBody notify body
* @return
*/
@PostMapping("/payNotify")
public Object payNotifyHandler(HttpServletRequest request, @RequestBody String notifyBody) {
// retrieve the required parameters from http request.
String requestUri = request.getRequestURI();
String requestMethod = request.getMethod();
// retrieve the required parameters from request header.
String requestTime = request.getHeader("request-time");
String clientId = request.getHeader("client-id");
String signature = request.getHeader("signature");
Result result;
AlipayResponse response = new AlipayResponse();
try {
// verify the signature of notification
boolean verifyResult = WebhookTool.checkSignature(
requestUri,
requestMethod,
clientId,
requestTime,
signature,
notifyBody,
SERVER_PUBLIC_KEY
);
if (!verifyResult) {
throw new RuntimeException("Invalid notify signature");
}
// deserialize the notification body
// update the order status with notify result
// respond the server that the notification is received
result = new Result("SUCCESS", "success", ResultStatusType.S);
} catch (Exception e) {
String errorMsg = e.getMessage();
// handle error condition
result = new Result("ERROR", errorMsg, ResultStatusType.F);
}
response.setResult(result);
return ResponseEntity.ok().body(response);
}
}Whether the enrollment is successful or not, each notification request must be responded to in the format specified below. Otherwise, Antom will resend the asynchronous notification.
{
"result": {
"resultCode": "SUCCESS",
"resultStatus": "S",
"resultMessage": "success"
}
}Inquire about the enrollment result
You can also inquire about the enrollment result by calling the inquireSubscription API using subscriptionId obtained from the asynchronous notification.
public static void inquireSubscription() {
AlipaySubscriptionInquiryRequest request = new AlipaySubscriptionInquiryRequest();
// set your subscriptionId
request.setSubscriptionId(subscriptionId);
// Inquire subscription
AlipaySubscriptionInquiryResponse response = null;
try {
response = CLIENT.execute(request);
} catch (AlipayApiException e) {
String errorMsg = e.getMessage();
// handle error condition
}
}The following sample code shows a request message:
{
"subscriptionId": "20260119110000000000000910000006774"
}The following sample code shows a response message:
{
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
},
"subscription": {
"currentPeriodEndTime": "2026-07-27T22:42:01+08:00",
"currentPeriodStartTime": "2026-07-20T22:42:02+08:00",
"currentPhaseNo": 1,
"description": "",
"paymentMethod": {
"paymentMethodType": "PIX_AUTOMATICO",
"paymentMethodMetaData": {
"fixedAmount": {
"currency": "BRL",
"value": "200"
},
"allowRetry": true,
"retryMode": "MANUAL"
}
},
"periodCount": 1,
"periodType": "WEEK",
"subscriptionId": "202607181000000006700000437470",
"subscriptionStartTime": "2026-07-20T22:42:02+08:00"
}
}The table below shows the possible values of result.resultStatus in the response. Please handle the result according to the guidance provided:
result.resultStatus | Message | Further action |
S | Indicates that this API is called successfully and the normalUrl is returned. | You can obtain the enrollment result from the subscriptionStatus parameter in the inquireSubscription API response. |
F | Indicates that this API call is failed. The normalUrl is not returned. | For more information about the failure reason, refer to result.resultCode. |
U | Indicates that the API call status is unknown. Retry the calling process. | Use the same subscriptionId to try again. |
Step 4: Obtain the first payment result Server-side
You can obtain the first payment result using one of the following methods:
- Receive asynchronous notifications from Antom
- Inquire about the enrollment result
Receive asynchronous notifications
- Configure the webhook URL to receive asynchronous notifications
Whether the payment is completed or fails, Antom will send an asynchronous notification to the to the webhook URL you set. You need to store the subscriptionId for subsequent subscription deductions initiation. You can choose one of the following two methods to configure the webhook URL for receiving notifications:
- If each of your orders has a unique notification URL, it is recommended to set the webhook URL in each request. You can pass the asynchronous notification receiving URL for the specific order through paymentNotifyUrl in the pay (One-time Payments) API.
- If all your orders share a unified notification URL, you can set the webhook URL on Antom Dashboard through Developer > Notification URL. For detailed steps, refer to Notification URL.
Notes:
- If you specify this URL in both this API and Antom Dashboard, the URL configured in the API takes precedence.
- Once the initial enrollment is completed, subscription deductions cannot be initiated on the same day; they can only be initiated the following day.
The following code shows a sample of the asynchronous notification request:
{
"notifyType": "PAYMENT_RESULT",
"paymentAmount": {
"currency": "BRL",
"value": "103"
},
"paymentCreateTime": "2026-01-15T03:55:02-08:00",
"paymentId": "20260115114010800100188410251281493",
"paymentTime": "2026-01-15T03:55:54-08:00",
"phaseNo": "1",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"subscriptionId": "20260115110000000000000700000014073",
"subscriptionRequestId": "PAYMENT_20260115195444191_AUTO"
}- Verify the asynchronous notification
When you receive an asynchronous notification from Antom, you are required to return the response in the Sample codeformat, but you do not need to countersign the response.
You need to verify the signature of the enrollment notification sent by Antom:
import com.alipay.global.api.model.Result;
import com.alipay.global.api.model.ResultStatusType;
import com.alipay.global.api.response.AlipayResponse;
import com.alipay.global.api.tools.WebhookTool;
import javax.servlet.http.HttpServletRequest;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class PaymentNotifyHandleBySDK {
/**
* alipay public key, used to verify signature
*/
private static final String SERVER_PUBLIC_KEY = "";
/**
* payment result notify processor
* using <a href="https://spring.io">Spring Framework</a>
*
* @param request HttpServletRequest
* @param notifyBody notify body
* @return
*/
@PostMapping("/payNotify")
public Object payNotifyHandler(HttpServletRequest request, @RequestBody String notifyBody) {
// retrieve the required parameters from http request.
String requestUri = request.getRequestURI();
String requestMethod = request.getMethod();
// retrieve the required parameters from request header.
String requestTime = request.getHeader("request-time");
String clientId = request.getHeader("client-id");
String signature = request.getHeader("signature");
Result result;
AlipayResponse response = new AlipayResponse();
try {
// verify the signature of notification
boolean verifyResult = WebhookTool.checkSignature(
requestUri,
requestMethod,
clientId,
requestTime,
signature,
notifyBody,
SERVER_PUBLIC_KEY
);
if (!verifyResult) {
throw new RuntimeException("Invalid notify signature");
}
// deserialize the notification body
// update the order status with notify result
// respond the server that the notification is received
result = new Result("SUCCESS", "success", ResultStatusType.S);
} catch (Exception e) {
String errorMsg = e.getMessage();
// handle error condition
result = new Result("ERROR", errorMsg, ResultStatusType.F);
}
response.setResult(result);
return ResponseEntity.ok().body(response);
}
}Whether the payment is successful or not, each notification request must be responded to in the format specified below. Otherwise, Antom will resend the asynchronous notification.
{
"result": {
"resultCode": "SUCCESS",
"resultStatus": "S",
"resultMessage": "success"
}
}Inquire about the payment result
You can also inquire about the payment result by calling the inquiryPayment API using paymentId or paymentRequestIdfrom the payment request.
public static void inquiryPayment() {
AlipayPaymentInquiryRequest request = new AlipayPaymentInquiryRequest();
// set your paymentId or paymentRequestId
request.setPaymentId(paymentId);
// request.setPaymentRequestId(paymentRequestId);
// Inquiry subscription
AlipayPaymentInquiryResponse response = null;
try {
response = CLIENT.execute(request);
} catch (AlipayApiException e) {
String errorMsg = e.getMessage();
// handle error condition
}
}The following sample code shows a request message:
using paymentId
{
"paymentId": "20260420114010800100188980200530438"
}
using paymentRequestId
{
"paymentRequestId": "PAYMENT_ede7902a-1dd9-4cae-a151-a758d7442c03"
}
The following sample code shows a response message:
{
"paymentAmount": {
"currency": "BRL",
"value": "101"
},
"paymentId": "20260303114010800100188250200530889",
"paymentMethodType": "PIX_AUTOMATICO",
"paymentRequestId": "PAYMENT_b0c1265a-033a-4a95-82b8-d7b4875e9c4c",
"paymentResultCode": "SUCCESS",
"paymentResultMessage": "success.",
"paymentStatus": "SUCCESS",
"paymentTime": "2026-03-03T08:17:45-08:00",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
}
}Please handle the result based on the value of the paymentStatus parameter in the response. For specific return values, refer to the API documentation.
After enrollment
After completing the enrollment and first payment, you can perform the following actions:
Initiate subscription deductions Server-side
Once the buyer completes their enrollment and first payment, you need to store the subscriptionId for subsequent subscription deductions initiation. For details, please refer to Initiate subscription deductions.
Subscription cancellation Server-side
The subscription cancellation feature allows buyers and you to cancel the current subscription at any time when the associated service is no longer needed. For more details, please refer to Cancel subscription.
Cancel Server-side
For orders that have been successfully paid, if the buyer requests to cancel the order or refund on the same day, you can use Antom's cancel transaction capability to cancel or unfreeze the order status. Additionally, for orders that have not yet completed payment, you can also directly cancel them. For detailed integration solutions, please refer to Cancel.
Refund Server-side
For orders that have been successfully paid, if you need to initiate a refund to the buyer, Antom offers the following two methods:
- Your operation staff can manually process the refund directly on the Antom Dashboard.
- You can initiate a refund by integrating with the refund API.
Antom's refund capabilities include:
- Support for full refunds.
- Support for partial multiple refunds, with the total amount of multiple refunds not exceeding the captured amount.