The Rapyd Client Portal Developer Hub

Welcome to the Rapyd Client Portal developer hub. You'll find comprehensive guides and documentation to help you start working with Rapyd Client Portal as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Downloading a Sample Mass Invoice File

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

This is the first step in Creating Mass Invoices.

This procedure requires Owner or Administrator privileges.

How Download a Sample Mass Invoice

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

The Mass Invoices page appears.

  1. Select Download Sample File

    A Sample File dialog box appears.

  2. Select the sample file you want to download:

  • Payment - a specific payment method.
  • Hosted - an embedded checkout page.

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

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

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.

amount,currency,country,payment_method,payment_method.type,expiration,merchant_reference_id,customer,description,complete_payment_url,error_payment_url
  1. Continue to Creating a Mass Invoice File.

Updated 17 days ago


Downloading a Sample Mass Invoice File


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.