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

Add a single custom payment to a basket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

NewCustomPayment
NameDescriptionTypeAdditional information
Amount

decimal number

None.

PaymentTypeId

string

None.

PaymentAttributes

Collection of NewCustomPaymentAttribute

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:
{
  "amount": 1.0,
  "paymentTypeId": "sample string 2"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

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:

The response/request for text/xml format is no longer supported for this endpoint.