POST v1/Orders/{orderId}/Payments

Adds the specified payment.

Request Information

Requires Authorization!

URI Parameters

Name	Description	Type	Additional information
orderId	The order identifier.	integer	Required.

Body Parameters

The order payment.

PaymentChanges

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	Must be 0
ShopId	Gets or sets the shop identifier.	integer	None.
ShopOwnerId	Gets or sets the ShopOwnerId identifier.	integer	Required
Amount	The payment amount.	decimal number	Required
PaymentDate	Gets or sets the PaymentDate.	date	None.
CurrencyId	Gets or sets the currency identifier.	integer	Required
CurrencyCode	Gets or sets the currency code.	string	None.
Note	Gets or sets the note.	string	Max length: 1000
AccountNumber	Gets or sets the AccountNumber.	string	Max length: 50
AccountName	Gets or sets the AccountName.	string	Max length: 100
TransactionId	Gets or sets the TransactionId.	string	Max length: 100
CreationDate	Gets or sets the CreationDate.	date	Required
ImportSource	Gets or sets the ImportSource.	string	Max length: 50
PaymentTypeId	Gets or sets the payment type identifier.	integer	None.
PaymentAllocations		Collection of PaymentAllcation	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ShopId": 1,
  "ShopOwnerId": 2,
  "Amount": 3.0,
  "PaymentDate": "2021-12-02T20:19:34.591609+01:00",
  "CurrencyId": 4,
  "CurrencyCode": "sample string 5",
  "Note": "sample string 6",
  "AccountNumber": "sample string 7",
  "AccountName": "sample string 8",
  "TransactionId": "sample string 9",
  "CreationDate": "2021-12-02T20:19:34.591609+01:00",
  "ImportSource": "sample string 11",
  "PaymentTypeId": 1,
  "PaymentAllocations": [
    {
      "OrderId": 1,
      "InvoiceId": 1,
      "AllocatedAmount": 1.0
    },
    {
      "OrderId": 1,
      "InvoiceId": 1,
      "AllocatedAmount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<PaymentChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ShopId>1</ShopId>
  <ShopOwnerId>2</ShopOwnerId>
  <Amount>3</Amount>
  <PaymentDate>2021-12-02T20:19:34.591609+01:00</PaymentDate>
  <CurrencyId>4</CurrencyId>
  <CurrencyCode>sample string 5</CurrencyCode>
  <Note>sample string 6</Note>
  <AccountNumber>sample string 7</AccountNumber>
  <AccountName>sample string 8</AccountName>
  <TransactionId>sample string 9</TransactionId>
  <CreationDate>2021-12-02T20:19:34.591609+01:00</CreationDate>
  <ImportSource>sample string 11</ImportSource>
  <PaymentTypeId>1</PaymentTypeId>
  <PaymentAllocations>
    <PaymentAllocations>
      <OrderId>1</OrderId>
      <InvoiceId>1</InvoiceId>
      <AllocatedAmount>1</AllocatedAmount>
    </PaymentAllocations>
    <PaymentAllocations>
      <OrderId>1</OrderId>
      <InvoiceId>1</InvoiceId>
      <AllocatedAmount>1</AllocatedAmount>
    </PaymentAllocations>
  </PaymentAllocations>
</PaymentChanges>

Response Information

Resource Description

The HttpResponseMessage object.

Payment

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	Must be 0
ShopId	Gets or sets the shop identifier.	integer	None.
ShopOwnerId	Gets or sets the ShopOwnerId identifier.	integer	Required
Amount	The payment amount.	decimal number	Required
PaymentDate	Gets or sets the PaymentDate.	date	None.
CurrencyId	Gets or sets the currency identifier.	integer	Required
CurrencyCode	Gets or sets the currency code.	string	None.
Note	Gets or sets the note.	string	Max length: 1000
AccountNumber	Gets or sets the AccountNumber.	string	Max length: 50
AccountName	Gets or sets the AccountName.	string	Max length: 100
TransactionId	Gets or sets the TransactionId.	string	Max length: 100
CreationDate	Gets or sets the CreationDate.	date	Required
ImportSource	Gets or sets the ImportSource.	string	Max length: 50
PaymentTypeId	Gets or sets the payment type identifier.	integer	None.
PaymentAllocations		Collection of PaymentAllcation	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ShopId": 1,
  "ShopOwnerId": 2,
  "Amount": 3.0,
  "PaymentDate": "2021-12-02T20:19:34.591609+01:00",
  "CurrencyId": 4,
  "CurrencyCode": "sample string 5",
  "Note": "sample string 6",
  "AccountNumber": "sample string 7",
  "AccountName": "sample string 8",
  "TransactionId": "sample string 9",
  "CreationDate": "2021-12-02T20:19:34.591609+01:00",
  "ImportSource": "sample string 11",
  "PaymentTypeId": 1,
  "PaymentAllocations": [
    {
      "OrderId": 1,
      "InvoiceId": 1,
      "AllocatedAmount": 1.0
    },
    {
      "OrderId": 1,
      "InvoiceId": 1,
      "AllocatedAmount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<Payment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ShopId>1</ShopId>
  <ShopOwnerId>2</ShopOwnerId>
  <Amount>3</Amount>
  <PaymentDate>2021-12-02T20:19:34.591609+01:00</PaymentDate>
  <CurrencyId>4</CurrencyId>
  <CurrencyCode>sample string 5</CurrencyCode>
  <Note>sample string 6</Note>
  <AccountNumber>sample string 7</AccountNumber>
  <AccountName>sample string 8</AccountName>
  <TransactionId>sample string 9</TransactionId>
  <CreationDate>2021-12-02T20:19:34.591609+01:00</CreationDate>
  <ImportSource>sample string 11</ImportSource>
  <PaymentTypeId>1</PaymentTypeId>
  <PaymentAllocations>
    <PaymentAllocations>
      <OrderId>1</OrderId>
      <InvoiceId>1</InvoiceId>
      <AllocatedAmount>1</AllocatedAmount>
    </PaymentAllocations>
    <PaymentAllocations>
      <OrderId>1</OrderId>
      <InvoiceId>1</InvoiceId>
      <AllocatedAmount>1</AllocatedAmount>
    </PaymentAllocations>
  </PaymentAllocations>
</Payment>