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

Zuora Payment Methods API

Payment methods represents payment method details associated with a customer account.

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

This API exposes 15 operations across 11 paths, and defines 40 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 11 paths 40 schemas 2 DELETE3 GET7 POST3 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/
Resource Areas
1

Paths & Operations 15

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

Payment Methods 15

Payment methods represents payment method details associated with a customer account.

POST
/v1/payment-methods
Create a payment method
POST_PaymentMethods 7 params body → 200
POST
/v1/payment-methods/decryption
Create an Apple Pay payment method
POST_PaymentMethodsDecryption 7 params body → 200
PUT
/v1/payment-methods/{payment-method-id}
Update a payment method
PUT_PaymentMethod 7 params body → 200
GET
/v1/payment-methods/{payment-method-id}
Retrieve a payment method
GET_PaymentMethod 7 params → 200
DELETE
/v1/payment-methods/{payment-method-id}
Delete a payment method
DELETE_PaymentMethods 7 params → 200
PUT
/v1/payment-methods/{payment-method-id}/verify
Verify a payment method
PUT_VerifyPaymentMethods 5 params body → 200
PUT
/v1/payment-methods/{payment-method-id}/scrub
Scrub a payment method
PUT_ScrubPaymentMethods 7 params → 200
POST
/v1/payment-methods/{payment-method-id}/profiles
Create a stored credential profile
POST_CreateStoredCredentialProfile 8 params body → 200
GET
/v1/payment-methods/{payment-method-id}/profiles
List stored credential profiles of a payment method
GET_StoredCredentialProfiles 8 params → 200
POST
/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel
Cancel a stored credential profile
POST_CancelStoredCredentialProfile 9 params → 200
POST
/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire
Expire a stored credential profile
POST_ExpireStoredCredentialProfile 9 params → 200
POST
/payment-methods/apple-pay/domains
Register an Apple Pay domain
POST_RegisterApplePayDomain 7 params body → 200
GET
/payment-methods/apple-pay/domains
List registered Apple Pay domains
GET_ListApplePayDomains 8 params → 200
DELETE
/payment-methods/apple-pay/domains/{id}
Unregister an Apple Pay domain
DELETE_UnregisterApplePayDomain 8 params → 200
POST
/web-payments/sessions
Create a payment session
POST_CreatePaymentSession 7 params body → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CreatePaymentMethodCreditCard (14 properties), POSTPMMandateInfo (13 properties), CreatePaymentMethodACH (12 properties), POSTPaymentMethodDecryption (11 properties). Each schema is shown below with its type and property counts.

GETPaymentMethodResponsePayPal
object
3 properties
POSTCreatePaymentSessionResponse
object
1 property
PUTPMAccountHolderInfo
object
The account holder information. This field is not supported in updating Credit Card Reference Transaction payment methods.
8 properties
CreatePaymentMethodCardholderInfo
object
Container for cardholder information. This container field is required for credit card payment methods. The nested cardHolderName field is required.
9 properties 1 required
CreatePaymentMethodBankTransfer
object
11 properties
CommonResponseType
object
3 properties
GETListApplePayDomainsResponse
object
2 properties
POSTCreatePaymentSessionRequest
object
6 properties 4 required
CreateStoredCredentialProfileRequest
object
9 properties 3 required
PUTPaymentMethodResponse
object
2 properties
CreatePaymentMethodCCReferenceTransaction
object
3 properties
PaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
POSTRegisterApplePayDomainRequest
object
1 property 1 required
GetStoredCredentialProfilesResponse
object
2 properties
GETPaymentMethodResponseCreditCard
object
4 properties
GETPaymentMethodResponseBankTransfer
object
7 properties
POSTPaymentMethodRequest
PUTVerifyPaymentMethodResponseType
object
2 properties
POSTRegisterApplePayDomainResponse
object
4 properties
GETPMAccountHolderInfo
object
The account holder information.
9 properties
GETPaymentMethodResponseACH
object
5 properties
PUTPaymentMethodRequest
PUTPMCreditCardInfo
object
3 properties
CreatePMPayPalECPayPalNativeECPayPalCP
object
2 properties
POSTPMMandateInfo
object
The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mand…
13 properties
CreatePaymentMethodCreditCard
object
14 properties
PUTPaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
ModifiedStoredCredentialProfileResponse
object
3 properties
CreatePaymentMethodPayPalAdaptive
object
1 property
CreatePaymentMethodApplePayAdyen
object
1 property
GETPaymentMethodResponseGooglePay
object
5 properties
CreatePaymentMethodACH
object
12 properties
POSTPaymentMethodDecryption
object
11 properties 3 required
GETPaymentMethodResponseApplePay
object
5 properties
DELETEUnresigerApplePayDomainResponse
object
1 property
CreatePaymentMethodGooglePayAdyenChase
object
1 property
PUTVerifyPaymentMethodType
object
4 properties
POSTPaymentMethodResponseDecryption
object
4 properties
GETPaymentMethodResponse
POSTPaymentMethodResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-payment-methods-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
Where this information came from

This is an independent, third-party profile of Zuora Payment Methods 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.