1 of 8

Architecture

Platform architecture

Architecture Overview

The iFIX platform architecture and the interacting systems are divided into 3 parts:

DIGIT Exchange

DIGIT Exchange functions as a connector bridging services deployed across diverse domains. Its primary role involves signing and verifying exchange messages and generating events for ingestion into Elasticsearch for dashboard visualisation.

Program Service

Program service handles all the financial transactions like sanction, allocation and disbursement.

Users can establish programs within which these transactions take place. It receives messages from the adapter service, validates them and forwards them to digit-exchange for sending it to the IFMS system. In case of any validation failure, it responds with an error status and message. Additionally, the service maintains records of sanctioned, allocated, and available amounts for disbursement.

Adapters

Two adapters will be deployed. One on the program side and the other on the IFMS side, both of which connect to the program service. As the program service is generic, there must be some data transformation for the connection between the program and the IFMS side, which is handled by the adapters.

Technology

Technology used for the platform

Java 8 (https://www.oracle.com/java/technologies/java8.html)
Apache Kafka (https://kafka.apache.org/)
Postgres (https://www.postgresql.org/)
Elastic-search (https://www.elastic.co/)

High-Level Design

Block Diagram

Sequence Diagram

Information Model

Request Message

This object captures the fiscal information of program service to exchange between domains.

Field

Type

Description

RequestHeader

Header to exchange information between different domains

Field

Type

Description

Captures the codes and type and status of the fiscal message

Field

Type

Description

Program

The model extends exchangeCode and captures specific attributes used for sanction

Field

Type

Description

Sanction

The model extends exchangeCode and captures specific attributes used for sanction

Field

Type

Description

Allocation

The model extends exchangeCode and captures specific attributes used for allocation

Field

Type

Description

Disbursement

The model extends exchangeCode and captures specific attributes used for disbursement

APIs

iFIX Master Data APIs

iFIX Department Entity Service APIs

Low Level Design

DIGIT Exchange

Overview

The DIGIT Exchange Service is a robust data interchange platform designed to facilitate the seamless and secure exchange of digital information between two endpoints. Built with a fixed schema for headers and dynamic messaging capabilities, this service ensures reliable communication while prioritizing data integrity and confidentiality.

Dependencies

DIGIT-exchange can implement any service if that has the same request structure as the program.

Program Service

API Specifications

Base Path: /digit-exchange/

API Contract Link

API spec YAML is here. Click below to view it in Swagger Editor.

APIs

High-Level Design

Exchange Flow

Data Model

DB Schema Diagram

Web Sequence Diagrams

Sequence of exchange between two environments

Exchange Service example of an exchange

Postman Collections

TBD

Program Service

Overview

The Program Service is constructed using iFIX specifications and serves as an extensive platform aimed at simplifying program creation, sanction management, fund allocation, and disbursement execution. It equips organizations with essential tools to effectively oversee available funds and guarantee transparent and accountable distribution to designated beneficiaries.

Functional Overview

Funds Summary

IFMS adapter manages funds summary based on the head of accounts and SSU codes. It creates sanctions for each head of accounts and SSU details based on ULB tenant ID.
Three types of transactions can be received from the JIT VA API -
- Initial Allotment - A new sanction will be created only if AllotmentTxnType is Initial Allotment.
- Additional allotment - For this type of transaction it will update the amount of existing sanction.
- Allotment withdrawal - It deducts the transaction amount from the sanction for this type of transaction.

Payment Instructions

When a bill is approved this service creates payment using the expense service.
Some consumers keep listening to the payment create Kafka topic and generate payment instructions (PI) using payment and bill details and post the PI to the IFMS system using JIT API.
A new PI will be generated when enough funds are available for any head of accounts for that tenantId.
Before posting the PI there were multiple enrichments like bank account details, org and individual details, etc.
After creating the PI it deducts the available balance from the funds summary.
If a PI is created for any payment then the user can not generate a PI again till the PI fails.
It keeps a log of each status call of PI and saves it in the DB

Program Service takes care of Program, Sanction, Allocation and Disbursement using the standardized exchange interface.

iFIX API Specification

Implemented API Specifications

Base Path: /program-service/

API Contract Link

APIs

Data Model

DB Schema

Web Sequence Diagrams

Postman Collections

TBD

Program Service

Overview

Functional Overview

Funds Summary

IFMS adapter manages funds summary based on the head of accounts and SSU codes. It creates sanctions for each head of accounts and SSU details based on ULB tenant ID.
Three types of transactions can be received from the JIT VA API -
- Initial Allotment - A new sanction will be created only if AllotmentTxnType is Initial Allotment.
- Additional allotment - For this type of transaction it will update the amount of existing sanction.
- Allotment withdrawal - It deducts the transaction amount from the sanction for this type of transaction.

Payment Instructions

When a bill is approved this service creates payment using the expense service.
Some consumers keep listening to the payment create Kafka topic and generate payment instructions (PI) using payment and bill details and post the PI to the IFMS system using JIT API.
A new PI will be generated when enough funds are available for any head of accounts for that tenantId.
Before posting the PI there were multiple enrichments like bank account details, org and individual details, etc.
After creating the PI it deducts the available balance from the funds summary.
If a PI is created for any payment then the user can not generate a PI again till the PI fails.
It keeps a log of each status call of PI and saves it in the DB

Program Service takes care of Program, Sanction, Allocation and Disbursement using the standardized exchange interface.

iFIX API Specification

API spec Click below to view it in Swagger Editor.

Swagger Editor

Implemented API Specifications

Base Path: /program-service/

API Contract Link

API spec Click below to view it in Swagger Editor.

APIs

Data Model

DB Schema

Web Sequence Diagrams

Postman Collections

TBD

Architecture

Platform architecture

Architecture Overview

The iFIX platform architecture and the interacting systems are divided into 3 parts:

DIGIT Exchange

Program Service

Program service handles all the financial transactions like sanction, allocation and disbursement.

Adapters

Create programs

Enables exchange of program related messages

POST/program-service/v1/program/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionenum

create

message*ProgramDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Update created programs

Enables exchange of program related messages

POST/program-service/v1/program/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*ProgramDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Search programs by query

Enables search of program

POST/program-service/v1/program/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

parent_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

namestring

Example: "Mukta"

program_codestring

Example: "PG/2023-24/000091"

location_code*string

Example: "pg.citya"

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pg.citya"
      }
    }),
});
const data = await response.json();

