Modification Method
The method below allows you to change recurrences.
Modification of Recurrence
ChangePixAutomatic: For the payer, it allows modification of recurrence settings, such as notifications, use of credit line or maximum amount. And for the recipient, the payer's name and date of the first payment.
{
"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 | |
BusinessUnitId | Identifier of the business unit | Yes | Integer | |
PartnerId | Partner identifier | Yes | Integer | |
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 about 5 hours ago