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

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

Swagger Editor

Implemented API Specifications

Base Path: /program-service/

API Contract Link

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

Swagger Editor

APIs

Creates a program

Create programs in the system

post

/program

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/program' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Update program after create response

Enables exchange of program related messages

post

/on-program

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-program' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Create estimate

Creates estimate for the program.

post

/estimate

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/estimate' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Update estimate after create

User can update the estimate if already created using on-estimate.

post

/on-estimate

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-estimate' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Create sanction request

Create sanction request in the system, this sanction is linked with program.

post

/sanction

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/sanction' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Update created sanction

Update staus of created sanciton request.

post

/on-sanction

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-sanction' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Request to create allocation

User can request to create an allocation for sanction.

post

/allocation

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/allocation' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Update allocation status

Update created allocation staus

post

/on-allocation

Body

signaturestring

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

Example:

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

messageobjectrequired

Exchange message content which will be shared with all request

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-allocation' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Initiate payment request

Create new disbursement request to initiate payment.

post

/disburse

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/disburse' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Updated status of create disburse request

post

/on-disburse

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-disburse' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Initiate demand request

Create new demand request.

post

/demand

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/demand' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Updated create demand request

post

/on-demand

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-demand' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Initiate receipt request

Create new receipt.

post

/receipt

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/receipt' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Updated status of create receipt request

post

/on-receipt

Body

signaturestring

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

Example:

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

messageall ofrequired

headerall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ifix/v1/on-receipt' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"TgE1hcA2E+YPMdPGz4vveKQpR0x+pgzRTlet52qh63Kekr71vWWScXqaRFtQW64uRFZGBUhHYYZQ2y6LffwnNOOQhhssaThhqVBhXNEwX9i75SNYXi5XSJVDYzSyHrhF20HW6RE9mAVWdc80i7d+FXlh+b/U+fnj+SrZ2s6Xd0WUZvU29LgqeUpyznlWLu1mDdJxNZavsDLWmxjTnknqBjDvwSc35WhFDhXDA2lWmm8YpZ1Y6TBmvvtVS7mAOTnhFy9sdCbrLcfXk5QWIsdzlvPqlkvdwEf30OZ6ewb680Aj3hO2OT5LCv7iLyz7C7srnB9lJT5gXiw+eSnktPXlDA==","message":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","name":"Community Development Initiative","linked_id":"sanction:251c51eb-e970-4e01-a99a-70136c47a934","location_code":"pb.jalandhar","program_code":"PORG/2023-24/00001","transaction_id":"PI/2023-24/00001","net_amount":1000,"gross_amount":1000,"status":{"status_code":"SUCCESSFUL"},"additional_details":{},"audit_details":{},"account_code":"1234567890@SBIN0003491","function_code":"LIVELIHOOD","administration_code":"HUDD","recipient_segment_code":"CBO","economic_segment_code":"PEOPLE","source_of_fund_code":"STATE","target_segment_code":"MALE","currency_code":"INR","locale_code":"LC007","type":"program","children":"[Circular Reference]","individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}],"individual":{"name":"John","email":"john@gmail.com","phone":9876543210,"pin":110001,"address":"3476, Gali Bajrang Bali, Delhi"}}}'

401

403

500

default

{
  "errors": [
    {
      "code": "text",
      "message": "text"
    }
  ]
}

HTTP layer error details

Data Model

DB Schema

Web Sequence Diagrams

PreviousDIGIT Exchange NextInstall iFIX

Last updated 16 days ago

Was this helpful?