Update a mandate
Modify the details of an existing DebiPay mandate through the update endpoint.
PUT
Loading code example
Body
idstringrequiredLength:
>= 0, <= 36addressobjectaddress.streetAddressstringrequiredaddress.suburbnull | stringaddress.citystringrequiredaddress.provinceIdinteger | string<int32>Pattern:
^-?(?:0|[1-9]\d*)$address.postalCodenull | stringaddress.blockOrFloorLevelnull | stringamountnumber | string<double>Pattern:
^-?(?:0|[1-9]\d*)(?:\.\d+)?$startDatestring<date-time>actionDayIdinteger | string<int32>Pattern:
^-?(?:0|[1-9]\d*)$bankAccountanybankCardanypaymentMethodIdinteger | string<int32>Pattern:
^-?(?:0|[1-9]\d*)$payerstringrequiredsignatoryFirstNamestringsignatoryLastNamestringidentificationTypeIdinteger | string<int32>Pattern:
^-?(?:0|[1-9]\d*)$identificationValuestringadjustmentRatenumber | string<double>Pattern:
^-?(?:0|[1-9]\d*)(?:\.\d+)?$maximumAmountnumber | string<double>Pattern:
^-?(?:0|[1-9]\d*)(?:\.\d+)?$countryIdstringUse this endpoint to update the details of an existing mandate. The request body allows you to change the mandate's commercial and payment details while preserving the mandate identity and linking it to the same payer.
Use the update operation when you need to revise a mandate after it has already been created, such as changing the payer, amount, payment method, or address details.
Fields you may update
The request payload supports fields such as:
idto identify the target mandateaddressfor postal or physical address detailsamount,startDate, andactionDayIdfor payment timingbankAccount,bankCard, orpaymentMethodIdfor payment method changespayerand signatory names for customer details
When to use it
- Correct information after initial mandate creation.
- Adjust the payment method or amount for the mandate.
- Refresh customer or signatory details without recreating the mandate.
If the change is temporary or you want to pause processing, the suspend endpoint may be more appropriate than a full update.