POST v3/baskets/{id}/custom-payments
Add a single custom payment to a basket
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
Required |
Body Parameters
NewCustomPaymentName | Description | Type | Additional 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:
<NewCustomPayment> <Amount>1</Amount> <PaymentTypeId>sample string 2</PaymentTypeId> </NewCustomPayment>
Response Information
Resource Description
Collection of CustomPaymentName | Description | Type | Additional 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>