POST api/OmniPay/ReconcileOmniPayOrders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderIds	string	None.
IdempotencyKey	string	None.
ReferenceId	string	None.
ShipmentId	string	None.
ReconcilationMode	ReconcilationMode	None.
CreatedBy	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderIds": "sample string 1",
  "IdempotencyKey": "sample string 2",
  "ReferenceId": "sample string 3",
  "ShipmentId": "sample string 4",
  "ReconcilationMode": 1,
  "CreatedBy": 5
}

application/xml, text/xml

Sample:

<CreateOmniPayReconcilationApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CreatedBy>5</CreatedBy>
  <IdempotencyKey>sample string 2</IdempotencyKey>
  <OrderIds>sample string 1</OrderIds>
  <ReconcilationMode>ShipmentType</ReconcilationMode>
  <ReferenceId>sample string 3</ReferenceId>
  <ShipmentId>sample string 4</ShipmentId>
</CreateOmniPayReconcilationApiModel>

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

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/04/04 07:28:21",
  "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>