post https://example.com/orders//transactions//annul/
Annul authorization annuls an authorization. This cancels the order before it has been finalized.
Depending on the payment method this service has different results. See the following table for information about different payment method types.
Payment method | Result |
---|---|
Invoice/installment | The credit authorization will be cancelled. No invoice will be sent out for this order. |
Credit/Debit Cards | The authorization will be reversed. A credit/debit card authorization can only be annulled in its entirety. Partial annulments are not supported. |
Internet Banks | This method has no effect because internet banks are automatically finalized (there is no authorization). |
HTTP Request
POST /orders/{orderId}/transactions/{transactionId}/annul/{totalAmount}
POST /transactions/{transactionId}/annul/{totalAmount}
REQUEST PARAMETERS
Property | Type | Description |
---|---|---|
transactionId required | guid | The authorization transaction id you received from Paynova. |
totalAmount required | decimal | The total amount to annul. Conditions: If you need to partially annul a line item please refer to the Update order line item call. See the Payment Methods page for more information. |
lineItems conditional | lineitem | The line items which are being annulled. Conditions: > Line items are only required when annulling an amount less than the original transaction amount. > Line items are only allowed when the original order was a detailed order. See Orders for more information on detailed vs. simple orders. |
customData conditional | customData | Collection of up to 10 private key-value data fields to store as meta-data on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object. Conditions: > We do not use this data for processing transactions. |
RESPONSE PARAMETERS
Property | Type | Description |
---|---|---|
status required | status | API operation status. Example: { "isSuccess":true, "errorNumber":0, "statusKey":"SUCCESS", "statusMessage":"The operation was successful." } |