The total amount of the payment.

When Standalone Payment is not enabled, the currency of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. But if you have the Multiple Currencies feature enabled, you can have a different payment currency.

When Standalone Payment is enabled and standalone is true, the currency of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

The type of the payment.

Note: If you specify the type as Electronic, you must specify the value for accountId or accountNumber.

The ID of the customer account that the payment is created for.

The number of the customer account that the payment is created for, such as A00000001.

You can specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.

When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the Create authorization operation, together with the authTransactionId field.

The following payment gateways support this field:

• Adyen Integration v2.0
• CyberSource 1.28
• CyberSource 1.97
• CyberSource 2.0
• Chase Paymentech Orbital
• Ingenico ePayments
• SlimPay
• Stripe v2
• Verifi Global Payment Gateway
• WePay Payment Gateway Integration

Additional information related to the payment.

It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).

Note: The API custom rate feature is permission controlled.

Container for debit memos. The maximum number of debit memos is 1,000.

The date when the payment takes effect, in yyyy-mm-dd format.

Note:

• This field is required for only electronic payments. It's an optional field for external payments.
• When specified, this field must be set to the date of today.
• When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment.

Container for the finance information related to the payment.

The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.

• If Payment Gateway Routing is enabled, when creating electronic payments, this field is optional.

  • If this field is not specified, gateway routing rules will be invoked.
  • If this field is specified, the specified gateway will be used to process the payment.

• If Payment Gateway Routing is disabled, when creating electronic payments, this field is required.

• When creating external payments, this field is optional.

Use the same gateway instance if both paymentGatewayNumber and gatewayId are sent in the request.

The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in Zuora Knowledge Center.

Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.

Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.

When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the Create authorization operation, together with the authTransactionId field.

Container for invoices. The maximum number of invoices is 1,000.

Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.

• C_Unscheduled: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
• M_Recurring: Merchant-initiated transaction (MIT) that occurs at regular intervals.
• M_Unscheduled: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
• M_MOTO: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See Overview of Stripe payment gateway integration for more information.

The natural key for the payment gateway.

Use the same gateway instance if both paymentGatewayNumber and gatewayId are sent in the request.

The unique ID of the payment method that the customer used to make the payment.

If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.

The type of the payment method that the customer used to make the payment.

Specify this value when you are creating an external payment method. If both paymentMethodType and paymentMethodId are specified, only the paymentMethodId value is used to create the payment.

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.

Here is an example:

"paymentOption": [
  {
    "type": "GatewayOptions",
    "detail": {
      "SecCode":"WEB"
    }
  }
]

paymentOption of the payment schedule takes precedence over paymentOption of the payment schedule item.

You can use this field or the gatewayOptions field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the paymentOption field will be stored in the Payment Option object and can be easily retrieved.

The unique ID or the number of the payment schedule to be linked with the payment. See Link payments to payment schedules for more information.

Indicates whether the payment will be used as a reserved payment. See Prepaid Cash with Drawdown for more information.

The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

This field is only available if support for standalone payments is enabled.

Specify true to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora.

When standalone is set to true:

• accountId, amount, currency, and type are required.
• type must be Electronic.
• currency of the payment can be different from the payment currency in the customer account settings.
• The amount will not be summed up into the account balance and key metrics regardless of the payment currency.
• No settlement data will be created.
• Either the applied amount or the unapplied amount of the payment is zero.
• The standalone payment cannot be applied, unapplied, or transferred.

Specify false to create an ordinary payment that will be created, processed, and settled in Zuora. The currency of an ordinary payment must be the same as the currency in the customer account settings.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.