Welcome to Zuora Product Documentation

Explore our rich library of product information

Request

Zuora includes the following objects in each request depending on the request type:

  • For the payment request, the payment, paymentMethod, and billingAccount objects are included. The gatewayOptions object is optional.

  • For the refund request, the refund, paymentMethod, and billingAccount objects are included. The gatewayOptions object is optional.

  • For the payment method validation request, the paymentMethod object is included. The billingAccount and gatewayOptions objects are optional.

Object name

Description

paymentMethod

Include fields related to the payment method.

payment

Include fields related to the payment.

refund

Include fields related to the refund.

billingAccount

Include fields related to the billing account.

gatewayOptions

Can be used to pass any information to the gateway using key-value pairs.

For the payment request, refund request, and payment method validation request, the POST method is used as the HTTP method.