When you create a debt or a subscription, you can narrow down which methods the debtor can pay with. By default, TapiPay internally resolves the methods available for your organization (cash and digital), and you decide whether you want to restrict them.
Available methods
The paymentMethods field accepts one or more of these values:
If you do not send paymentMethods, the debt is enabled with the methods configured at your organization level. You do not need to send this field to charge.
Direct debit (autopay)
autopay (default false) indicates that the charge is performed by direct debit, without the debtor choosing a method for each charge.
autopay and paymentMethods are mutually exclusive. If you send autopay: true, you cannot send paymentMethods in the same request. Doing so returns 400 INVALID_REQUEST.
Error: autopay + paymentMethods together
Method hierarchy
The enabled methods are resolved in a cascade, from the general to the specific:
What you define at the resource level narrows what the organization allows. You cannot enable at the debt level a method that your organization does not have active.
Paying several debts at once
When a debtor pays multiple debts in a single operation, the system computes the intersection of the methods enabled on each debt and only offers the methods common to all of them.
If the intersection is empty, there is no common method to charge all the debts together, and the operation is rejected with 422 BUSINESS_RULE_VIOLATION. In that case, the debtor must pay them separately.
If you are going to allow your debtors to group payments, keep a consistent set of paymentMethods across the debts of the same debtor to avoid empty intersections.
