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 Gateway Reconciliation API

Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway. For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report.You can complete the following Gateway Reconciliation tasks through API:- [Settle a payment](/api-references/api/operation/POST_SettlePayment/)- [Reject a payment](/api-references/api/operation/POST_RejectPayment/)- [Reverse a payment](/api-references/api/operation/POST_ReversePayment/)- [Reconcile a refund](/api-references/api/operation/POST_ReconcileRefund/)

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

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

4 operations 4 paths 8 schemas 4 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 4

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

Payment Gateway Reconciliation 4

Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway. For examp…

POST
/v1/gateway-settlement/payments/{payment-key}/settle
Settle a payment
POST_SettlePayment 9 params → 200
POST
/v1/gateway-settlement/payments/{payment-key}/reject
Reject a payment
POST_RejectPayment 9 params → 200
POST
/v1/gateway-settlement/payments/{payment-key}/chargeback
Reverse a payment
POST_ReversePayment 9 params → 200
POST
/v1/refunds/{refund-key}/reconcile
Reconcile a refund
POST_ReconcileRefund 9 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are POSTSettlePaymentResponse (40 properties), POSTRejectPaymentResponse (37 properties), POSTReconcileRefundResponse (37 properties), POSTReversePaymentResponse (37 properties). Each schema is shown below with its type and property counts.

POSTRejectPaymentResponse
object
37 properties
POSTReconcileRefundResponse
object
37 properties
POSTSettlePaymentRequest
object
4 properties
POSTSettlePaymentResponse
object
40 properties
POSTReconcileRefundRequest
object
5 properties
POSTReversePaymentResponse
object
37 properties
POSTRejectPaymentRequest
object
7 properties
POSTReversePaymentRequest
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-payment-gateway-reconciliation-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