POST orders/payments

Request Information

URI Parameters

None.

Body Parameters

PaymentPOST
NameDescriptionTypeAdditional information
Amount

decimal number

None.

OrderId

integer

None.

EcentricResponse

PaymentEcentricPOST

None.

ModifiedBy

string

None.

PaymentDate

date

None.

PaymentTypeId

integer

None.

PaymentRef

string

None.

Request Formats

application/json, text/json

Sample:
{
  "amount": 1.0,
  "orderId": 2,
  "ecentricResponse": {
    "amount": 1,
    "checksum": "sample string 2",
    "failureMessage": "sample string 3",
    "merchantReference": "sample string 4",
    "result": "sample string 5",
    "transactionDetails": [
      {
        "amount": 1,
        "paymentService": "sample string 2",
        "responseDetail": {
          "clientMessage": "sample string 1",
          "code": "sample string 2",
          "description": "sample string 3",
          "source": "sample string 4"
        },
        "transactionId": "sample string 3",
        "transactionStatus": "sample string 4"
      },
      {
        "amount": 1,
        "paymentService": "sample string 2",
        "responseDetail": {
          "clientMessage": "sample string 1",
          "code": "sample string 2",
          "description": "sample string 3",
          "source": "sample string 4"
        },
        "transactionId": "sample string 3",
        "transactionStatus": "sample string 4"
      }
    ],
    "transactionId": "sample string 6"
  },
  "modifiedBy": "sample string 3",
  "paymentDate": "2024-02-20T23:50:21.3613187+02:00",
  "paymentTypeId": 5,
  "paymentRef": "sample string 6"
}

application/xml, text/xml

Sample:
<PaymentPOST xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/myREST.Models.Orders">
  <Amount>1</Amount>
  <EcentricResponse>
    <Amount>1</Amount>
    <Checksum>sample string 2</Checksum>
    <FailureMessage>sample string 3</FailureMessage>
    <MerchantReference>sample string 4</MerchantReference>
    <Result>sample string 5</Result>
    <TransactionDetails>
      <PaymentEcentricDetailsPOST>
        <Amount>1</Amount>
        <PaymentService>sample string 2</PaymentService>
        <ResponseDetail>
          <ClientMessage>sample string 1</ClientMessage>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <Source>sample string 4</Source>
        </ResponseDetail>
        <TransactionId>sample string 3</TransactionId>
        <TransactionStatus>sample string 4</TransactionStatus>
      </PaymentEcentricDetailsPOST>
      <PaymentEcentricDetailsPOST>
        <Amount>1</Amount>
        <PaymentService>sample string 2</PaymentService>
        <ResponseDetail>
          <ClientMessage>sample string 1</ClientMessage>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <Source>sample string 4</Source>
        </ResponseDetail>
        <TransactionId>sample string 3</TransactionId>
        <TransactionStatus>sample string 4</TransactionStatus>
      </PaymentEcentricDetailsPOST>
    </TransactionDetails>
    <TransactionId>sample string 6</TransactionId>
  </EcentricResponse>
  <ModifiedBy>sample string 3</ModifiedBy>
  <OrderId>2</OrderId>
  <PaymentDate>2024-02-20T23:50:21.3613187+02:00</PaymentDate>
  <PaymentRef>sample string 6</PaymentRef>
  <PaymentTypeId>5</PaymentTypeId>
</PaymentPOST>

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

Response Information

Resource Description

Collection of integer

Response Formats

application/json, text/json

Sample:
[
  1,
  2
]

application/xml, text/xml

Sample:
<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <int>1</int>
  <int>2</int>
</ArrayOfint>