Use this API to initiate a refund against a successful payment. The refund can be full or partial. A transaction can have multiple refunds as long as the total refund amount is less than or equal to the original transaction amount.
- Provider
- Alipay Global Merchant Portal
- Input summary
- {"name":"metadata","type":"string","required":false,"description":"This parameter is used for submitting metadata. Maximum length: 2048 characters"}, {"name":"paymentId","type":"string","required":true,"description":"The unique ID assigned by Antom for the original payment to be refunded. Maximum length: 64 characters"}, {"name":"refundAmount","type":"string","required":true,"description":"The refund amount that is initiated by the merchant."}, {"name":"refundReason","type":"string","required":false,"description":"The refund reason. Maximum length: 256 characters"}, {"name":"refundNotifyUrl","type":"string","required":false,"description":"The URL that is used to receive the refund result notification. Maximum length: 1024 characters"}, {"name":"refundRequestId","type":"string","required":true,"description":"The unique ID assigned by the merchant to identify a refund request. Maximum length: 64 characters"}, {"name":"referenceRefundId","type":"string","required":false,"description":"The unique ID to identify a refund, which is assigned by the merchant that directly provides services or goods to the customer. Maximum length: 64 characters"}, {"name":"actualRefundAmount","type":"string","required":false,"description":"The refund amount in processing currency, that is, the amount the user actually paid."}
- Output summary
- Not available
- Billing
- 1
- Freshness
- Not available
- Verification
- Not available
