PayAdvantage 12.1.12

Apply a template to multiple direct debits

New endpoint: POST /v3/direct_debit_templates/{code}/applications

Applies a template's current version to a list of active direct debits. Requires the direct_debit_write permission, and the merchant must have direct debit templates enabled.

Request body

Field	Type	Required	Description
`directDebitCodes`	string[]	Yes	Codes of the active direct debits to apply the template to. At least one.
`dryRun`	boolean	No	When `true`, returns the result for each direct debit without changing anything. Defaults to `false`.

{
  "directDebitCodes": ["AB12CD", "EF34GH"],
  "dryRun": true
}

Behaviour

Dry run (dryRun: true): nothing changes. Every requested direct debit gets a pass, warn or fail result. Unknown or ineligible codes come back as fail rows, not an error.
Apply (dryRun omitted or false): all or nothing. If any direct debit fails a rule, the whole request is rejected with 422 naming the failing codes, and nothing is applied. Customers whose recurring amount or frequency changes are emailed the new details.
An unknown template returns 404. A fixed-total or yearly template returns 422.

Response

Field	Type	Description
`results[].code`	string	The direct debit code.
`results[].status`	string	`pass`, `warn` or `fail`.
`results[].reason`	string	Why, for `warn` or `fail`.
`results[].currentRecurringAmount`	decimal	Recurring amount before the template is applied.
`results[].currentFrequency`	string	Frequency before the template is applied.
`results[].afterRecurringAmount`	decimal	Recurring amount once the template is applied.
`results[].afterFrequency`	string	Frequency once the template is applied.

Payment descriptions increased to 100 characters

The maximum payment description length has increased from 50 to 100 characters. This change is backward compatible: descriptions of 50 characters or fewer work as before.

Affected endpoints

Endpoint	Field
`POST /v3/payment_requests`	`description`
`PATCH /v3/payment_requests/{code}`	`description`
`POST /v3/credit_cards/{code}/charges`	`description`
`POST /v3/credit_card_iframes`	`description`
`POST /v3/payment_iframes`	`description`
`POST /v3/pay_ids`	`description`
`POST /v3/direct_debits`	`description`
`POST /v3/direct_debit_templates`	`ddrDescription`
`PATCH /v3/direct_debit_templates/{code}`	`ddrDescription`

Validation

A description longer than 100 characters returns 400:

Description exceeds the maximum length of 100 characters.