Cancellation Scenarios
Cancel Entire Cart (manual)
-
The customer requests payment cancellation.
This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.
-
The merchant sends the
status
request to OmniCart.OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.
-
OmniCart returns the response to the
status
request to the merchant.
status
(optional)
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"data": {
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"totalAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 250
},
"items": [
{
"pegasus": {
"paymentStatus": "authorized",
"itemAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 250
}
}
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
Cancel Entire Cart (auto)
- The customer begins the payment process.
-
The merchant sends the
init
request to OmniCart. -
OmniCart returns the response to the
init
request to the merchant. -
OmniCart delivers the payment form using the method set in the
deliveryOption
property of theinit
request. - The customer authenticates against their verification service.
- The verification service informs OmniCart that the payment is authorized.
- The customer's dunds are put on hold on their account.
- The merchant displays the success message to the customer.
- The customer's funds are released from hold on their account.
init
- request
- response
{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"items": [
{
"pegasus": {
"amount": 250,
"capture": true,
"captureSettings": {
"autoAction": "cancel",
"value": 172800
}
}
}
]
}
{
"data": {
"itemIds": [
"pegasus"
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
status
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"data": {
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"totalAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 0
},
"items": [
{
"pegasus": {
"paymentStatus": "canceled",
"itemAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 0
}
}
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
Cancel by Tags or Items
-
The customer requests payment cancellation.
This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.
-
The merchant sends the
status
request to OmniCart.OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.
-
OmniCart returns the response to the
status
request to the merchant.
status
(optional)
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"data": {
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"totalAmounts": {
"initiated": 1350,
"captured": 1100,
"refunded": 0,
"current": 1350
},
"items": [
{
"naga": {
"paymentStatus": "authorized",
"itemAmounts": {
"initiated": 1100,
"captured": 1100,
"refunded": 0,
"current": 1100
},
"tag": "tower"
}
},
{
"pegasus": {
"paymentStatus": "authorized",
"itemAmounts": {
"initiated": 250,
"captured": 0,
"refunded": 0,
"current": 250
},
"tag": "rampart"
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
status
(optional)
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"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": "canceled",
"itemAmounts": {
"initiated": 250,
"captured": 0,
"refunded": 0,
"current": 0
},
"tag": "rampart"
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
Partial Cancellation
-
The customer requests payment cancellation.
This step is optional as the Merchant may have reasons to cancel the payment without the customer's request.
-
The merchant sends the
status
request to OmniCart.OmniCart supports callbacks for payment and timer status changes. Contact our technical support for more information.
-
OmniCart returns the response to the
status
request to the merchant.
status
(optional)
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"data": {
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"totalAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 250
},
"items": [
{
"pegasus": {
"paymentStatus": "authorized",
"itemAmounts": {
"initiated": 250,
"captured": 250,
"refunded": 0,
"current": 250
}
}
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
modify
- request
- response
{
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"modifyBox": {
"items": [
{
"pegasus": {
"modifyAmount": {
"amount": 150,
"amountMode": "declared"
}
}
}
]
}
}
{
"data": {
"modifiedAmounts": [
"pegasus"
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}
status
(optional)
- request
- response
curl -L 'https://api.omnicart.scripsi.io/status/:6f891edb-1e1f-48bb-b042-2cb790a0f402' \
-H 'Accept: application/json' \
-H 'Api-Access-Token: <Api-Access-Token>'
{
"data": {
"cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
"currency": "XAU",
"totalAmounts": {
"initiated": 250,
"captured": 150,
"refunded": 0,
"current": 150
},
"items": [
{
"pegasus": {
"paymentStatus": "completed",
"itemAmounts": {
"initiated": 250,
"captured": 150,
"refunded": 0,
"current": 150
}
}
}
]
},
"code": "000000",
"message": "Success",
"timestamp": "2025-04-23T18:25:43.511Z"
}