POST api/OmniPay/CreateOmniPayOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderId	integer	None.
OrderAmount	decimal number	None.
ShipmentId	string	None.
ReferenceId	string	None.
CustomerRef	string	None.
SenderId	integer	None.
SenderWalletType	OmniPayWalletTypes	None.
ReceiverId	integer	None.
ReceiverWalletType	OmniPayWalletTypes	None.
Pin	string	None.
OTP	string	None.
ConfirmationType	OmniPayOrderConfirmationType	None.
IdempotencyKey	string	None.
CreatedBy	integer	None.
WithTransaction	boolean	None.
TotalItems	integer	None.
WalletAmount	decimal number	None.
OmoniPoint	decimal number	None.
BusinessId	integer	None.
LenderBusinessId	integer	None.
SkuMetaData	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "OrderAmount": 2.0,
  "ShipmentId": "sample string 3",
  "ReferenceId": "sample string 4",
  "CustomerRef": "sample string 5",
  "SenderId": 6,
  "SenderWalletType": 1,
  "ReceiverId": 7,
  "ReceiverWalletType": 1,
  "Pin": "sample string 8",
  "OTP": "sample string 9",
  "ConfirmationType": 1,
  "IdempotencyKey": "sample string 10",
  "CreatedBy": 11,
  "WithTransaction": true,
  "TotalItems": 13,
  "WalletAmount": 14.0,
  "OmoniPoint": 15.0,
  "BusinessId": 16,
  "LenderBusinessId": 17,
  "SkuMetaData": "sample string 18"
}

application/xml, text/xml

Sample:

<CreateOmniPayOrderDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>16</BusinessId>
  <ConfirmationType>OTP</ConfirmationType>
  <CreatedBy>11</CreatedBy>
  <CustomerRef>sample string 5</CustomerRef>
  <IdempotencyKey>sample string 10</IdempotencyKey>
  <LenderBusinessId>17</LenderBusinessId>
  <OTP>sample string 9</OTP>
  <OmoniPoint>15</OmoniPoint>
  <OrderAmount>2</OrderAmount>
  <OrderId>1</OrderId>
  <Pin>sample string 8</Pin>
  <ReceiverId>7</ReceiverId>
  <ReceiverWalletType>Company</ReceiverWalletType>
  <ReferenceId>sample string 4</ReferenceId>
  <SenderId>6</SenderId>
  <SenderWalletType>Company</SenderWalletType>
  <ShipmentId>sample string 3</ShipmentId>
  <SkuMetaData>sample string 18</SkuMetaData>
  <TotalItems>13</TotalItems>
  <WalletAmount>14</WalletAmount>
  <WithTransaction>true</WithTransaction>
</CreateOmniPayOrderDto>

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/03 16:02:26",
  "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>