POST api/OmniPay/RetrieveOmnipayPaylaterSummary

Request Information

URI Parameters

None.

Body Parameters

GetOmniPayPaylaterSummaryFilter
NameDescriptionTypeAdditional information
CustomerId

integer

None.

PhoneNumber

string

None.

StartDate

date

None.

EndDate

date

None.

PrevStartDate

date

None.

PrevEndDate

date

None.

CustomerRef

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "PhoneNumber": "sample string 2",
  "StartDate": "2024-09-19T18:16:08.419289+01:00",
  "EndDate": "2024-09-19T18:16:08.419289+01:00",
  "PrevStartDate": "2024-09-19T18:16:08.419289+01:00",
  "PrevEndDate": "2024-09-19T18:16:08.419289+01:00",
  "CustomerRef": "sample string 7"
}

application/xml, text/xml

Sample:
<GetOmniPayPaylaterSummaryFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CustomerId>1</CustomerId>
  <CustomerRef>sample string 7</CustomerRef>
  <EndDate>2024-09-19T18:16:08.419289+01:00</EndDate>
  <PhoneNumber>sample string 2</PhoneNumber>
  <PrevEndDate>2024-09-19T18:16:08.419289+01:00</PrevEndDate>
  <PrevStartDate>2024-09-19T18:16:08.419289+01:00</PrevStartDate>
  <StartDate>2024-09-19T18:16:08.419289+01:00</StartDate>
</GetOmniPayPaylaterSummaryFilter>

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 'GetOmniPayPaylaterSummaryFilter'.

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:16:08",
  "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>