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 Payments API

Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds.For more information about payments, see Payments.

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

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

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

15 operations 13 paths 38 schemas 1 DELETE6 GET3 POST5 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 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 6 GET, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Payments 15

Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments .

POST
/v1/payments
Create a payment
POST_CreatePayment 8 params → 200
GET
/v1/payments
List payments
GET_RetrieveAllPayments 24 params → 200
PUT
/v1/payments/{paymentId}
Update a payment
PUT_UpdatePayment 8 params → 200
GET
/v1/payments/{paymentKey}
Retrieve a payment
GET_Payment 7 params → 200
DELETE
/v1/payments/{paymentKey}
Delete a payment
DELETE_Payment 7 params → 200
PUT
/v1/payments/{paymentKey}/transfer
Transfer a payment
PUT_TransferPayment 8 params → 200
PUT
/v1/payments/{paymentKey}/apply
Apply a payment
PUT_ApplyPayment 8 params → 200
PUT
/v1/payments/{paymentKey}/cancel
Cancel a payment
PUT_CancelPayment 7 params → 200
GET
/v1/payments/{paymentKey}/parts
List all parts of a payment
GET_PaymentParts 9 params → 200
GET
/v1/payments/{paymentKey}/parts/{partid}
Retrieve a payment part
GET_PaymentPart 8 params → 200
GET
/v1/payments/{paymentKey}/parts/{partid}/itemparts
List all payment part items
GET_PaymentItemParts 10 params → 200
GET
/v1/payments/{paymentKey}/parts/{partid}/itemparts/{itempartid}
Retrieve a payment part item
GET_PaymentItemPart 9 params → 200
POST
/v1/payments/{paymentKey}/refunds
Refund a payment
POST_RefundPayment 9 params → 200
PUT
/v1/payments/{paymentKey}/unapply
Unapply a payment
PUT_UnapplyPayment 8 params → 200
POST
/v1/payments/{paymentKey}/refunds/unapply
Refund a payment with auto-unapplying
POST_RefundPaymentwithAutoUnapply 9 params → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are GETPaymentItemPartType (11 properties), GETPaymentPartType (10 properties), GETPaymentItemPartTypewithSuccess (10 properties), GETPaymentPartTypewithSuccess (9 properties). Each schema is shown below with its type and property counts.

PaymentDebitMemoApplicationCreateRequestType
object
3 properties 1 required
UnapplyPaymentType
object
3 properties
GETPaymentPartType
object
10 properties
GETRefundPaymentType
PaymentObjectNSFields
object
Container for Payment fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
PaymentWithCustomRatesType
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
PaymentDebitMemoApplicationItemCreateRequestType
object
3 properties 1 required
PaymentInvoiceApplicationApplyRequestType
object
4 properties 1 required
GETPaymentPartTypewithSuccess
object
9 properties
TransferPaymentType
object
1 property
PaymentDebitMemoApplicationApplyRequestType
object
4 properties 1 required
GETARPaymentTypeWithPaymentOption
RefundObjectCustomFields
object
Container for custom fields of a Refund object.
PaymentDebitMemoApplicationUnapplyRequestType
object
4 properties 1 required
GETARPaymentTypewithSuccess
GETPaymentItemPartTypewithSuccess
object
10 properties
PaymentInvoiceApplicationCreateRequestType
object
3 properties 1 required
PaymentInvoiceApplicationItemUnapplyRequestType
object
3 properties 1 required
GETPaymentPartsCollectionType
object
3 properties
PaymentInvoiceApplicationItemApplyRequestType
object
3 properties 1 required
PaymentInvoiceApplicationItemCreateRequestType
object
3 properties 1 required
PostRefundType
CreatePaymentType
GETPaymentItemPartType
object
11 properties
ApplyPaymentType
object
3 properties
PaymentDebitMemoApplicationItemApplyRequestType
object
3 properties 1 required
GETARPaymentType
PostRefundwithAutoUnapplyType
PaymentCollectionResponseType
object
3 properties
PaymentSchedulePaymentOptionFields
object
2 properties
GETRefundPaymentTypeAutoUnapply
PaymentDebitMemoApplicationItemUnapplyRequestType
object
3 properties 1 required
PaymentObjectCustomFields
object
Container for custom fields of a Payment object.
GETPaymentItemPartCollectionType
object
3 properties
UpdatePaymentType
PaymentInvoiceApplicationUnapplyRequestType
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-payments-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