create_refund
Initiate a full or partial refund for a successful payment. Multiple refunds are allowed as long as the total does not exceed the original amount.
Instructions
The tool is used 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. If the refund request is out of the refund window determined in the contract, the refund request will be declined.
Args:
refund_request_id: The unique ID assigned by the merchant to identify a refund request.Maximum length: 64 characters
payment_id: The unique ID assigned by Antom for the original payment to be refunded.Maximum length: 64 characters
refund_amount_currency: The currency used for the corresponding payment of the refund. The value is a 3-letter currency code that follows the ISO 4217 standard.
refund_amount_value: The amount to charge as a positive integer in the smallest currency unit. (That is, 100 cents to charge $1.00, or 100 to charge JPY 100, a 0-decimal currency).Value range: 1 - unlimited
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| refund_request_id | Yes | ||
| payment_id | Yes | ||
| refund_amount_currency | Yes | ||
| refund_amount_value | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |