APIs

The Aarambh Pay Integration Module consists of two essential APIs designed to facilitate seamless RSF 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 Authorization header: {"message":{"ack":{"status":"NACK"},"error":{"error":"Authorization headers are missing"}}

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

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

Last updated