ONDC Buyer App Utility APIsVersion 1.0.0

These APIs are intended for ONDC Buyer Applications to discover gift card catalogues, retrieve product details, generate quotes, place orders, and track order status throughout the purchase lifecycle.

Integration Prerequisites

Before integrating the ONDC Buyer App APIs, ensure the following prerequisites are configured to enable secure communication and reliable order processing.

API Base URLs

Use the appropriate base URL depending on your deployment environment.

Productionhttps://ondc-prod.vistar.solutions/bap

UAT / Staginghttps://staging.meribachat.in/bap

Required Headers

All ONDC Buyer API requests must include the following header for authentication.

X-API-KEYUnique API key used to authenticate all ONDC Buyer API requests.requiredstring

Requests without valid authentication headers will be rejected.

Response Encryption

ONDC Buyer API responses are encrypted. You must decrypt the response payload before processing the data.

AlgorithmAES-256-CBC
Key Format32-byte hexadecimal string
IV16-byte hexadecimal value (returned in response)

Relay Setup

ONDC APIs operate through a relay mechanism to route requests and responses between Buyer Apps, Seller Apps, and the ONDC network.

Refer to the relay implementation guide for setup instructions.

Sample API Requests

Example authenticated cURL requests for ONDC Buyer APIs.

POST Request

curl -X POST \
  {{base_url}}/{{endpoint}} \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{
    "{{field1}}": "value1",
    "{{field2}}": "value2",
    "{{field3}}": {
      "{{subField}}": "value"
    }
  }'

GET Request

curl -X GET \
  {{base_url}}/{{endpoint}}?{{queryParam}}={{value}} \
  -H "X-API-KEY: YOUR_API_KEY"

Integration Support

For assistance during integration, contact at help@meribachat.in.

Loading dashboard…