Skip to main content
POST
/
v1
/
order
/
session
Create Order Session
curl --request POST \
  --url https://ebt-sandbox.bennyapi.com/v1/order/session \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "onSuccessRedirectUrl": "<string>",
  "onExitRedirectUrl": "<string>",
  "items": [
    {
      "description": "<string>",
      "id": "<string>",
      "price": 123,
      "quantity": 123,
      "snapEligible": true,
      "taxRate": 123,
      "unit": "COUNT",
      "name": "<string>",
      "tenders": [
        {
          "tender": "EBT_CASH",
          "amount": 123
        }
      ],
      "paddedPrice": 123,
      "photoUrl": "<string>"
    }
  ],
  "externalCustomerId": "<string>",
  "externalOrderId": "<string>"
}
'
{
  "sessionUrl": "<string>"
}

Authorizations

api-key
string
header
required

API key authentication for public endpoints

Headers

Api-Key
string

API key for authentication.

Body

application/json
onSuccessRedirectUrl
string
required

The URL to redirect the customer to on checkout success

onExitRedirectUrl
string
required

The URL to redirect the customer to on checkout exit

items
object[]
required

List of items in the shopping cart

externalCustomerId
string

An optional ID unique to your organization representing the customer

externalOrderId
string

An optional ID unique to your organization representing the order

Response

Order session created successfully.

Response containing the created order details.

sessionUrl
string
required

The unique checkout session URL for the customer to complete their EBT order.