POST api/OmniPay/RetrieveOmnipayLoansLists

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
PhoneNumber	string	None.
CustomerRef	string	None.
ChargeBucket	string	None.
PageNo	integer	None.
RecordsPerPage	integer	None.
StartDate	date	None.
EndDate	date	None.
IsPaid	OmnipayLoansPaidEnums	None.
BusinessId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "PhoneNumber": "sample string 2",
  "CustomerRef": "sample string 3",
  "ChargeBucket": "sample string 4",
  "PageNo": 1,
  "RecordsPerPage": 1,
  "StartDate": "2025-11-02T06:45:43.6005992+00:00",
  "EndDate": "2025-11-02T06:45:43.6005992+00:00",
  "IsPaid": 0,
  "BusinessId": 5
}

application/xml, text/xml

Sample:

<GetOmnipayLoansFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>5</BusinessId>
  <ChargeBucket>sample string 4</ChargeBucket>
  <CustomerId>1</CustomerId>
  <CustomerRef>sample string 3</CustomerRef>
  <EndDate>2025-11-02T06:45:43.6005992+00:00</EndDate>
  <IsPaid>UnPaid</IsPaid>
  <PageNo>1</PageNo>
  <PhoneNumber>sample string 2</PhoneNumber>
  <RecordsPerPage>1</RecordsPerPage>
  <StartDate>2025-11-02T06:45:43.6005992+00:00</StartDate>
</GetOmnipayLoansFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional 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": "2025/11/02 06:45:43",
  "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>