Response

{}

Update program after create response

Enables exchange of program related messages

POST/program-service/v1/on-program/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-program/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Update program after update response

Enables exchange of program related messages

POST/program-service/v1/on-program/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-program/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Create sanctions in program service

Enables creation of sanctions if not created in the system.

POST/program-service/v1/on-sanction/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*SanctionDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

net_amountnumber

gross_amountnumber

available_amountnumber

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenSanctionDetails (all of)

Circular reference to SanctionDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-sanction/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001"
      }
    }),
});
const data = await response.json();

Response

{}

Update created sanciton details

Enables to udpate sanction details like status, remaining fields will be immutable

POST/program-service/v1/on-sanction/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*SanctionDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

net_amountnumber

gross_amountnumber

available_amountnumber

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenSanctionDetails (all of)

Circular reference to SanctionDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-sanction/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001"
      }
    }),
});
const data = await response.json();

Response

{}

Search Sanction details

Search sanciton by query and return the response

POST/program-service/v1/sanction/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/sanction/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Callback after allocation/_create

Update created allocation if exists or create new

POST/program-service/v1/on-allocation/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*AllocationDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

sanction_id*string (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

net_amount*number

gross_amount*number

allocation_typeenum

ALLOCATIONDEDUCTION

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenAllocationDetails (all of)

Circular reference to AllocationDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-allocation/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "sanction_id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "net_amount": 0,
        "gross_amount": 0
      }
    }),
});
const data = await response.json();

Response

{}

Request to update allocation

Updated status of create disburse request.

POST/program-service/v1/on-allocation/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*AllocationDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

sanction_id*string (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

net_amount*number

gross_amount*number

allocation_typeenum

ALLOCATIONDEDUCTION

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenAllocationDetails (all of)

Circular reference to AllocationDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-allocation/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "sanction_id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "net_amount": 0,
        "gross_amount": 0
      }
    }),
});
const data = await response.json();

