> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/~/changes/xKUM0sBXFkyR8F24yAMq/g2p-bridge/development/design-specifications/persistent-objects/disbursement.md).
# create\_disbursements
| API Attributes | |
| -------------- | -------------------------------------------------- |
| Direction | Inward |
| Invoked by | PBMS |
| Mode | Synchronous |
| Tables | disbursement
disbursement\_batch\_status
|
A disbursement represents a single disbursement transaction under a disbursement\_envelope. A disbursement\_envelope will contain many hundreds/thousands of disbursements. Each such disbursement will be denoted by a unique disbursement\_id
## Object design
### disbursement
| Attribute | Datatype |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| disbursement\_envelope\_id | The envelope under which this disbursement is being effected
Non Unique Index
|
| disbursement\_id | Unique identifier for each disbursement transaction - Primary Key |
| beneficiary\_id | The Beneficiary ID to whom this disbursement is being targeted |
| beneficiary\_name | The name of the beneficiary as available in the PBMS / Social Registry records |
| disbursement\_amount | The disbursement amount (in the currency specified in the envelope) for this cycle of the program |
| narrative | The text that will be available in the Account Statement of the beneficiary's account against this disbursement credit transaction |
| receipt\_time\_stamp | Time stamp of receipt of disbursement |
| cancellation\_status | Enum
NOT\_CANCELLED
CANCELLED
|
| cancellation\_time\_stamp | Time stamp of receipt of cancellation request |
### disbursement\_batch\_status
| Attribute | Datatype |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| disbursement\_id | Unique identifier for each disbursement transaction - Primary Key |
| disbursement\_envelope\_id | The envelope under which this disbursement is being effected |
| shipment\_to\_bank\_status | Enum
PENDING
PROCESSED
|
| shipment\_to\_bank\_time\_stamp | Time stamp of shipment to Sponsor bank |
| reply\_status\_from\_bank | Enum
SUCCESS
FAILURE
|
| reply\_from\_bank\_time\_stamp | Time stamp of receipt of reply from Sponsor bank |
| reply\_failure\_error\_code | Error code from the downstream G2P chain participants (Sponsor bank, Payment switch, Destination banks) in case of a FAILURE (reply\_status\_from\_bank) |
| reply\_failure\_error\_message | Error message describing the failure\_error\_code |
| reply\_success\_fsp\_code | If the disbursement is a success, the fsp (the financial service provider / destination bank) code - where the account was credited |
| reply\_success\_fa | The full Financial Address (including account number, branch code / mobile number) where the disbursement was credited |
| mapper\_resolved\_fa | The FA resolved from ID-Account-Mapper |
| mapper\_resolved\_phone\_number | The phone number resolved from ID-Account-Mapper |
| mapper\_resolved\_name | The name of the beneficiary resolved from ID-Account-Mapper |
| mapper\_resolved\_timestamp | The timestamp - when ID-Account was resolved |
| mapper\_resolved\_retries | Retry Count - for ID-Account-Mapper resolution |
#### Business Logic
Results in persistence of 1 record each in the tables - disbursement and disbursement\_batch\_status.
Bulk Insert should be used to persist the disbursements
Transaction Control - should be ALL or NONE, i.e. either everything should be inserted or none should be inserted.
#### Validations & Exceptions
1. Ideally, disbursements should arrive before disbursement\_schedule\_date. However, system will not check this condition. System will anyway process an envelope, only when all the disbursements have arrived.
2. disbursement\_amount - valid non zero number
3. the total number of disbursements should not exceed the number specified in the envelope
4. the total\_disbursement\_amount should not exceed the number specified in the envelope
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.openg2p.org/~/changes/xKUM0sBXFkyR8F24yAMq/g2p-bridge/development/design-specifications/persistent-objects/disbursement.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.