Batch Payments

Batch payments allow your customers to pay multiple invoices in a single transaction.

Enabling Batch Payments

To enable batch payments, you set batchPayment on the invoice to true. This field will be true if the invoice is a batch payment, and false otherwise.

The Mercoa <PayableDetails /> React component also supports batch payments using the <PaymentOptions /> sub-component.

1
from mercoa import Mercoa
2
from mercoa.invoice_types import InvoiceUpdateRequest
3
4
client = Mercoa(
5
    token="YOUR_TOKEN",
6
)
7
client.invoice.update(
8
    invoice_id="in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
9
    request=InvoiceUpdateRequest(
10
        batch_payment=True,
11
    ),
12
)

How Batch Payments Work

Mercoa automatically batches payments for invoices that have the batchPayment field set to true. This means that you don’t need to manually batch payments.

Mercoa uses the following logic to determine if an invoice is part of a batch:

1. If the invoice has the batchPayment field set to true
2. The invoice has the same payerId and vendorId
3. The invoice has the same paymentSourceId and paymentDestinationId
4. The invoice has the same paymentDestinationOptions
5. The invoice has the same deductionDate

If any of these conditions aren’t met, the invoice is considered a separate payment.

Bank Payments

Mercoa sends a single ACH payment for all invoices in a batch. The paymentDestinationOptions memo assumes that all the invoices in the batch contain the same memo, as one is chosen at random.

Check Payments

Mercoa sends a single check payment for all invoices in a batch. The check memo contains the invoice numbers of all the invoices in the batch joined by a comma.