# Data Dictionary

The data used in the orchestration layer are given below. This data will be stored in the analytical data store for real-time analysis and reconciliation

Party Lookup

| Name                  | Data Type | Description                                                                     |
| --------------------- | --------- | ------------------------------------------------------------------------------- |
| partyLookupFailed     | boolean   | Denotes that the party look up operation failed                                 |
| partyLookupEnabled    | boolean   | Part of batch processing , denotes party look up is enabled for a batch or not. |
| partyLookupRetryCount | int       | Based on this value the retry loop is delimited                                 |

Fund Transfer

| Name              | Data Type | Description                                     |
| ----------------- | --------- | ----------------------------------------------- |
| transactionFailed | boolean   | This is used to mark the transaction as failed. |

Account Lookup

<table data-header-hidden><thead><tr><th width="264.3333333333333"></th><th></th><th></th></tr></thead><tbody><tr><td>Name</td><td>Data Type</td><td>Description</td></tr><tr><td>initiatorFspId</td><td>string</td><td>Tenant id / source id </td></tr><tr><td>accountLookupRetryCount</td><td>int</td><td>Based on this value the retry loop is delimited</td></tr><tr><td>accountLookupFailed</td><td>boolean</td><td>Denotes whether the look up is failed or not</td></tr><tr><td>originChannelRequest</td><td>string</td><td>Original request body preserved here before account lookup service updates the (target) details</td></tr><tr><td>X-CallbackURL</td><td>string</td><td>URL on which the asynchronous call response is published</td></tr></tbody></table>

Batch

| Name                            | Data Type | Description                                                                                                                                                   |
| ------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| approvalEnabled                 | boolean   | Whether the approval process is enabled for batch file or not                                                                                                 |
| approvalFailed                  | boolean   | Denotes whether the approval is success or not                                                                                                                |
| batchId                         | string    | Unique Id for each batch request.                                                                                                                             |
| callbackUrl                     | string    | URL on which the batch process result is published                                                                                                            |
| completionThreshold             | int       | Minimum threshold for marking batch process success                                                                                                           |
| completionThresholdCheckEnabled | boolean   | Denotes whether the completion threshold check is enabled or not                                                                                              |
| filename                        | string    | Name of the batch file                                                                                                                                        |
| formattingEnabled               | boolean   | Denotes whether batch file formatting is enabled or not                                                                                                       |
| isFileValid                     | boolean   | After validation this flag denotes if the file is valid or not                                                                                                |
| maxCallbackRetry                | int       | Maximum number of times the call back URL is hit in case of failure                                                                                           |
| maxStatusRetry                  | int       | Maximum number of times the batch processing status is updated untill completion threshold is reached                                                         |
| mergeEnabled                    | boolean   | Denotes if the merging of sub batches is enabled or not                                                                                                       |
| orderingEnabled                 | boolean   | Denotes whether the sorting of batchfile over an arbitrary parameter or not                                                                                   |
| phases                          | int array | Array of completion threashod(milestones) on which the completion status is published                                                                         |
| purpose                         | string    | The purpose(narration) of the batch transaction Eg: "Batch Processing of posting interest"                                                                    |
| requestId                       | string    | Unique request id present in the bacth File for each transaction.                                                                                             |
| splittingEnabled                | boolean   | This denotes whether the splitting of the batch file into multiple subbatch file is enabled or not                                                            |
| thresholdDelay                  | string    | <p>Wait time to check for completion when the completion threshold is not reached.<br>zeebe variable that starts with "PT" and ends with "S"<br>Eg: PT45S</p> |
| debulkingDfspid                 | string    | Unique id demoting the FSP at the debulking side of the batch                                                                                                 |
| externalId                      | string    | Identifier for marking external resource                                                                                                                      |

Transaction (Generic)

| Name          | Data Type | Description                                        |
| ------------- | --------- | -------------------------------------------------- |
| transactionId | string    | Autogenerated unique identifier of the transaction |

Transfer

| Name                | Data Type | Description                             |
| ------------------- | --------- | --------------------------------------- |
| payerIdentifierType | string    | Type of Identifier Eg: MSISDN, IBAN etc |
| payeeIdentifierType | string    | Type of Identifier Eg: MSISDN, IBAN etc |
| payerDFSPID         | string    | Unique ID of the FSP                    |
| payeeDFSPID         | string    | Unique ID of the FSP                    |
|                     |           |                                         |

Common

| Name                | Data Type | Description                                                                                                            |
| ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------- |
| tenantId            | string    | Payment hub tenant for Initiator.                                                                                      |
| originDate          | long      | Transaction start time (millisecond format)                                                                            |
| timer               | string    | system property(zeebe)                                                                                                 |
| waitTimer           | string    | system property(zeebe)                                                                                                 |
| errorCode           | int       | HTTP response code for the  error( generated internally or from external systems)                                      |
| errorDescription    | string    | Descripion of the error                                                                                                |
| clientCorrelationId | string    | Unique id added to each api by client. This id is used for ensuring idempotency of the request and for status tracking |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mifos.gitbook.io/docs/payment-hub-ee/overview/data-dictionary.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
