Skip to main content

Cancellation Scenarios

Cancel Entire Cart (manual)

  1. The customer requests payment cancellation.

    This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.

  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)

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
  1. The merchant sends the cancel request to Omnicart.
  2. The customer's funds are released from hold on their account.
  3. OmniCart returns the response to the cancel request to the merchant.
  4. The merchant displays the success message to the customer.

cancel

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

Cancel Entire Cart (auto)

  1. The customer begins the payment process.
  2. The merchant sends the init request to OmniCart.
  3. OmniCart returns the response to the init request to the merchant.
  4. OmniCart delivers the payment form using the method set in the deliveryOption property of the init request.
  5. The customer authenticates against their verification service.
  6. The verification service informs OmniCart that the payment is authorized.
  7. The customer's dunds are put on hold on their account.
  8. The merchant displays the success message to the customer.
  9. The customer's funds are released from hold on their account.

init

{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"items": [
{
"pegasus": {
"amount": 250,
"capture": true,
"captureSettings": {
"autoAction": "cancel",
"value": 172800
}
}
}
]
}
  1. The merchant sends the status request to OmniCart.

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

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

status

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

Cancel by Tags or Items

  1. The customer requests payment cancellation.

    This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.

  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)

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
  1. The merchant sends the cancel request to Omnicart.
  2. The customer's funds are released from hold on their account.
  3. OmniCart returns the response to the cancel request to the merchant.
  4. The merchant displays the success message to the customer.

cancel

{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"filterBox": {
"tags": [
"rampart"
]
}
}
  1. The merchant sends the capture request to OmniCart.
  2. The payment is processed.
  3. OmniCart returns the response to the capture request to the merchant.

capture

{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402"
}
  1. The merchant sends the status request to OmniCart.

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

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

status (optional)

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

Partial Cancellation

  1. The customer requests payment cancellation.

    This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.

  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)

curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
  1. The merchant sends the modify request with the updated settings to OmniCart.
  2. The customer's funds are released from hold on their account.
  3. OmniCart returns the response to the modify request to the merchant.
  4. The merchant displays the success message to the customer.

modify

{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"modifyBox": {
"items": [
{
"pegasus": {
"modifyAmount": {
"amount": 150,
"amountMode": "declared"
}
}
}
]
}
}
  1. The merchant sends the capture request to OmniCart.
  2. The payment is processed.
  3. OmniCart returns the response to the capture request to the merchant.

capture

{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402"
}
  1. The merchant sends the status request to OmniCart.

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

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

status (optional)

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