GET api/bankchecks/{bankCheckID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| bankCheckID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
BankCheckDeepData| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusHistoryList | Collection of BankCheckStatusHistoryData |
None. |
|
| BankID | integer |
None. |
|
| BankName | string |
None. |
|
| BankSubsidiary | string |
None. |
|
| ClientID | integer |
None. |
|
| ClientName | string |
None. |
|
| ProviderID | integer |
None. |
|
| ProviderName | string |
None. |
|
| OwnerName | string |
None. |
|
| OutputDate | date |
None. |
|
| Amount | decimal number |
None. |
|
| Number | string |
None. |
|
| CashedDate | date |
None. |
|
| Status | BankCheckStatusEnum |
None. |
|
| Description | string |
None. |
|
| CashedBankID | integer |
None. |
|
| CashedBankName | string |
None. |
|
| EndorseDate | date |
None. |
|
| CreatedOn | date |
None. |
|
| TransitType | BankCheckTransitTypeEnum |
None. |
|
| AmmountToStr | string |
None. |
|
| PersonDisplayName | string |
None. |
|
| GetDescriptionForStatusEnum | string |
None. |
|
| AmmountToDecimal | decimal number |
None. |
|
| OutputDateStr | string |
None. |
|
| CashedDateStr | string |
None. |
|
| EndorseToName | string |
None. |
|
| EndorseDateToStr | string |
None. |
|
| ID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"StatusHistoryList": [
{
"BankCheckID": 1,
"Status": 0,
"Description": "sample string 1",
"CreatedByDisplayName": "sample string 2",
"CreatedOn": "2026-02-04T03:01:30.4175792+00:00",
"ID": 1
},
{
"BankCheckID": 1,
"Status": 0,
"Description": "sample string 1",
"CreatedByDisplayName": "sample string 2",
"CreatedOn": "2026-02-04T03:01:30.4175792+00:00",
"ID": 1
}
],
"BankID": 1,
"BankName": "sample string 1",
"BankSubsidiary": "sample string 2",
"ClientID": 1,
"ClientName": "sample string 3",
"ProviderID": 1,
"ProviderName": "sample string 4",
"OwnerName": "sample string 5",
"OutputDate": "2026-02-04T03:01:30.4175792+00:00",
"Amount": 1.0,
"Number": "sample string 6",
"CashedDate": "2026-02-04T03:01:30.4175792+00:00",
"Status": 0,
"Description": "sample string 7",
"CashedBankID": 1,
"CashedBankName": "sample string 8",
"EndorseDate": "2026-02-04T03:01:30.4175792+00:00",
"CreatedOn": "2026-02-04T03:01:30.4175792+00:00",
"TransitType": 0,
"AmmountToStr": "1,00",
"PersonDisplayName": "sample string 3",
"GetDescriptionForStatusEnum": "Borrador / No Confirmado",
"AmmountToDecimal": 1.0,
"OutputDateStr": "04/02/2026",
"CashedDateStr": "04/02/2026",
"EndorseToName": "sample string 4",
"EndorseDateToStr": "04/02/2026",
"ID": 1
}
text/xml
Sample:
<BankCheckDeepData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data.BankCheck">
<ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
<Amount>1</Amount>
<BankID>1</BankID>
<BankName>sample string 1</BankName>
<BankSubsidiary>sample string 2</BankSubsidiary>
<CashedBankID>1</CashedBankID>
<CashedBankName>sample string 8</CashedBankName>
<CashedDate>2026-02-04T03:01:30.4175792+00:00</CashedDate>
<ClientID>1</ClientID>
<ClientName>sample string 3</ClientName>
<CreatedOn>2026-02-04T03:01:30.4175792+00:00</CreatedOn>
<Description>sample string 7</Description>
<EndorseDate>2026-02-04T03:01:30.4175792+00:00</EndorseDate>
<Number>sample string 6</Number>
<OutputDate>2026-02-04T03:01:30.4175792+00:00</OutputDate>
<OwnerName>sample string 5</OwnerName>
<ProviderID>1</ProviderID>
<ProviderName>sample string 4</ProviderName>
<Status>DRAFT</Status>
<StatusHistoryList>
<BankCheckStatusHistoryData>
<ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
<BankCheckID>1</BankCheckID>
<CreatedByDisplayName>sample string 2</CreatedByDisplayName>
<CreatedOn>2026-02-04T03:01:30.4175792+00:00</CreatedOn>
<Description>sample string 1</Description>
<Status>DRAFT</Status>
</BankCheckStatusHistoryData>
<BankCheckStatusHistoryData>
<ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
<BankCheckID>1</BankCheckID>
<CreatedByDisplayName>sample string 2</CreatedByDisplayName>
<CreatedOn>2026-02-04T03:01:30.4175792+00:00</CreatedOn>
<Description>sample string 1</Description>
<Status>DRAFT</Status>
</BankCheckStatusHistoryData>
</StatusHistoryList>
</BankCheckDeepData>