Response

{}

Search allocation details

Search allocation by query and return the response

POST/program-service/v1/allocation/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

sanction_idstring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/allocation/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Initiate payment request

Create new disbursement request to initiate payment.

POST/program-service/v1/disburse/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/disburse/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

Search created disbursements

Return disbursements based on query

POST/program-service/v1/disburse/_search

Body

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

target_idstring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/disburse/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Updated status of create disburse request

POST/program-service/v1/on-disburse/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-disburse/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

Updated status of create disburse request

Enables exchange of disburse related messages

POST/program-service/v1/on-disburse/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-disburse/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

APIs

iFIX Master Data APIs

Create/Add new COA on iFix for a tenant

POST/chartOfAccount/v1/_create

Body

Details for the new COA + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

chartOfAccountChartOfAccount (object)

Captures the COA data as map

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

Response

Get the list COA.

Based on the criteria get the list of COA.

POST/chartOfAccount/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*COASearchCriteria (object)

The object contains all the search criteria of the fund

tenantId*string

Tenant Id

Idsarray of string

List of COA ids

itemsstring

coaCodesarray of string

itemsstring

Chart of account concatinated string

majorHeadstring

Search by major head

subMajorHeadstring

Search by sub major head

minorHeadstring

Search by minor head

subHeadstring

Search by sub head

groupHeadstring

Search by group head

objectHeadstring

Search by object head

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

Response

iFIX Department Entity Service APIs

Create/Add new Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_create

Body

Details for the new Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntityobject

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Update existing Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_update

Body

Details for the update Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntity*all of

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get Department Entity details.

Based on the criteria get the list of department entities.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentEntitySearchCriteria (object)

The object contains all the search criteria of Department Entity

Idsarray of string

Department Entity Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelinteger

Capture the level of department entity

getAncestryboolean

If set to true, it will return all the department entity hierarchy details starting from the root to the specified department entity id.

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create

Body

Details for the new DepartmentHierarchyLevel + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

departmentHierarchyLevel*DepartmentHierarchyLevel (object)

This object captures the information for level of the department hierarchy and it's alias

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get DepartmentHierarchyLevel.

Based on the criteria get the list of Department Hierarchy Levels.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentHierarchyLevelSearchCriteria (object)

The object contains all the search criteria of Department Hierarchy Level

Idsarray of string

Department Hierarchy Level Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

labelstring

Unique department hierarchy label like state, district, etc.

levelnumber

The level of the department hierarchy level

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Updated status of create disburse request

Enables exchange of disburse related messages

POST/program-service/v1/on-disburse/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-disburse/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

Request to update allocation

Updated status of create disburse request.

POST/program-service/v1/on-allocation/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*AllocationDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

sanction_id*string (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

net_amount*number

gross_amount*number

allocation_typeenum

ALLOCATIONDEDUCTION

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenAllocationDetails (all of)

Circular reference to AllocationDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-allocation/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "sanction_id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "net_amount": 0,
        "gross_amount": 0
      }
    }),
});
const data = await response.json();

Response

{}

Update created sanciton details

Enables to udpate sanction details like status, remaining fields will be immutable

POST/program-service/v1/on-sanction/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*SanctionDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

net_amountnumber

gross_amountnumber

available_amountnumber

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenSanctionDetails (all of)

Circular reference to SanctionDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-sanction/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001"
      }
    }),
});
const data = await response.json();

Response

{}

Updated status of create disburse request

POST/program-service/v1/on-disburse/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-disburse/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

Create programs

Enables exchange of program related messages

POST/program-service/v1/program/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionenum

create

message*ProgramDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Update program after create response

Enables exchange of program related messages

POST/program-service/v1/on-program/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-program/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Update created programs

Enables exchange of program related messages

POST/program-service/v1/program/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*ProgramDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Search allocation details

Search allocation by query and return the response

POST/program-service/v1/allocation/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

sanction_idstring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/allocation/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Search created disbursements

Return disbursements based on query

POST/program-service/v1/disburse/_search

Body

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

target_idstring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/disburse/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Search programs by query

Enables search of program

POST/program-service/v1/program/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

parent_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

namestring

Example: "Mukta"

program_codestring

Example: "PG/2023-24/000091"

