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

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time.You can use the [Create authorization](/api-references/api/operation/POST_CreateAuthorization/) operation to authorize a payment amount before capturing the payment. Subsequently, you can use [Create a payment](/api-references/api/operation/POST_CreatePayment) or [Create an order](/api-references/api/operation/POST_Order/) to capture the authorized funds, or use [Cancel authorization](/api-references/api/operation/POST_CancelAuthorization) to cancel the authorization.

Zuora Payment Authorization 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 Authorization. The published artifact set on APIs.io includes an OpenAPI specification.

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

2 operations 2 paths 4 schemas 2 POST

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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Authorization 2

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. You can use the [Create authoriz…

POST
/v1/payment-methods/{payment-method-id}/authorize
Create authorization
POST_CreateAuthorization 9 params → 200
POST
/v1/payment-methods/{payment-method-id}/voidAuthorize
Cancel authorization
POST_CancelAuthorization 9 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are POSTDelayAuthorizeCapture (9 properties), POSTAuthorizeResponse (9 properties), POSTVoidAuthorize (6 properties), POSTVoidAuthorizeResponse (5 properties). Each schema is shown below with its type and property counts.

POSTVoidAuthorize
object
6 properties 2 required
POSTAuthorizeResponse
object
9 properties
POSTDelayAuthorizeCapture
object
9 properties 2 required
POSTVoidAuthorizeResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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