DoVoid API Operation (SOAP)

Void an order or an authorization.

DoVoid Request Message

DoVoidRequestType Diagram

Note Not all fields shown are available for use. Use only the fields described in the documentation.

DoVoid Request Fields

Field

Description

AuthorizationID

xs:string

(Required) Original authorization ID specifying the authorization to void or, to void an order, the order ID.

Important: If you are voiding a transaction that has been reauthorized, use the ID from the original authorization, and not the reauthorization.

Character length and limitations: 19 single-byte characters

Note

xs:string

(Optional) Informational note about this void that is displayed to the buyer in email and in their transaction history.

Character length and limitations: 255 single-byte characters

MsgSubId

xs:string

(Optional) A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: 38 single-byte characters

This field is available since version 94.0.

DoVoid Response Message

DoVoidResponseType Diagram

Note Not all fields shown are available for use. Use only the fields described in the documentation.

DoVoidResponse Fields

Field Description

AuthorizationID

xs:string

Authorization identification number you specified in the request.

Character length and limitations: 19 single-byte characters

MsgSubId

xs:string

A message ID used for idempotence to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: 38 single-byte characters

This field is available since version 94.0.