Skip to main content

Documentation

Downloading a Sample Mass Payment File

Download a sample mass payment file to serve as a template for your own file.

This is the first step in Creating Mass Payments.

This procedure requires Owner or Administrator privileges.

  1. Sign in as described in Accessing the Client Portal and navigate to Collect > Payment Features > Mass Payments.

    The Mass Payments page appears.

    648874fc466ae.png
  2. Select Download Sample File

    A Sample File dialog box appears.

    648874feba604.png
  3. Select the sample file you want to download:

    • Payment - a specific payment method.

    • Hosted - an embedded checkout page.

    6488750073361.png

    If you select Payment, then you must also select the country, currency, and payment method type.

  4. Click the Download button. The sample mass payment file is downloaded to your computer. The file is in CSV format.

    64887502a2e6a.png

    The file includes a row containing the names of the required and optional fields for the specific payment type or checkout page. The following is a sample file for the 'us_psc_cash' payment type.

  5. Continue to Creating a Mass Payment File.

Sample CSV File

amount,currency,country,payment_method,payment_method.type,expiration,merchant_reference_id,customer,description,complete_payment_url,error_payment_url