POST api/OmniPay/InitiateOrderPaymentByDriver

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.
BusinessId	integer	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",
  "BusinessId": 9
}

application/xml, text/xml

Sample:

<OmnipayPaymentInitiation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderId>1</OrderId>
  <PaymentTypeId>2</PaymentTypeId>
  <AmountFromWallet>3</AmountFromWallet>
  <AmountCollectedByDriver>4</AmountCollectedByDriver>
  <IsAmountCollectedByDriver>true</IsAmountCollectedByDriver>
  <BNPLAmount>6</BNPLAmount>
  <OmoniPoint>7</OmoniPoint>
  <AppPaymentOriginatedFrom>OMS</AppPaymentOriginatedFrom>
  <ApiKey>sample string 8</ApiKey>
  <BusinessId>9</BusinessId>
</OmnipayPaymentInitiation>

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/04/28 14:46:32",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>1</StatusCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
</VCAPIResponse>