These are the parameters for completed transaction
Query Parameters
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| where | Filters the account transactions based on various conditions. | Optional | SavingAccTrxnWhereParam | { id: { EQ: 123 }, createdAt: { GE: "2024-01-01T00:00:00Z" }, reversed: { EQ: false }, AND: [{ account: { id: { EQ: 456 } } }] } |
| page | Specifies pagination details. | Optional | PageAndStartParam | { start: 1, limit: 40 } |
SavingAccTrxnWhereParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the transaction ID. | Optional | SavingAccTrxnIdParam | { EQ: 123 } |
| createdAt | Filters based on the creation date and time. | Optional | SavingAccTrxnLocalDateTimeParam | { GE: "2024-01-01T00:00:00Z", LE: "2024-01-31T23:59:59Z" } |
| reversed | Filters based on whether the transaction is reversed. | Optional | SavingAccTrxnReversedParam | { EQ: false } |
| account | Filters based on account details. | Optional | SavingAccTrxnAccountParam | { id: { EQ: 456 } } |
| AND | Combines multiple conditions with AND logic. | Optional | [SavingAccTrxnAndParam] | [{ account: { id: { EQ: 456 } }, createdAt: { GE: "2024-01-01T00:00:00Z" } }] |
| OR | Combines multiple conditions with OR logic. | Optional | [SavingAccTrxnOrParam] | [{ paymentDetail: { reference: { LIKE: "%ref%" } }, subTypeOf: { EQ: 2 } }] |
SavingAccTrxnReversedParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the reversed status equals a specified value. | Optional | Boolean | false |
SavingAccTrxnAndParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the transaction ID. | Optional | SavingAccTrxnIdParam | { EQ: 123 } |
| account | Filters based on account details. | Optional | SavingAccTrxnAccountParam | { id: { EQ: 456 } } |
| createdAt | Filters based on the creation date and time. | Optional | SavingAccTrxnLocalDateTimeParam | { GE: "2024-01-01T00:00:00Z", LE: "2024-01-31T23:59:59Z" } |
| initiatedAt | Filters based on the initiation date and time. | Optional | SavingAccTrxnLocalDateTimeParam | { GE: "2024-01-01T00:00:00Z", LE: "2024-01-31T23:59:59Z" } |
| typeOf | Filters based on the transaction type. | Optional | SavingAccTrxnTypeOfParam | { EQ: 2 } |
| OR | Combines multiple conditions with OR logic. | Optional | [SavingAccTrxnOrParam] | [{ paymentDetail: { reference: { LIKE: "%ref%" } }, subTypeOf: { EQ: 2 } }] |
| paymentDetail | Filters based on payment details. | Optional | PaymentDetailParam | { reference: { LIKE: "%ref%" }, userInputReference: { LIKE: "%inputRef%" } } |
| status | Filters based on the transaction status. | Optional | SavingAccTrxnStatusParam | { EQ: 1 } |
| amount | Filters based on the transaction amount. | Optional | SavingsAccountAmountParam | { GE: 100.0, LE: 200.0 } |
| subTypeOf | Filters based on the transaction subtype. | Optional | SavingAccTrxnSubTypeOfParam | { EQ: 1, IS_NULL: true } |
SavingAccTrxnOrParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| paymentDetail | Filters based on payment details. | Optional | PaymentDetailParam | { reference: { LIKE: "%ref%" }, userInputReference: { LIKE: "%inputRef%" } } |
| subTypeOf | Filters based on the transaction subtype. | Optional | SavingAccTrxnSubTypeOfParam | { EQ: 1, IS_NULL: true } |
PaymentDetailParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| reference | Filters based on the payment reference. | Optional | SavingAccTrxnReferenceParam | { LIKE: "%ref%" } |
| userInputReference | Filters based on the user input reference. | Optional | SavingAccTrxnUserInputReferenceParam | { LIKE: "%inputRef%" } |
| correlationId | Filters based on the correlation ID. | Optional | SavingAccTrxnCorrelationIdParam | { EQ: "corr123" } |
| paymentType | Filters based on the payment type. | Optional | SavingAccTrxnPaymentTypeParam | { id: { EQ: 1 }, name: { EQ: "ACH" } } |
| cardAuthorization | Filters based on card authorization details. | Optional | SavingAccTrxnCardAuthorizationParam | { merchantMcc: { EQ: "MCC123" }, card: { id: { EQ: 789 } } } |
| cardSettlement | Filters based on card settlement details. | Optional | SavingAccTrxnCardSettlementParam | { id: 123, amount: 100.0, externalId: "ext123" } |
| OR | Combines multiple conditions with OR logic. | Optional | [SavingAccTrxnPaymentDetailOrParam] | [{ reference: { LIKE_: "%ref%" } }] |
SavingAccTrxnPaymentDetailOrParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| reference | Filters based on the payment reference with LIKE condition. | Optional | SavingAccTrxnPaymentDetailReferenceParam | { LIKE_: "%ref%" } |
SavingAccTrxnPaymentDetailReferenceParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| LIKE_ | Checks if the reference contains a specified substring. | Optional | String | "%ref%" |
SavingAccTrxnCardSettlementParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | The card settlement ID. | Optional | Long | 123 |
| amount | The amount of the card settlement. | Optional | BigDecimal | 100.0 |
| externalId | The external ID of the card settlement. | Optional | String | "ext123" |
SavingAccTrxnAccountParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the account ID. | Optional | SavingAccTrxnAccountIdParam | { EQ: 456 } |
| status | Filters based on the account status. | Optional | SavingsAccountStatusParam | { EQ: "ACTIVE" } |
| OR | Combines multiple conditions with OR logic. | Optional | [SavingAccTrxnAccountOrParam] | [{ id: { EQ: 789 } }] |
SavingAccTrxnAccountOrParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the account ID with OR logic. | Optional | SavingAccTrxnAccountIdOrParam | { EQ: 789 } |
SavingAccTrxnAccountIdOrParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the account ID equals a specified value. | Optional | Long | 789 |
SavingAccTrxnAccountIdParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the account ID equals a specified value. | Optional | Long | 456 |
SavingAccTrxnIdParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| IN | Checks if the transaction ID is in a list of values. | Optional | [Long!] | [123, 124, 125] |
| GT | Checks if the transaction ID is greater than a value. | Optional | Long | 100 |
| LT | Checks if the transaction ID is less than a value. | Optional | Long | 200 |
| EQ | Checks if the transaction ID equals a value. | Optional | Long | 123 |
SavingAccTrxnLocalDateTimeParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| GE | Checks if the date and time is greater than or equal to a specified value. | Optional | LocalDateTime | "2024-01-01T00:00:00Z" |
| LE | Checks if the date and time is less than or equal to a specified value. | Optional | LocalDateTime | "2024-01-31T23:59:59Z" |
| BETWEEN | Checks if the date and time is between two values. | Optional | [LocalDateTime] | ["2024-01-01T00:00:00Z", "2024-01-31T23:59:59Z"] |
SavingAccTrxnTypeOfParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the transaction type equals a specified value. | Optional | Int | 2 |
| NIN | Checks if the transaction type is not in a list of values. | Optional | [Int!] | [1, 3, 4] |
| IN | Checks if the transaction type is in a list of values. | Optional | [Int!] | [2, 5] |
SavingAccTrxnReferenceParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| LIKE | Checks if the reference contains a specified substring. | Optional | String | "%ref%" |
SavingAccTrxnUserInputReferenceParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| LIKE | Checks if the user input reference contains a specified substring. | Optional | String | "%inputRef%" |
SavingAccTrxnCorrelationIdParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the correlation ID equals a specified value. | Optional | String | "corr123" |
SavingAccTrxnSubTypeOfParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the subtype equals a specified value. | Optional | Int | 1 |
| IS_NULL | Checks if the subtype is null. | Optional | Boolean | true |
| NE | Checks if the subtype does not equal a value. | Optional | Int | 2 |
| IN | Checks if the subtype is in a list of values. | Optional | [Int!] | [1, 3, 5] |
| NIN | Checks if the subtype is not in a list of values. | Optional | [Int!] | [2, 4, 6] |
SavingsAccountAmountParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| GE | Checks if the amount is greater than or equal to a specified value. | Optional | BigDecimal | 100.0 |
| LE | Checks if the amount is less than or equal to a specified value. | Optional | BigDecimal | 200.0 |
| EQ | Checks if the amount equals a specified value. | Optional | BigDecimal | 150.0 |
SavingAccTrxnStatusParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the status equals a specified value. | Optional | Int | 1 |
SavingAccTrxnPaymentTypeParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the payment type ID. | Optional | SavingAccTrxnPaymentTypeIdParam | { EQ: 1 } |
| name | Filters based on the payment type name. | Optional | SavingAccTrxnPaymentTypeNameParam | { EQ: "ACH" } |
SavingAccTrxnPaymentTypeIdParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the payment type ID equals a specified value. | Optional | Long | 1 |
SavingAccTrxnPaymentTypeNameParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the payment type name equals a specified value. | Optional | String | "ACH" |
| IN | Checks if the payment type name is in a list of values. | Optional | [String!] | ["ACH", "Wire"] |
SavingAccTrxnCardAuthorizationParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| merchantMcc | Filters based on the merchant MCC code. | Optional | CardAuthorizationMerchantMccParam | { EQ: "MCC123", IN: ["MCC123", "MCC456"] } |
| card | Filters based on card details. | Optional | SavingAccTxnCardAuthorizationCardParam | { id: { EQ: 789 } } |
SavingAccTxnCardAuthorizationCardParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| id | Filters based on the card ID. | Optional | SavingAccTxnCardAuthorizationCardIdParam | { EQ: 789 } |
SavingAccTxnCardAuthorizationCardIdParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the card ID equals a specified value. | Optional | Long | 789 |
CardAuthorizationMerchantMccParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| EQ | Checks if the merchant MCC code equals a specified value. | Optional | String | "MCC123" |
| IN | Checks if the merchant MCC code is in a list of values. | Optional | [String!] | ["MCC123", "MCC456"] |
PageAndStartParam
| Parameter | Description | Mandatory | Data Type | Example |
|---|
| start | The starting point of the result set. | Yes | Number | 1 |
| limit | The maximum number of results to return. | Yes | Number | 40 |