Sitecore OrderCloud Documentation

docs

Portal login

Partially update a cart payment.

PATCH

/cart/payments/{paymentID}

200

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
paymentIDRequiredstringID of the payment.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Typestring------PurchaseOrder, CreditCard, SpendingAccount
CreditCardIDstring---------

SpendingAccountIDstring---------

Descriptionstring---2000 characters---
Amountnumberfloat------

Acceptedboolean---------

OrderReturnIDstring---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Typestring------PurchaseOrder, CreditCard, SpendingAccount
DateCreatedRead Onlystringdate-time------
CreditCardIDstring---------

SpendingAccountIDstring---------

Descriptionstring---2000 characters---
CurrencyRead Onlystring---------

Amountnumberfloat------

Acceptedboolean---------

OrderReturnIDstring---------

xpobject---------
TransactionsRead Onlyarray---------

Partially update a cart payment.

PATCH

/cart/payments/{paymentID}

200

Roles

At least one of the roles below is required to access this endpoint.

FullAccessShopper

Parameters

NameTypeDescriptionPossible Values
paymentIDRequiredstringID of the payment.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Typestring------PurchaseOrder, CreditCard, SpendingAccount
CreditCardIDstring---------

SpendingAccountIDstring---------

Descriptionstring---2000 characters---
Amountnumberfloat------

Acceptedboolean---------

OrderReturnIDstring---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Typestring------PurchaseOrder, CreditCard, SpendingAccount
DateCreatedRead Onlystringdate-time------
CreditCardIDstring---------

SpendingAccountIDstring---------

Descriptionstring---2000 characters---
CurrencyRead Onlystring---------

Amountnumberfloat------

Acceptedboolean---------

OrderReturnIDstring---------

xpobject---------
TransactionsRead Onlyarray---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore