POST api/OmniPay/GetOmnipayShipmentTransactions

Request Information

URI Parameters

None.

Body Parameters

GetOmniPayShipmentTransactionFilter
NameDescriptionTypeAdditional information
RequesterId

integer

None.

WalletId

string

None.

Search

string

None.

StartDate

date

None.

EndDate

date

None.

PageNo

integer

None.

RecordsPerPage

integer

None.

TransactionType

string

None.

WalletType

OmniPayWalletTypes

None.

Request Formats

application/json, text/json

Sample:
{
  "WalletType": 1,
  "RequesterId": 1,
  "WalletId": "sample string 2",
  "Search": "sample string 3",
  "StartDate": "2024-09-19T18:18:06.5454267+01:00",
  "EndDate": "2024-09-19T18:18:06.5454267+01:00",
  "PageNo": 1,
  "RecordsPerPage": 1,
  "TransactionType": "sample string 4"
}

application/xml, text/xml

Sample:
<GetOmniPayShipmentTransactionFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <EndDate>2024-09-19T18:18:06.5454267+01:00</EndDate>
  <PageNo>1</PageNo>
  <RecordsPerPage>1</RecordsPerPage>
  <RequesterId>1</RequesterId>
  <Search>sample string 3</Search>
  <StartDate>2024-09-19T18:18:06.5454267+01:00</StartDate>
  <TransactionType>sample string 4</TransactionType>
  <WalletId>sample string 2</WalletId>
  <WalletType>Company</WalletType>
</GetOmniPayShipmentTransactionFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetOmniPayShipmentTransactionFilter'.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional information
Version

string

None.

dateTime

string

None.

StatusCode

integer

None.

ErrorMessage

string

None.

Result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 18:18:06",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>