Skip to main content

Create payments

Zuora

Create payments

You can create a payment in the following scenarios:

  • A full or partial payment on an invoice or debit memo
  • A full or partial payment on several invoices and debit memos
  • An unapplied payment
  • A reserved payment - For more information, see Prepaid Cash with Drawdown.
  • A standalone payment - If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but will settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings.

    The support for standalone payments is in the Early Adopter phase. If you want to use this feature, submit a request at Zuora Global Support to enable it.

After creating a payment on an invoice and debit memo, the related payment transactions are displayed on the invoice or debit memo detail page. You can find payment details about the invoice and debit memo on this page.

When creating a payment, the total number of invoices and debit memos that the payment will apply to must be less than or equal to 1,000.

If the Proration application rule is used, when creating a payment, the following quantity must be less than or equal to 10,000:

(number of invoice items + number of debit memo items) * number of payment items

Otherwise, the First In First Out rule will be used instead of the Proration rule.

Zuora provides you with two ways to create a payment: external payment and electronic payment. 

To create a payment from the REST API, see POST Create Payment.

Note that you can also create custom payment numbers for external and electronic payments. This field is helpful when you want to keep the original payment number from external systems/merchants into Zuora for easy cross-referencing, reporting and effectively reconciling payment. 

The support for Custom Payment Numbers in the Early Adopter phase. To use this feature, submit a request at Zuora Global Support.

Create an external payment from the Zuora UI

To create an external payment on invoices and debit memos:

  1. Navigate to Payments > Payments in the navigation section, and click create payment

  2. Specify the following information in the Basic Information section:
    1. From the Customer Account list, select a customer account.
    2. In the Payment Type area, click External Payment.
    3. In the Payment Number field, enter a payment number.
      Note: The payment number should have a unique name with a maximum length of 16 characters. Characters between a-z, A-Z, and 0-9 are accepted.
    4. From the Payment Method list, select a payment method you used for the payment.

      If the account has a default payment method specified, the payment method will default to that payment method.

    5. Check the Prepayment checkbox if you want to add this payment as a reserved payment to the customer account. For more information, see Prepaid Cash with Drawdown.
    6. In the Payment Date field, specify a date when the payment takes effect.
    7. In the Payment Amount field, specify the payment amount.
    8. (Optional) In the Reference ID field, specify a reference ID.
    9. (Optional) In the Comments field, enter the comments for this payment.
  3. Specify the following information in the Finance Information panel:
    1. From the Transferred to Accounting list, select the status of the mapping from Zuora to a third party, such as NetSuite or Salesforce. 
    2. From the Bank Account list, select the accounting code that maps to a bank account in your accounting system. 
    3. From the Unapplied Payment list, select the accounting code for the unapplied payment.
  4. If you want to create a full unapplied payment, do not apply your payment to any of the applicable invoices and debit memos. Go to step 6.
  5. If you want to apply a full payment or partial payment on one or more invoices and debit memos:
    1. Select the invoices and debit memos you want to pay in the Apply Payment panel. 
    2. Specify the amount you want to apply in the Amount to Apply column.
  6. Click create payment.

Create an electronic payment from the Zuora UI

To create an electronic payment on invoices and debit memos:

  1. Navigate to Payments > Payments in the left-hand navigation section, and click create payment.

  2. Specify the following information in the Basic Information panel:
    1. From the Customer Account list, select a customer account.
    2. In the Payment Type area, click Electronic Payment.
    3. In the Payment Number field, enter a payment number.
      Note: The payment number should have a unique name with a maximum length of 16 characters. Characters between a-z, A-Z, and 0-9 are accepted.
    4. If you need to create a standalone payment, click the standalone option and complete the required fields for the standalone payment. Otherwise, leave the standalone option clear and proceed with the following steps.
    5. From the Payment Method list, select a payment method you used for the payment. If the account has a default payment method specified, the payment method will default to that payment method.
    6. Check the Prepayment checkbox if you want to add this payment as a reserved payment to the customer account. For more information, see Prepaid Cash with Drawdown.
    7. Click View Detail to see the detailed information about the payment method. 
    8. (Optional) From the Transaction Source list, select one of the following options. For gateways that do no support unscheduled transactions, if you select the unscheduled transaction option in this field, the transaction will be processed as a recurring transaction. See Support for stored credential transactions overview for gateways that support unscheduled transactions.
      • Cardholder-initiated unscheduled transaction: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
      • Merchant-initiated recurring transaction: Merchant-initiated transaction (MIT) that occurs at regular intervals.
      • Merchant-initiated unscheduled transaction: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
      • Merchant Initiated MOTO Transaction: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2
        For a MOTO payment through Stripe v2, the MOTO transaction indicator will be included in the request to the gateway and a recurring stored credential profile will be created for the payment method used to process the payment. The network transaction ID (NTI) will be returned in the authorization response.
    9. In the Payment Amount field, specify the payment amount.
    10. (Optional) In the Comments field, enter the comments for this payment.
  3. Specify the following information in the Finance Information panel:
    1. From the Transferred to Accounting list, select the status of the mapping from Zuora to a third party, such as NetSuite or Salesforce. 
    2. From the Bank Account list, select the accounting code that maps to a bank account in your accounting system. 
    3. From the Unapplied Payment list, select the accounting code for unapplied payment.
  4. If you want to create a full unapplied payment, do not apply your payment to any of the applicable invoices and debit memos. Go to step 6.
  5. If you want to apply a full payment or partial payment on one or more invoices and debit memos:
    1. Select the invoices and debit memos you want to pay in the Apply Payment panel. 
    2. Specify the amount you want to apply in the Amount to Apply column.
  6. Click create payment.

Points to note while customizing payment numbers

  • The Payment number field is only available in the request body to create external and electronic payment operations through both the UI and API.
  • Updating payment numbers is not supported. For example, if you set the value of payment number to P-00001, you cannot change this value once the payment record is saved.
  • When a payment with a custom payment number is deleted, the system will change the value by adding a random suffix. For example, if your payment number is PAY-ECS-001, it will be changed to PAY-ECS-001_14230a434ea. This behavior ensures that if you use the same payment number in the future, it will still be unique. 
  • Avoid using system default prefixes, prefixes for internal use, or any customized prefixes you have configured. This may cause a numbering conflict while naming the payment numbers. If the conflict occurs, you can change the prefix on the payment number, or change the starting number to a value greater than the current value.