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 Payment Runs API

Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH.For more information about payment runs, see Payment Runs.

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

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

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

7 operations 4 paths 12 schemas 1 DELETE4 GET1 POST1 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Runs 7

Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH. For more information about payment runs, see Payment Runs .

POST
/v1/payment-runs
Create a payment run
POST_PaymentRun 8 params → 200
GET
/v1/payment-runs
List payment runs
GET_PaymentRuns 15 params → 200
PUT
/v1/payment-runs/{paymentRunKey}
Update a payment run
PUT_PaymentRun 8 params → 200
GET
/v1/payment-runs/{paymentRunKey}
Retrieve a payment run
GET_PaymentRun 7 params → 200
DELETE
/v1/payment-runs/{paymentRunKey}
Delete a payment run
DELETE_PaymentRun 5 params → 200
GET
/v1/payment-runs/{paymentRunKey}/summary
Retrieve a payment run summary
GET_PaymentRunSummary 5 params → 200
GET
/v1/payment-runs/{paymentRunKey}/data
Retrieve payment run data
GET_PaymentRunData 5 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GETPaymentRunType (25 properties), POSTPaymentRunRequest (16 properties), GETPaymentRunSummaryResponse (16 properties), PUTPaymentRunRequest (15 properties). Each schema is shown below with its type and property counts.

GETPaymentRunDataElementResponse
CommonResponseType
object
3 properties
GETPaymentRunDataArrayResponse
object
2 properties
GETPaymentRunSummaryResponse
object
16 properties
PUTPaymentRunRequest
object
15 properties
GETPaymentRunSummaryTotalValues
object
11 properties
POSTPaymentRunDataElementRequest
GETPaymentRunDataTransactionElementResponse
object
7 properties
PaymentObjectCustomFields
object
Container for custom fields of a Payment object.
GETPaymentRunCollectionType
object
3 properties
POSTPaymentRunRequest
object
16 properties
GETPaymentRunType
object
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-payment-runs-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