Aurora API: Order Void

The Order Void API method allows you void an order payment transaction.

This article provides an example request, along with a response, to get you started.

Order Void

Add

Deferred: No

Example Request

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <Order>
                <Void>
                    <Add>
                        <OrderID>606002410</OrderID>
                        <PaymentTransactions>
                            <TransactionId>1681262</TransactionId>
                        </PaymentTransactions>
                    </Add>
                </Void>
            </Order>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response

<?xml version="1.0" encoding="utf-8"?><AuroraResponseEnvelope>
  <Header>
    <Version>head</Version>
    <Timestamp>2021-12-21T11:33:35+00:00</Timestamp>
    <RequestDetails>
      <URL>/head</URL>
    </RequestDetails>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <Transaction>
          <TransactionID>1681261</TransactionID>
          <Amount>7.95</Amount>
          <Display>1</Display>
          <NameOnCard/>
          <CardNumber>0</CardNumber>
          <CardExpiry/>
          <CardType>klarna</CardType>
          <Type>VOID</Type>
          <Status>OK</Status>
          <StatusDetails/>
          <Provider>klarna</Provider>
          <ProviderVendorTxCode>d5b9eec9-8897-4d64-8261-2221434c1afa</ProviderVendorTxCode>
          <ProviderTxID/>
          <ProviderSecurityKey/>
          <ProviderAuthNumber/>
          <ProviderRelatedVendorTxCode>8897-4d64-8261-2221434c1afa-d5b9eec9 </ProviderRelatedVendorTxCode>
          <ProviderAVSCV2/>
          <ProviderAddressResult/>
          <ProviderPostCodeResult/>
          <ProviderCV2Result/>
          <Provider3DSecureStatus/>
          <DateCreated>2021-12-21 11:33:35</DateCreated>
          <AdditionalFields>
            <AdditionalField>
              <FieldID>1601</FieldID>
              <FieldName>klarnaOrderId</FieldName>
              <FieldValue>d5b9eec9-8897-4d64-8261-2221434c1afa</FieldValue>
            </AdditionalField>
          </AdditionalFields>
        </Transaction>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

FieldValueAPI VersionDescriptionRequired
OrderIDInteger1.5+The order within which to create a new refund.Yes
PaymentTransactionsContainer1.5+The payment transactions to be voided.Yes
PaymentTransactions.TransactionIdInteger1.5+Must be a valid transaction.Yes

Validation

A payment transaction can only be voided using the Aurora API where it's of type DEFERRED and has not already been fully or partially released.