Sign in

v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Initiate Refund

To initiate a refund of an existing paid transaction back to source

post/v3/refund

Request body

payinstring required

ID of the payin for which refund is being created

amountinteger

Amount to be refunded. If omitted, the request will be registered for a refund of the full transaction amount. For decimal handling for various currencies, refer to <a href="/API-Reference/appendix/Decimal-Currencies" target="_blank"> the guide here</a>

currencystring

Three-letter ISO currency code in lowercase

reasonstring

Reason for the refund

payment_attemptstring

ID of the payment Attempt for which the refund is being created

metadatastring json

Set of key-value pairs that can be attached to the object (JSON string format)

Example request

{
  "metadata": "{\"key1\": \"value1\", \"key2\": \"value2\"}"
}

Response

200

statusstring

Indicates whether the refund creation request was successful.

messagestring

Describes the outcome of the refund operation.