GET v3/baskets/{id}/custom-payments

Return the details of all custom payments added to a basket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomPayment
NameDescriptionTypeAdditional information
Name

string

None.

Amount

decimal number

None.

Attributes

Collection of CustomPaymentAttribute

None.

Response Formats

application/json

Sample:
[
  {
    "name": "sample string 1",
    "amount": 2.0,
    "attributes": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ]
  },
  {
    "name": "sample string 1",
    "amount": 2.0,
    "attributes": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ]
  }
]

text/xml

Sample:
<CustomPayments>
  <CustomPayment>
    <Name>sample string 1</Name>
    <Amount>2</Amount>
    <Attributes>
      <CustomPaymentAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </CustomPaymentAttribute>
      <CustomPaymentAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </CustomPaymentAttribute>
    </Attributes>
  </CustomPayment>
  <CustomPayment>
    <Name>sample string 1</Name>
    <Amount>2</Amount>
    <Attributes>
      <CustomPaymentAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </CustomPaymentAttribute>
      <CustomPaymentAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </CustomPaymentAttribute>
    </Attributes>
  </CustomPayment>
</CustomPayments>