Partially update a payment.
PATCH
/orders/{direction}/{orderID}/payments/{paymentID}
200Description
PUT is not a supported method for payments due to the implications associated with modifying certain properties. Patch is only permitted on certain properties that vary depending on order status
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminShopper
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| direction | Required | string | Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| orderID | Required | string | ID of the order. | --- |
| paymentID | Required | string | ID of the payment. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| Type | string | --- | --- | PurchaseOrder, CreditCard, SpendingAccount | ||
| CreditCardID | string | --- | --- | --- | ||
| SpendingAccountID | string | --- | --- | --- | ||
| Description | string | --- | 2000 characters | --- | ||
| Amount | number | float | --- | --- | ||
| Accepted | boolean | --- | --- | --- | ||
| OrderReturnID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| Type | string | --- | --- | PurchaseOrder, CreditCard, SpendingAccount | ||
| DateCreated | Read Only | string | date-time | --- | --- | |
| CreditCardID | string | --- | --- | --- | ||
| SpendingAccountID | string | --- | --- | --- | ||
| Description | string | --- | 2000 characters | --- | ||
| Currency | Read Only | string | --- | --- | --- | |
| Amount | number | float | --- | --- | ||
| Accepted | boolean | --- | --- | --- | ||
| OrderReturnID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Transactions | Read Only | array | --- | --- | --- | |