Skip to content

Refund Status API

Method: GET

Path: https://amazonpay.amazon.in/v1/payments/refund

Description: This API determines the status of a refund transaction by passing the appropriate refund ID and type.

Request Parameters

Parameter Name Data Type Description Mandatory Constraints
merchantId String Merchant ID provided by Amazon Yes
txnIdType String Transaction Type Yes Possible values:
  • AmazonTxnId
  • MerchantTxnId
    		•
    txnId String Pass either amazonRefundId or refundId based on the txnIdType Yes

    Request Sample

    https://{{endpoint}}/v1/payments/refund?merchantId=A2UOYLUXLC6NR3&txnIdType=AmazonTxnId&txnId=P04-0572904-1255078-R073442

    Response Parameters

    Parameter Name Data Type Description
    refundId String Refund ID shared for the refund request
    amazonRefundId String Amazon-generated identifier for refund transaction
    amount String The refund amount
    refundedFee String The fee refunded
    currencyCode String Will always be INR
    status String Transaction status (Approved, Pending, Declined)
    createTime String Creation timestamp
    updateTime String Last update timestamp

    Sample Response

    {
  "refundId": "ve7vdsd99sde7f",
  "amazonRefundId": "P04-0249917-0735882-R8908908",
  "amount": 0.01,
  "refundedFee": 0.01,
  "currencyCode": "INR",
  "status": "Approved/Pending/Declined",
  "createTime": "2020-01-18T11:11:41.511Z",
  "updateTime": "2020-01-18T11:12:52.661Z"
}

    Common Errors

    Error Resolution
    Invalid refundId Please pass a valid refundId based on the constraints specified and the response from the Refund API call.
    Invalid merchantId Please pass a valid merchantId provided by Amazon.

    For more errors, refer to this.