Initiating Collections

Note: The API patterns for Direct Debit Collections differ from our standard payment endpoints, as they originate from an acquired product. While we’re working to harmonize the experience, full support for these endpoints is maintained.

In the context of Direct Debit Collections, the term "payment" refers to a collection — that is, a pull of funds from the payer's account, initiated by you under an existing mandate.

To initiate a payment, use the Create Payment endpoint. The request requires a valid mandateId, since Direct Debit payments can only be executed against an existing mandate.

If a mandate does not yet exist, you can create one and initiate a payment in a single step. To do this, nest a CreateMandate request in a CreatePayment request using our optimised workflow. This approach allows you to create both the mandate and the payment in a single API call.

In the CreatePayment response, BC Connect will return a payment reference. This reference is used to transfer the payment to the bank and it also appears on the account statements of all banks involved in clearing the payment.

In response, you will receive a paymentReference, which is used to process the collection with the bank. This reference also appears on the account statements of all banks involved in clearing the transaction.

Single payment

Recurring payment

When setting up a recurring payment, it is only necessary for the first payment to contain all information about the customer, bank account, mandate and the payment.

Every payment following the first can be sent with only the mandateId and the payment details inside of the request.