How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zuora

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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 3.2.0, at version 2023-12-15.

Requests are made against a single base URL, https://rest.zuora.com/.

15 operations 13 paths 38 schemas 1 DELETE6 GET3 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
Contact
docs@zuora.com
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 7 params body → 200
GET
/v1/payments
List payments
GET_RetrieveAllPayments 24 params → 200
PUT
/v1/payments/{paymentId}
Update a payment
PUT_UpdatePayment 7 params body → 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 7 params body → 200
PUT
/v1/payments/{paymentKey}/apply
Apply a payment
PUT_ApplyPayment 7 params body → 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 8 params body → 200
PUT
/v1/payments/{paymentKey}/unapply
Unapply a payment
PUT_UnapplyPayment 7 params body → 200
POST
/v1/payments/{paymentKey}/refunds/unapply
Refund a payment with auto-unapplying
POST_RefundPaymentwithAutoUnapply 8 params body → 200

Schemas 38

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

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

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
AE Profile APIs.io
Zuora Accounting Codes API
AE Profile APIs.io
Zuora Accounting Periods API
AE Profile APIs.io
Zuora Accounts API
AE Profile APIs.io
Zuora Actions API
AE Profile APIs.io
Zuora Aggregate Queries API
AE Profile APIs.io
Zuora API Health API
AE Profile APIs.io
Zuora Attachments API
AE Profile APIs.io
Zuora Bill Run API
AE Profile APIs.io
Zuora Bill Run Health API
AE Profile APIs.io
Zuora Billing Documents API
AE Profile APIs.io
Zuora Billing Preview Run API
AE Profile APIs.io
#Payments
← Back to Z APIs
API Details
ID
zuora:zuora-payments-api
Server
https://rest.zuora.com/
Docs
https://developer.zuora.com/v1-api-reference/introduction
Provider
Zuora
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zuora-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zuora-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zuora Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.