Modification Method
The method below allows you to change recurrences.
Modification of Recurrence
The modification method is available only to alter the recurrence.
The endpoint must be used by both the payer and the receiver sides. In the method call, the TaxNumber field identifies the user making the change.
For the payer, it is allowed to modify recurrence settings, such as notifications, use of credit line, or maximum value.
For the receiver, the possible modifications are the payer's name and the date of the first payment.
Important Rule about the value:
Fixed Value: When using FinalValue, the consent is tied to a fixed amount. In this case, it is not possible to change this value; it will be necessary to cancel the existing consent and create a new one from the payer.
Variable Value: This functionality allows for a range of values to be charged, with the minimum decided by the receiver and the maximum by the payer.
- MinimumValue: This value is defined by the receiver when generating the consent, establishing the authorized and non-changeable minimum.
- MaximumValue: This value is defined by the payer. If a change is needed, the modification method is initiated by the payer to adjust the authorized maximum within the existing consent.
It is worth noting that this change is always made by the payer, not by the receiver.
It is not possible to make changes to the scheduling. If any parameter needs to be changed, the existing one must be canceled and a new one created, following the standard rules for the liquidation date window (from 2 to 10 days).
{
"Method": "ChangePixAutomatic",
"PartnerId": 30519,
"BusinessUnitId": 51138,
"TaxNumber": "32135498755",
"RecurrenceId": "12345678901234567890123456789",
"PayerName": null,
"FirstPayment": null,
"Notification": true,
"CreditLine": true,
"MaximumValue": 2000
}
{
"Success": "true",
"Message": "Recurrence modification completed successfully",
"RecurrenceId": "12345678901234567890123456789"
}
Parameter | Description | Mandatory | Type | Comments |
---|---|---|---|---|
Method | Method or action to be executed in the request | Yes | String | |
PartnerId | Partner identifier | Yes | Integer | |
BusinessUnitId | Identifier of the business unit | Yes | Integer | |
TaxNumber | User identifies the user making the change | Yes | String | |
RecurrenceId | Recurrence identifier | Yes | String | |
PayerName | Payer's name | No | String | For the receiver, at least one of the fields PayerName or FirstPayment must be filled. |
FirstPayment | First payment | No | String | For the receiver, at least one of the fields PayerName or FirstPayment must be filled. |
Notification | Indicates if scheduling notifications will be received | No | Boolean | For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled. |
CreditLine | Indicates if payment is via credit line | No | Boolean | For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled. |
MaximumValue | Maximum allowed value for the payment | No | Float | For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled. |
Updated 19 days ago