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.

ONDC Integration Flow

This diagram illustrates the complete ONDC Buyer App integration flow, including relay communication, encryption, and request–response handling.

ONDC Integration Flow Diagram

The diagram below represents the end-to-end data flow between your application, the relay server, and ONDC BAP APIs.

ONDC Integration Flow Diagram

Flow Process Explanation

  1. Client Request: Your application sends a request to the relay server with required parameters.
  2. Authentication: The relay server attaches the X-API-KEY header.
  3. API Forwarding: The relay server forwards the request to the appropriate ONDC BAP endpoint.
  4. Encrypted Response: ONDC returns an encrypted payload along with an initialization vector (IV).
  5. Response Relay: The encrypted response is passed back to your application.
  6. Decryption: Your system decrypts the response using the IV and encryption key.

Key Integration Components

  • Relay Server: Authenticates and forwards API requests.
  • API Authentication: All requests require the X-API-KEY header.
  • Data Encryption: AES-256-CBC is used for secure payload transmission.
  • Error Handling: Standardized error responses and status codes.
  • Response Processing:Decryption and structured JSON parsing.

Implementation Notes

  • Configure relay servers with correct base URLs for staging and production.
  • Never expose API keys or encryption keys in client-side applications.
  • Handle authentication, network, and decryption errors gracefully.
  • Enable request and response logging for observability and debugging.
  • Test the complete integration flow thoroughly in staging before production rollout.

Integration Support

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