Skip to main content

Create a Batch Direct Debit Payment

POST 
/direct-debit-payment-batches

Create a batch of multiple direct debit payments.

When you create a batch direct debit payment in test mode, it will automatically succeed after a short while with the status COMPLETED. Every direct debit payment within the batch will subsequently succeed with the status SUCCEEDED.

You can simulate various failure scenarios in test mode by setting the customerReference field of a direct debit payment within the batch to the following values:

  • FAIL: The affected direct debit payment will fail with the status FAILED. This does not affect the batch direct debit payment and other direct debit payments within it.
  • FAIL-BATCH: The batch direct debit payment will fail with the status FAILED, and every direct debit payment within it will fail with the status FAILED.

Request​

Responses​

OK

Response Headers
    Acme-Mode

    Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.