refund-api.md

Refund API

Refund objects allow you to unapply a payment applied to an invoice or debit memo and, in some instances, refund the charge to the credit or debit card that was originally charged.

Class Name

RefundAPI

Methods

• Create refund
• Get refund

Create Refund

Creates a new refund.

Refund refund = zuoraClient.refunds().create(params);

Parameters

Parameter	Type	Tags	Description
params	RefundCreateRequest	Required	Refund create request.

Response Type

Refund

Example

RefundCreateRequest params = RefundCreateRequest.builder()
        .amount(10.0d)
        .account("account_id8")
        .currency("USD")
        .external(true)
        .build();

Refund refund = zuoraClient.refunds().create(params);

Get Refund

Retrieves a refund by ID.

Refund refund = zuoraClient.refunds().get(id);

Parameters

Parameter	Type	Tags	Description
id	String	Required	The unique identifier of a refund.

Response Type

Refund

Example

Refund refund = zuoraClient.refunds().get(id);