POST api/OmniPay/CompleteOrderPaymentWithOmniPayOMS

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderId	integer	None.
PaymentTypeId	integer	None.
AmountFromWallet	decimal number	None.
AmountCollectedByDriver	decimal number	None.
IsAmountCollectedByDriver	boolean	None.
BNPLAmount	decimal number	None.
OmoniPoint	decimal number	None.
AppPaymentOriginatedFrom	PaymentAppOrigins	None.
ApiKey	string	None.
Latitude	string	None.
Longitude	string	None.
TransactionId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "PaymentTypeId": 2,
  "AmountFromWallet": 3.0,
  "AmountCollectedByDriver": 4.0,
  "IsAmountCollectedByDriver": true,
  "BNPLAmount": 6.0,
  "OmoniPoint": 7.0,
  "AppPaymentOriginatedFrom": 1,
  "ApiKey": "sample string 8",
  "Latitude": "sample string 9",
  "Longitude": "sample string 10",
  "TransactionId": "sample string 11"
}

application/xml, text/xml

Sample:

<OmnipayCompleteOrderPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AmountCollectedByDriver>4</AmountCollectedByDriver>
  <AmountFromWallet>3</AmountFromWallet>
  <ApiKey>sample string 8</ApiKey>
  <AppPaymentOriginatedFrom>OMS</AppPaymentOriginatedFrom>
  <BNPLAmount>6</BNPLAmount>
  <IsAmountCollectedByDriver>true</IsAmountCollectedByDriver>
  <Latitude>sample string 9</Latitude>
  <Longitude>sample string 10</Longitude>
  <OmoniPoint>7</OmoniPoint>
  <OrderId>1</OrderId>
  <PaymentTypeId>2</PaymentTypeId>
  <TransactionId>sample string 11</TransactionId>
</OmnipayCompleteOrderPayment>

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

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": "2024/09/19 18:32:52",
  "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>