APIs

The Aarambh Desk Integration Module consists of two essential APIs designed to facilitate seamless IGM 2.0 compliance and streamline reconciliation and settlement processes for Network Participants (NPs) on the ONDC network.

Base URI

https://integrations.aarambh.cloud/api/v1/integrations

API Endpoints

Endpoint	Method	Description
/create_record	POST	creates necessary settlement files for the transactions or orders recorded
/update_record	POST	Updates the changes with respect to specific orders or transactions.

Request Format

• All API requests must be POST requests.

• Requests must include mandatory authentication headers (Authorization ,subscriberid).

• Payload structure should adhere to Aarambh’s API schema for seamless integration.

Validation Failure Errors

1. Missing Access key: {"message":{"ack":{"status":"NACK"},"error":{"error":"Project not initialize:Access key is missing"}}

2. Missing Secret key: {"message":{"ack":{"status":"NACK"},"error":{"error":"Project not initialize:Secret key is missing"}}

3. Missing Subscriber ID: {"message":{"ack":{"status":"NACK"},"error":{"error":"Project not initialize:Subscriber ID is missing"}}

4. Other errors : {"message":{"ack":{"status":"NACK"},"error":{"error":"Project not initialized correctly or requested service is not enabled"}}