Skip to main content

Refund Credit Balances

Zuora

Refund Credit Balances

  1. Last updated
  2. Save as PDF

Overview

Refunding a credit balance gives money back to a customer from the customer's credit balance. Of course, this requires that the customer must have a credit balance.

Issuing a refund via the SOAP API is similar to issuing a refund from the Zuora application.

The Refund Process

When refunding money from a customer's credit balance:

  • A refund record is created
  • Funds are given to the customer
  • The customer's credit balance is lowered by the amount of the refund

You can refund all or part of a customer's credit balance with one API call, as follows:

  1. Create a Refund object.
  2. Specify the Account ID of the customer.
  3. Specify the amount you wish to refund.
  4. Set the SourceType to CreditBalance.
  5. Set the Type to either External or Electronic. If you choose External, you can optionally specify a payment method, or just use the default. If you choose Electronic, you must specify the ID of a payment method.

SOAP Examples

External refund

This example issues an external refund.

<ns1:create xmlns:ns1="http://api.zuora.com/">
   <ns1:zObjects xmlns:ns2="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:Refund">
      <ns2:AccountId>402892c72b9e3319012b9e34b88e0001</ns2:AccountId>
      <ns2:Amount>10</ns2:Amount>
      <ns2:SourceType>CreditBalance</ns2:SourceType>
      <ns2:Type>External</ns2:Type>
      <ns2:MethodType>Check</ns2:MethodType>
   </ns1:zObjects>
</ns1:create>

Electronic refund

This example issues an electronic refund.

<ns1:create xmlns:ns1="http://api.zuora.com/">
   <ns1:zObjects xsi:type="ns2:Refund" xmlns:ns2="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ns2:AccountId>2c92c0f83ddb61af013ddc5736b1025a</ns2:AccountId>
      <ns2:Amount>10</ns2:Amount>
      <ns2:SourceType>CreditBalance</ns2:SourceType>
      <ns2:Type>Electronic</ns2:Type>
      <ns2:PaymentMethodID>2c92c0f83dfa5201013dfa6656ff2b8b</ns2:PaymentMethodID>
   </ns1:zObjects>
</ns1:create>