REFUND

Overview
Refunds can be created out of payments. Use this entity if you wish to issue a refund to a customer.
Refund amounts cannot exceed payment total.

If your application is configured to process credit card transactions through a merchant (PayPal, Authorize.net, etc.) refund type of CREDIT CARD can be selected to make the system attempt to process the return through your merchant.

System Entity Name
REFUND

Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES NO YES


Fields

Field Data Type Properties Description
Amount decimal required Enter the amount to be refunded
Note string  

 

PaymentItemObj PAYMENT    
PaymentItemId decimal required Enter a descriptive note for the refund.  Useful for tracking why the customer recieved a refund.
RefundTypeObj REFUND required Object in which to contain the payment the refund funds were sourced from.
RefundType string required Enter the payment ID where the refund funds were sourced from.
Status string required Object to contain the type of the refund.
VoidRefundItemId string required Enter the type of the refund.  Types can be found in the REFUND_TYPE entity.



Sample Requests
Create

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <urn:create xmlns:tns="http://schemas.xmlsoap.org/soap/encoding/" xmlns="urn:stronglytyped.soap.brmsystems.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <!--Optional:-->
         <urn:brmObjects xsi:type="REFUND">
            <!--Zero or more repetitions:-->
            <Amount>120</Amount>
        <Note>Customer Service</Note>
        <PaymentItemId>413961</PaymentItemId>
        <RefundType>LOG</RefundType>
         </urn:brmObjects>
      </urn:create>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:createResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:ErrorElementField></urn:ErrorElementField>
            <urn:Id>413974</urn:Id>
         </urn:result>
      </urn:createResponse>
   </soapenv:Body>
</soapenv:Envelope>




Update

Request

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:update xmlns="urn:stronglytyped.soap.brmsystems.com">
         <!--Optional:-->
         <urn:brmObjects xsi:type="REFUND">
            <Id>413974</Id>
            <Amount>150</Amount>
         </urn:brmObjects>
      </urn:update>
   </soapenv:Body>
</soapenv:Envelope>


Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:updateResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:ErrorElementField></urn:ErrorElementField>
            <urn:Id>413974</urn:Id>
         </urn:result>
      </urn:updateResponse>
   </soapenv:Body>
</soapenv:Envelope>

Retrieve

Request

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:retrieve xmlns="urn:stronglytyped.soap.brmsystems.com">
         <urn:brmObjectType>REFUND</urn:brmObjectType>
         <!--Zero or more repetitions:-->
         <urn:id>413974</urn:id>
      </urn:retrieve>
   </soapenv:Body>
</soapenv:Envelope>


Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:retrieveResponse>
         <urn:result xsi:type="urn:REFUND">
            <urn:Id>413974</urn:Id>
            <urn:Amount>120</urn:Amount>
            <urn:Created>2014-04-25T20:06:42.000Z</urn:Created>
            <urn:CreatedUserId>6</urn:CreatedUserId>
            <urn:Note>[25/04/2014 14:06:42 -06:00: user] Customer Service
[25/04/2014 14:08:27 -06:00: user] [25/04/2014 14:06:42 -06:00: user] Customer Service</urn:Note>
            <urn:PaymentItemId>413961</urn:PaymentItemId>
            <urn:RefundType>LOG</urn:RefundType>
            <urn:Status>ACTIVE</urn:Status>
            <urn:Updated>2014-04-25T20:08:27.000Z</urn:Updated>
            <urn:UpdatedUserId>0</urn:UpdatedUserId>
            <urn:VoidRefundItemId xsi:nil="true"/>
         </urn:result>
      </urn:retrieveResponse>
   </soapenv:Body>
</soapenv:Envelope>

Upsert

Request

 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:SessionHeader xmlns:h="urn:stronglytyped.soap.brmsystems.com" xmlns="urn:stronglytyped.soap.brmsystems.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <SessionID>cZZRIteVgWBZmWPzEXpYYZZujRhbTBuSZOGIJzKj</SessionID>
        </h:SessionHeader>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <upsert xmlns="urn:stronglytyped.soap.brmsystems.com">
            <externalIDFieldName>Id</externalIDFieldName>
            <brmObjects xsi:type="REFUND">                
                <Id>413974</Id>
                <Amount>75</Amount>    
            </brmObjects>
        </upsert>
    </s:Body>
</s:Envelope>

Response

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:h="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <h:upsertResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
         <h:result>
            <h:created>false</h:created>
            <h:ErrorCode>0</h:ErrorCode>
            <h:ErrorText></h:ErrorText>
            <h:ErrorElementField/>
            <h:Id>413974</h:Id>
         </h:result>
      </h:upsertResponse>
   </soapenv:Body>
</soapenv:Envelope>
Have more questions? Submit a request

Comments

Powered by Zendesk