Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Refunds API

Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check). In addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.

Zuora Refunds API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Refunds. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

9 operations 8 paths 13 schemas 1 DELETE6 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 6 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Refunds 9

Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora…

GET
/v1/refunds
List refunds
GET_Refunds 21 params → 200
PUT
/v1/refunds/{refundId}
Update a refund
PUT_UpdateRefund 8 params → 200
GET
/v1/refunds/{refundKey}
Retrieve a refund
GET_Refund 7 params → 200
DELETE
/v1/refunds/{refundKey}
Delete a refund
DELETE_Refund 7 params → 200
PUT
/v1/refunds/{refundKey}/cancel
Cancel a refund
PUT_CancelRefund 7 params → 200
GET
/v1/refunds/{refundKey}/parts
List all parts of a refund
GET_RefundParts 7 params → 200
GET
/v1/refunds/{refundKey}/parts/{refundpartid}
Retrieve a refund part
GET_RefundPart 8 params → 200
GET
/v1/refunds/{refundKey}/parts/{refundpartid}/itemparts
List all refund part items
GET_RefundItemParts 10 params → 200
GET
/v1/refunds/{refundKey}/parts/{refundpartid}/itemparts/{itempartid}
Retrieve a refund part item
GET_RefundItemPart 9 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RefundPartResponseType (10 properties), GETRefundItemPartType (10 properties), GETRefundItemPartTypewithSuccess (9 properties), RefundPartResponseTypewithSuccess (9 properties). Each schema is shown below with its type and property counts.

GETRefundItemPartTypewithSuccess
object
9 properties
GETRefundItemPartType
object
10 properties
CommonResponseType
object
3 properties
RefundObjectNSFields
object
Container for Refund fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
PUTRefundType
RefundObjectCustomFields
object
Container for custom fields of a Refund object.
GETRefundItemPartCollectionType
object
3 properties
RefundPartResponseType
object
10 properties
RefundPartResponseTypewithSuccess
object
9 properties
GETRefundTypewithSuccess
GETRefundCollectionType
object
3 properties
GETRefundPartCollectionType
object
2 properties
GETRefundType

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-refunds-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API