POST api/Store/AddOrderPayment

Request Information

URI Parameters

None.

Body Parameters

OrderPayment
NameDescriptionTypeAdditional information
BusinessId

integer

None.

LoginUserId

integer

None.

OrderId

integer

None.

TotalAmount

decimal number

None.

AmountReceived

decimal number

None.

DistributorId

integer

None.

PaymentTypes

Collection of PaymentType

None.

PaymentProofs

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "BusinessId": 1,
  "LoginUserId": 2,
  "OrderId": 3,
  "TotalAmount": 4.0,
  "AmountReceived": 5.0,
  "DistributorId": 6,
  "PaymentTypes": [
    {
      "PaymentTypeId": 1,
      "Amount": 2.0
    },
    {
      "PaymentTypeId": 1,
      "Amount": 2.0
    }
  ],
  "PaymentProofs": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<OrderPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model.Payment">
  <AmountReceived>5</AmountReceived>
  <BusinessId>1</BusinessId>
  <DistributorId>6</DistributorId>
  <LoginUserId>2</LoginUserId>
  <OrderId>3</OrderId>
  <PaymentProofs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PaymentProofs>
  <PaymentTypes>
    <PaymentType>
      <Amount>2</Amount>
      <PaymentTypeId>1</PaymentTypeId>
    </PaymentType>
    <PaymentType>
      <Amount>2</Amount>
      <PaymentTypeId>1</PaymentTypeId>
    </PaymentType>
  </PaymentTypes>
  <TotalAmount>4</TotalAmount>
</OrderPayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "2025/06/22 11:24:04",
  "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>