Basic Scenarios

One-Step Payment

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 payment is processed.
8. The merchant displays the success message to the customer.

init

request

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "currency": "XAU",
  "items": [
    {
      "pegasus": {
        "amount": 250,
        "capture": false
      }
    }
  ]
}

response

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

9. The merchant sends the status request to OmniCart.

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

10. 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"
}

Two-Step Payment

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.

init

request

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "currency": "XAU",
  "items": [
    {
      "pegasus": {
        "amount": 250,
        "capture": true
      }
    }
  ]
}

tip

Note that it is not necessary to pass "capture": true for two-step payments as this is the default behavior.

response

{
  "cartId": "6f891edb-1e1f-48bb-b042-2cb790a0f402",
  "code": "000000",
  "message": "Success",
  "timestamp": "2025-04-23T18:25:43.511Z"
}

9. The merchant sends the capture request to OmniCart.
10. The payment is processed.
11. OmniCart returns the response to the capture request to the merchant.

capture

request

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

response

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

12. The merchant sends the status request to OmniCart.

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

13. 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"
}