Mass Payment Upload

Knowledge Center > Finance > Mass Updater > Mass Payment Upload

Mass Payment Upload

The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support

The Mass Payment Upload (MPU) mass action allows you to import payments to be processed in bulk. This reference describes the columns supported in the upload file and the columns added to the response file. See Mass Updater for more information.

Prerequisites

This mass action has the following prerequisites:

  • The Invoice Settlement feature must be enabled.
  • You must have Zuora Payments permissions of Process External Payment, Process Electronic Payment, or both.

Upload File Columns 

The following table describes the columns supported in the upload file.

The maximum size of the the upload file is 4 MB.

Column Required? Description
Billing Account ID Optional

The ID of the customer account that the payment is for. If this column is left blank, the uploaded payment will be an unassigned payment. The corresponding Payment Invoice cannot be set to any value, and the value of Payment Method Id can only be an external payment method.

Type: string

Character limit: 32

Payment Invoice Optional

The ID of the invoice and portion of the payment to be applied to the invoice. If this column is left blank, the uploaded payment will be an unapplied payment. At the item level, the application rule defined under Payments > Configure Application Rule is used. 

The data format of this column is InvoiceID1:amount|InvoiceID2:amount.

Type: string

 

Payment Amount Required

The total amount of the payment.

Type: number

 

Currency Required

The currency ID or currency code.

Type: string

 

Payment Date

Required 

The effective date of the payment in Zuora. 

The date must be in YYYY-MM-DD format.

Type: date

Payment Method ID Required

The ID of the payment method that is used for the payment.

Type: string

Character limit: 32

Payment Comment

Optional 

The comments about the payment.

You must use double quotation marks to enclose the comments that contain commas. For example, “$396 was refunded to avoid duplicate error msg and $138 was charged back for monthly fee.” )

Type: string

Character limit: 255

Payment Type

Optional

Whether the payment is an external payment or electronic payment. If this column is left blank, the uploaded payment will be an external payment.

Type: enum

Values: External, Electronic

Gateway ID Optional

The ID of the gateway instance to process the payment.

Type: string

Character limit: 32

Reference ID

Optional

The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

Type: string

Character limit: 60

Payment Debit Memo

Optional

The ID of the debit memo and portion of the payment to be applied to the debit memo. If this column is left blank, the uploaded payment will be an unapplied payment. At the item level, the application rule that is defined under PaymentsConfigure Application Rule is used.

The data format of this column is     DebitMemoID1:amount|DebitMemoID2:amount.

Type: string

Response File Columns

The following table describes the columns added to the response file.

Column Description

Success

  • Returns Y if the record was successful.
  • Returns N if the record failed.
  • Remains blank if the record was not processed.

Error Message

Displays a brief description of the error if the record failed.

Last modified

Tags

This page has no custom tags.

Classifications

(not set)