POST Orders/Payment

GetPayments

Request Information

URI Parameters

None.

Body Parameters

GetPaymentRequest
NameDescriptionTypeAdditional information
ID

integer

None.

OrderID

integer

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "OrderID": 2,
  "Lang": "sample string 3",
  "StoreID": 4
}

application/xml, text/xml

Sample:
<GetPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">4</StoreID>
  <ID>1</ID>
  <OrderID>2</OrderID>
</GetPaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Payment
NameDescriptionTypeAdditional information
ID

integer

None.

OrderID

integer

None.

Date

date

None.

MeansID

integer

None.

Amount

The amount received with this payment

decimal number

None.

TransactionId

The id of the payment transaction as issued by a payment processor

string

None.

TransactionStatus

string

None.

Observations

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "OrderID": 2,
  "Date": "2025-12-06T05:42:13.2857729+01:00",
  "MeansID": 4,
  "Amount": 5.0,
  "TransactionId": "sample string 6",
  "TransactionStatus": "sample string 7",
  "Observations": "sample string 8"
}

application/xml, text/xml

Sample:
<Payment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <Amount>5</Amount>
  <Date>2025-12-06T05:42:13.2857729+01:00</Date>
  <ID>1</ID>
  <MeansID>4</MeansID>
  <Observations>sample string 8</Observations>
  <OrderID>2</OrderID>
  <TransactionId>sample string 6</TransactionId>
  <TransactionStatus>sample string 7</TransactionStatus>
</Payment>