location_code*string

Example: "pg.citya"

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/program/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pg.citya"
      }
    }),
});
const data = await response.json();

Response

{}

Search Sanction details

Search sanciton by query and return the response

POST/program-service/v1/sanction/_search

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "search"

message*all of

idsarray of string

itemsstring

location_code*string

program_codestring

paginationPagination (object)

Pagination details

limitnumber (double)

Limit for total no of records in single search max limit should be defined as envirnment variable

off_setnumber (double)

offset or page no

total_countnumber (double)

Total count for a perticular criteria

sort_bystring

result sorting order

orderobject

Order (enum)

Sorting order

ascdesc

any

Sorting order

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/sanction/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "text"
      }
    }),
});
const data = await response.json();

Response

{}

Update program after update response

Enables exchange of program related messages

POST/program-service/v1/on-program/_update

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "update"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_codestring

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

name*string

Name of the program

Example: "Community Development Initiative"

parent_idstring (uuid)

Parent Id of a program

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

description*string

Description of the program

Example: "Empowering local communities through sustainable development projects."

start_date*number

Example: 1672531200

end_datenumber

Example: 1704067200

childrenarray of object

statusall of

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

status_codeenum

Example: "ACTIVE"

ACTIVEINACTIVE

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-program/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "name": "Community Development Initiative",
        "description": "Empowering local communities through sustainable development projects.",
        "start_date": 1672531200
      }
    }),
});
const data = await response.json();

Response

{}

Create sanctions in program service

Enables creation of sanctions if not created in the system.

POST/program-service/v1/on-sanction/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*SanctionDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

net_amountnumber

gross_amountnumber

available_amountnumber

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenSanctionDetails (all of)

Circular reference to SanctionDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-sanction/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001"
      }
    }),
});
const data = await response.json();

Response

{}

Callback after allocation/_create

Update created allocation if exists or create new

POST/program-service/v1/on-allocation/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*AllocationDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

sanction_id*string (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

net_amount*number

gross_amount*number

allocation_typeenum

ALLOCATIONDEDUCTION

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenAllocationDetails (all of)

Circular reference to AllocationDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/on-allocation/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "location_code": "pb.jalandhar,dwss",
        "sanction_id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "net_amount": 0,
        "gross_amount": 0
      }
    }),
});
const data = await response.json();

Response

{}

Initiate payment request

Create new disbursement request to initiate payment.

POST/program-service/v1/disburse/_create

Body

signatureMsgSignature (string)

Signature of {header}+{message} body verified using sender's signing public key

Example:

"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA=="

header*all of

message_id*string

Unique message id to communicate between sender and receiver systems to realiable deliver the message over any transport layer i.e https, pub/sub, sftp etc.,
The scope of message_id end with successful ack of the message by the receiver.
To realy the message between hops, underlying relying parties may consider to store and forward the message with integirty, ie Signature intact.

Example: "123"

message_ts*Timestamp (string (int64))

All dates and timestamps are represented in epoc timestamp - e.g 1708428280.

Example: 1708428280

actionenum

identity payload type in message property.

createupdatesearch

sender_id*string

sender_id registered with the receiving system or gateway.
Used for authorization, encryption, digital sign verfication, etc.,

Example: "program@https://spp.example.org"

sender_uristring (uri)

sender url to accept callbacks. Applicable only for async communications and if response ack_status is ACK.
Default uri is assumed to be configred on the gateway as part of sender/receiver onboarding.
For SFTP based communications, this shall be set to server/folder details.

Example: "https://spp.example.org/{namespace}/callback/on-search"

receiver_id*string

receiver id registered with the calling system. Used for authorization, encryption, digital sign verfication, etc., functions.

Example: "program@https://pymts.example.org"

actionany

Example: "create"

message*all of

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

idstring (uuid)

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

location_code*string

Unique identifier of the tenant that could be a department/ulb/state

Example: "pb.jalandhar,dwss"

program_code*string

Formated program code PROG/{FINANCIAL_YEAR}/{ULB-CODE}/{AUTO_NUMBER}

Example: "PORG/2023-24/PG.CITYA/00001"

target_id*string

Refernece id of works payment

Example: "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934"

transaction_idstring

