Payments - Data dictionary and Template
Zuora Payments helps you set up and manage payments by configuring payment gateways and payment methods, automatically managing recurring payments, and creating refunds. This article lists the fields associated with the Payments module. Read more on Payments here.
Note: Fields with an asterisk mark indicate mandatory fields.
|
Name |
Description |
Values |
|---|---|---|
|
GatewayOptionData Value |
The value of the gateway-specific parameter. | Alphanumeric |
| Invoice Number | The unique identification number for the invoice that the payment is applied to. | Alphanumeric |
|
InvoicePaymentData Payment Id* |
The unique ID of the payment associated with this invoice payment. | Alphanumeric Id |
|
InvoicePaymentData Invoice Id* |
The unique ID of the invoice associated with this invoice payment. | Alphanumeric Id |
| Account Id* | The unique account ID for the customer that the payment is for. |
Alphanumeric Id |
| Reference Id | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Z-Payments. | Alphanumeric Id |
| Status* | The status of the payment in Zuora. The value depends on the type of payment. |
Status values
|
|
GatewayOptionData Name |
The name of a gateway-specific parameter. | Alphanumeric |
|
Payment Method Id |
The ID of the payment method used for the payment. | Alphanumeric Id |
| Invoice Id | The ID of the invoice that the payment is applied to. | Alphanumeric Id |
| Effective Date* | The date when the payment takes effect. |
Date(yyyy-MM-dd) |
|
Auth Transaction Id |
The authorization transaction ID from the payment gateway. | Alphanumeric |
|
InvoicePaymentData Amount* |
The amount of the payment. | Decimal |
| Amount* | The amount of the payment. | Decimal |
|
Applied Invoice Amount* |
The amount of the payment to apply to an invoice. | Decimal |
|
Applied Credit Balance Amount* |
The amount of the payment to apply to a credit balance. | Decimal |
|
Accounting Code |
The accounting code for the payment. | String |
| Gateway | Name of the gateway instance that processes the payment. When creating a Payment, this must be a valid gateway instance name and this gateway must support the specific payment method. | Alphanumeric |
| IsNewPayment | Marker Column | TRUE,FALSE |
|
IsNewGatewayOptionData |
Marker Column | TRUE,FALSE |
|
IsNewInvoicePaymentData |
Marker Column | TRUE,FALSE |
| Type* |
Indicates if the payment is external or electronic. |
Type values
|
| Comment | Additional information related to the payment. | Alphanumeric |
| Soft Descriptor | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | Alphanumeric |
|
Soft Descriptor Phone |
A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | Alphanumeric |
|
Gateway Order Id |
A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the PaymentNumber will be passed in instead. | Alphanumeric |
| Data dictionary | Template |
| Payments | Download the template for Payments Data dictionary here. Payments Template - Sample.csv |