POST api/OmniPay/ReconcileDriverCashPayments

Request Information

URI Parameters

None.

Body Parameters

CallOmnipayMopupDto
NameDescriptionTypeAdditional information
ShipmentId

string

None.

DriverId

integer

None.

OrderIds

Collection of integer

None.

MopUpType

MopUpType

None.

LoggedInUser

integer

None.

IdempotencyKey

string

None.

WalletId

string

None.

WalletType

PublicOmniPayWalletTypes

None.

Request Formats

application/json, text/json

Sample:
{
  "ShipmentId": "sample string 1",
  "DriverId": 2,
  "OrderIds": [
    1,
    2
  ],
  "MopUpType": 1,
  "LoggedInUser": 3,
  "IdempotencyKey": "sample string 4",
  "WalletId": "sample string 5",
  "WalletType": 2
}

application/xml, text/xml

Sample:
<CallOmnipayMopupDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <WalletId>sample string 5</WalletId>
  <WalletType>Customer</WalletType>
  <DriverId>2</DriverId>
  <IdempotencyKey>sample string 4</IdempotencyKey>
  <LoggedInUser>3</LoggedInUser>
  <MopUpType>ShipmentType</MopUpType>
  <OrderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIds>
  <ShipmentId>sample string 1</ShipmentId>
</CallOmnipayMopupDto>

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

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:27:46",
  "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>