Formated transaction code, it will return after transaction is created at another end.

Example: "PI/2023-24/00001,BENF/2023-24/00001"

sanction_idstring

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

account_code*string

Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE

Example: "1234567890@SBIN0003491"

net_amount*number

Amount to be paid including deduction amount

Example: 1000

gross_amount*number

Actual amount to be paid without deduction

Example: 1000

individual*all of

name*string

emailstring

phone*string

pinstring

address*string

childrenarray of object

statusStatus (object)

status_codeenum

Example: "SUCCESSFUL"

RECEIVEDAPPROVEDREJECTEDINPROCESSINITIATEDSUCCESSFULFAILEDPARTIALCANCELLEDCOMPLETEDERRORINFOACTIVEINACTIVE

status_messagestring

additional_detailsAdditionalInfo (object)

Additional JSON property oject to hold custom user defined contextual data

audit_detailsAuditDetails (object)

Collection of audit related fields used by most models

created_bystring

username (preferred) or userid of the user that created the object

last_modified_bystring

username (preferred) or userid of the user that last modified the object

created_timeinteger (int64)

epoch of the time object is created

last_modified_timeinteger (int64)

epoch of the time object is last modified

typeenum

programsanctionallocationdisburse

function_codestring

Example: "FC001"

administration_codestring

Example: "AC002"

recipient_segment_codestring

Example: "RSC003"

economic_segment_codestring

Example: "ESC004"

source_of_fund_codestring

Example: "SFC005"

target_segment_codestring

Example: "TSC006"

currency_codestring

Example: "INR"

locale_codestring

Example: "LC007"

childrenDisburseDetails (all of)

Circular reference to DisburseDetails (all of) ↩

Response

HTTP layer error details

Body

errorsany

Request

const response = await fetch('/program-service/v1/disburse/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "header": {
        "message_id": "123",
        "message_ts": 1708428280,
        "sender_id": "program@https://spp.example.org",
        "receiver_id": "program@https://pymts.example.org"
      },
      "message": {
        "target_id": "EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934",
        "location_code": "pb.jalandhar,dwss",
        "program_code": "PORG/2023-24/PG.CITYA/00001",
        "individual": {
          "name": "text",
          "phone": "text",
          "address": "text"
        },
        "account_code": "1234567890@SBIN0003491",
        "net_amount": 1000,
        "gross_amount": 1000
      }
    }),
});
const data = await response.json();

Response

{}

Create/Add new COA on iFix for a tenant

POST/chartOfAccount/v1/_create

Body

Details for the new COA + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

chartOfAccountChartOfAccount (object)

Captures the COA data as map

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

Response

Get the list COA.

Based on the criteria get the list of COA.

POST/chartOfAccount/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*COASearchCriteria (object)

The object contains all the search criteria of the fund

tenantId*string

Tenant Id

Idsarray of string

List of COA ids

itemsstring

coaCodesarray of string

itemsstring

Chart of account concatinated string

majorHeadstring

Search by major head

subMajorHeadstring

Search by sub major head

minorHeadstring

Search by minor head

subHeadstring

Search by sub head

groupHeadstring

Search by group head

objectHeadstring

Search by object head

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

Response

Create/Add new Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_create

Body

Details for the new Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntityobject

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get Department Entity details.

Based on the criteria get the list of department entities.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentEntitySearchCriteria (object)

The object contains all the search criteria of Department Entity

Idsarray of string

Department Entity Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelinteger

Capture the level of department entity

getAncestryboolean

If set to true, it will return all the department entity hierarchy details starting from the root to the specified department entity id.

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create

Body

Details for the new DepartmentHierarchyLevel + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

departmentHierarchyLevel*DepartmentHierarchyLevel (object)

This object captures the information for level of the department hierarchy and it's alias

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get DepartmentHierarchyLevel.

Based on the criteria get the list of Department Hierarchy Levels.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentHierarchyLevelSearchCriteria (object)

The object contains all the search criteria of Department Hierarchy Level

Idsarray of string

Department Hierarchy Level Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

labelstring

Unique department hierarchy label like state, district, etc.

levelnumber

The level of the department hierarchy level

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Update existing Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_update

Body

Details for the update Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntity*all of

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response