Refund Scenarios

Refund Entire Cart

1. The customer requests a refund.
2. The merchant sends the status request to OmniCart.

   OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.

3. OmniCart returns the response to the status request to the merchant.

status (optional)

request

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'

response

{
  "data": {
    "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
    "currency": "XAU",
    "totalAmounts": {
      "initiated": 250,
      "captured": 250,
      "refunded": 0,
      "current": 250
    },
    "items": [
      {
        "pegasus": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 250,
            "captured": 250,
            "refunded": 0,
            "current": 250
          }
        }
      }
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

4. The merchant sends the refund request with the updated settings to OmniCart.
5. The customer's funds are refunded.
6. OmniCart returns the response to the refund request to the merchant.
7. The merchant displays the success message to the customer.

refund

request

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402"
}

response

{
  "data": {
    "itemIds": [
      "pegasus"
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

Refund by Tags or Items

1. The customer requests a refund.
2. The merchant sends the status request to OmniCart.

   OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.

3. OmniCart returns the response to the status request to the merchant.

status (optional)

request

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'

response

{
  "data": {
    "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
    "currency": "XAU",
    "totalAmounts": {
      "initiated": 1350,
      "captured": 1100,
      "refunded": 0,
      "current": 1100
    },
    "items": [
      {
        "naga": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 1100,
            "captured": 1100,
            "refunded": 0,
            "current": 1100
          },
          "tag": "tower"
        }
      },
      {
        "pegasus": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 250,
            "captured": 0,
            "refunded": 0,
            "current": 0
          },
          "tag": "rampart"
      }
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

4. The merchant sends the refund request with the updated settings to OmniCart.
5. The customer's funds are refunded.
6. OmniCart returns the response to the refund request to the merchant.
7. The merchant displays the success message to the customer.

refund

request

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "filterBox": {
    "tags": [
      "rampart"
    ]
  }
}

response

{
  "data": {
    "itemIds": [
      "pegasus"
  },
  "code": "string",
  "message": "string",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

8. The merchant sends the status request to OmniCart.

   OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.

9. OmniCart returns the response to the status request to the merchant.

status (optional)

request

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'

response

{
  "data": {
    "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
    "currency": "XAU",
    "totalAmounts": {
      "initiated": 1350,
      "captured": 1100,
      "refunded": 250,
      "current": 1100
    },
    "items": [
      {
        "naga": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 1100,
            "captured": 1100,
            "refunded": 0,
            "current": 1100
          },
          "tag": "tower"
        }
      },
      {
        "pegasus": {
          "paymentStatus": "refuded",
          "itemAmounts": {
            "initiated": 250,
            "captured": 250,
            "refunded": 250,
            "current": 0
          },
          "tag": "rampart"
      }
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

Partial Refund

1. The customer requests a refund.
2. The merchant sends the status request to OmniCart.

   OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.

3. OmniCart returns the response to the status request to the merchant.

status (optional)

request

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'

response

{
  "data": {
    "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
    "currency": "XAU",
    "totalAmounts": {
      "initiated": 250,
      "captured": 250,
      "refunded": 0,
      "current": 250
    },
    "items": [
      {
        "pegasus": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 250,
            "captured": 250,
            "refunded": 0,
            "current": 250
          }
        }
      }
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

4. The merchant sends the modify request with the updated settings to OmniCart.
5. The customer's funds are refunded.
6. OmniCart returns the response to the modify request to the merchant.
7. The merchant displays the success message to the customer.

modify

request

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "modifyBox": {
    "items": [
      {
        "pegasus": {
          "modifyAmount": {
            "amount": 150,
            "amountMode": "declared"
          }
        }
      }
    ]
  }
}

response

{
  "data": {
    "modifiedAmounts": [
      "pegasus"
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

8. The merchant sends the status request to OmniCart.

   OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.

9. OmniCart returns the response to the status request to the merchant.

status (optional)

request

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'

response

{
  "data": {
    "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
    "currency": "XAU",

    "totalAmounts": {
      "initiated": 250,
      "captured": 250,
      "refunded": 100,
      "current": 150
    },
    "items": [
      {
        "pegasus": {
          "paymentStatus": "completed",
          "itemAmounts": {
            "initiated": 250,
            "captured": 250,
            "refunded": 100,
            "current": 150
          }
        }
      }
    ]
  },
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}