GET api/testdeposits/{startDate}/{endDate}
This function returns all payments made within a specified period. The dates are passed as a string in the format yyyy-mm-dd.The specified dates are inclusive.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate | string |
Required |
|
endDate | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Json array of TestBankEntries
Collection of TestBankEntryName | Description | Type | Additional information |
---|---|---|---|
BankEntryId | integer |
None. |
|
PayeeNumber | string |
None. |
|
PayeeName | string |
None. |
|
Programme | string |
None. |
|
Dop | date |
Required Data type: Date |
|
Amount | decimal number |
None. |
|
TransactionId | string |
String length: inclusive between 0 and 50 |
|
PaymentType | PaymentType |
Required |
|
Currency | Currency |
Required |
|
PaymentGateway | PaymentGateway |
Required |
|
Processed | boolean |
None. |
|
ProcessingDate | date |
None. |
|
Username | string |
None. |
|
EntryComments | string |
String length: inclusive between 0 and 250 |
|
ProcessingComments | string |
String length: inclusive between 0 and 250 |
Response Formats
application/json, text/json
Sample:
[ { "BankEntryId": 1, "PayeeNumber": "sample string 2", "PayeeName": "sample string 3", "Programme": "sample string 4", "Dop": "2025-06-25T05:16:30.5113413+00:00", "Amount": 6.0, "TransactionId": "sample string 7", "PaymentType": 1, "Currency": 1, "PaymentGateway": 1, "Processed": true, "ProcessingDate": "2025-06-25T05:16:30.5113413+00:00", "Username": "sample string 9", "EntryComments": "sample string 10", "ProcessingComments": "sample string 11" }, { "BankEntryId": 1, "PayeeNumber": "sample string 2", "PayeeName": "sample string 3", "Programme": "sample string 4", "Dop": "2025-06-25T05:16:30.5113413+00:00", "Amount": 6.0, "TransactionId": "sample string 7", "PaymentType": 1, "Currency": 1, "PaymentGateway": 1, "Processed": true, "ProcessingDate": "2025-06-25T05:16:30.5113413+00:00", "Username": "sample string 9", "EntryComments": "sample string 10", "ProcessingComments": "sample string 11" } ]
application/xml, text/xml
Sample:
<ArrayOfTestBankEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SRMS.Domain.Entities"> <TestBankEntry> <Amount>6</Amount> <BankEntryId>1</BankEntryId> <Currency>GHS</Currency> <Dop>2025-06-25T05:16:30.5113413+00:00</Dop> <EntryComments>sample string 10</EntryComments> <PayeeName>sample string 3</PayeeName> <PayeeNumber>sample string 2</PayeeNumber> <PaymentGateway>FidelityBank</PaymentGateway> <PaymentType>AdmissionForm</PaymentType> <Processed>true</Processed> <ProcessingComments>sample string 11</ProcessingComments> <ProcessingDate>2025-06-25T05:16:30.5113413+00:00</ProcessingDate> <Programme>sample string 4</Programme> <TransactionId>sample string 7</TransactionId> <Username>sample string 9</Username> </TestBankEntry> <TestBankEntry> <Amount>6</Amount> <BankEntryId>1</BankEntryId> <Currency>GHS</Currency> <Dop>2025-06-25T05:16:30.5113413+00:00</Dop> <EntryComments>sample string 10</EntryComments> <PayeeName>sample string 3</PayeeName> <PayeeNumber>sample string 2</PayeeNumber> <PaymentGateway>FidelityBank</PaymentGateway> <PaymentType>AdmissionForm</PaymentType> <Processed>true</Processed> <ProcessingComments>sample string 11</ProcessingComments> <ProcessingDate>2025-06-25T05:16:30.5113413+00:00</ProcessingDate> <Programme>sample string 4</Programme> <TransactionId>sample string 7</TransactionId> <Username>sample string 9</Username> </TestBankEntry> </ArrayOfTestBankEntry>