Create a new payment.
POST
/orders/{direction}/{orderID}/paymentsDescription
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
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. | --- |
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 | --- | --- | --- | |
Create a new payment.
POST
/orders/{direction}/{orderID}/paymentsDescription
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
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. | --- |
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 | --- | --- | --- | |