Skip to main content
Skip table of contents

How-to: Import a Payment File (Merchant Portal)

Procedure

  • Log in

  • Access the Payments Section

    • Navigate to the Main Menu and select Payments.

  • Navigate to Import Files

    • Click the Import Files option.

  • Upload the Payment File

    • Click Upload File button.

  • Select the Record Type

    • Select Payment as the record type that you are uploading.

  • (Optional) Select the Field Mapping Configuration

    • Select the Field Mapping Configuration that you are using. This is only necessary if you had a need to map fields from your system to our system.

  • Select the File

    • Click Browse Files or drag and drop the file you want to upload.

  • Confirm Upload

    • Click the Upload button once the file is selected.

  • Complete the Process

    • Click Done after the upload is complete.

  • Close the Upload Window

    • Click the Close button to exit the upload interface.

  • Review the Status

    • Check the Status column:

      • Processed means the file successfully created one or more payments.

      • Failed indicates an issue with processing; download the response file for more details.

  • Check the Results

    • Review the Results column to see the number of payments created.

  • (Optional) Download the Response File
    Tip: If the file failed or not all records were successfully created, download the Response File for detailed information.

    • Click Actions and then select Download Response File to view line-by-line results and any error messages.

File Upload Formats

Our system accepts payment files in .xls, .xlsx, and .csv formats.

Related Files

PaymentFile-Sample.xlsx - This example file shows you what the payment file should look like.

PaymentFile-Empty.xlsx - This is an empty file that you can use for uploading your payments.

Fields

The following table provides clarification on the fields contained in a payment file.

Field

Required

Description

MerchantId

Always

The unique Id of the originating Merchant to associate this transaction with.

This value will be provided to you when your Merchant account is setup.

Name

Required when Type is AchCredit or AchDebit

The name of the person or company that has authorized the debit or credit to their account.

Amount

Always

The amount of the payment.

0.00 if this is a prenote.

SendDate

Optional, if no date is provided the current date will be used

The date the payment is scheduled to send.

Type

Always

The type of the payment.

Values:

AchDebit - Deduct money from the specified bank account

AchCredit - Send money to the specified bank account

IsPrenote

Optional

Used to indicate whether or not the payment is a pre-note.

Values: TRUE, FALSE or blank

RouteNumber

Always

The nine digit routing number of the financial institution that the payment is being sent to.

AccountNumber

Always

The account number at the financial institution that the payment is being sent to.

AccountType

Always

The type of account at the financial institution that the payment is being sent to.

Values: GeneralLedger, BusinessChecking, BusinessSavings, PersonalChecking, PersonalSavings

EntryClass

Required when Type is AchDebit or AchCredit

The NACHA Standard Entry Class Code for the ACH payment.

Values:

CCD - Use this code for all ACH payments to business accounts

PPD - Use this code for debits to personal accounts when authorization was provided by signed agreement or when sending a credit to a personal account

TEL - Use this code for debits to personal accounts when oral authorization was obtained over the telephone

WEB - Use this code for debits to personal accounts when authorization was obtained in accordance with the requirements for internet-initiated entries

AchPaymentTypeCode

Optional, recommended when EntryClass is WEB or TEL

Used to indicate additional information regarding TEL or WEB payments.

Values:

S - Authorization was for a single payment

R - Authorization was for a recurring payment

IdentificationNumber

Optional

Typically this indicates an account number or identifier in your system associated with this payment. The value in this field may be shown on the receivers bank statement.

AchAddendaText

Optional

This text will be included in the addenda record of an ACH transaction and may be shown on the receivers bank statement.

Description

Optional

An optional description for the payment. This value is not used outside of the system.

ExternalId

Optional

Can be used to store a unique identifier for this payment from another system. Comparisons are case-insensitive. This value must be unique to all payments submitted for the related MerchantId.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.