POST /orders/{orderId}
Refund, Cancel, Capture
Method: POST
URI:
- /orders/{orderId}/transactions/{transactionId}/refund
- /orders/{orderId}/transactions/{transactionId}/cancel
- /orders/{orderId}/transactions/{transactionId}/capture
Parent Error Code:
14000 "Error while creating transaction."
The HTTP Status is always: 400 Bad Request
| Field | Type | Expectation | HTTP Status | Code |
|---|---|---|---|---|
| orderId | String | A valid order identifier | 400 | 12101 |
| transactionId | String | A valid transaction identifier | 400 | 14101 |
Parent Error Code:
14000 "Error while creating transaction."
The HTTP Status is always: 400 Bad Request
| Field | Type | Required | Value range | Length | Expectation | Code |
|---|---|---|---|---|---|---|
| initialAmount | Number | Yes | Number greater than min. authorizing amount in cents and less then 9999999 | Mandatory number greater than min. authorizing amount in cents and less then 9999999 | 12200, 12201,14200, 14201 | |
| currency | String | Yes | Dependent on payment method and merchant configuration | 3 | Currency code in the range of ISO_4217 | 12202, 12203 |
| description | No | {1 - 128} | String between 1 and 128 characters | 12217 | ||
| basket | Array[item] | Ratepay | Array of type item | 12219, 12220 | ||
| item.name | String | Yes, when basket is present | {1 - 128} | Mandatory string between 1 and 128 characters | 12221, 12222 | |
| item.articleNumber | String | Yes, when basket is present | {1 - 255} | Mandatory string between 1 and 255 characters | 12223, 12224 | |
| item.totalPrice | Number | Yes, when basket is present | Number between min. item total price amount in cents and 9999999 | Mandatory number between min. item total price amount in cents and 9999999 | 12225, 12226 | |
| item.totalPriceWithTax | Number | Yes, when basket is present | long; Greater then item.totalPrice | Mandatory number greater than item total price | 12227, 12228 | |
| item.tax | Number | Yes, when basket is present | Number between 0 and 100 | Mandatory number between 0 and 100 | 12229, 12230 | |
| item.unitPrice | Number | Yes, when basket is present | Number between min. item unit price amount in cents and 9999999 | Mandatory number between min. item unit price amount in cents and 9999999 | 12231, 12232 | |
| item.unitPriceWithTax | Number | Yes, when basket is present | Number greater than item.unitPrice | Mandatory number greater than item unit price in cents. | 12233, 12234 | |
| item.quantity | Number | Yes, when basket is present | Number greater than 1 | Mandatory number greater than 1 | 12235, 12236 |