Update A Payment Agreement
Amend the Details of a PayTo Payment Agreement
Section titled “Amend the Details of a PayTo Payment Agreement”This article describes the different scenarios that can be simulated in the Sandbox environment. An amount field is used to control the desired behaviour.
NOTE: These scenarios use the PATCH operation against the /customers/{id}/PaymentInstruments{instrumentId} resource
Amend the Details of a Payment Agreement Successfully
Section titled “Amend the Details of a Payment Agreement Successfully”This scenario simulates an amendment to a Payment Agreement being submitted by the merchant and then approved by the customer in their banking app. The paymentAgreement.agreementUpdatesInProgress object will be returned in the response, and then you will receive a webhook with the updated details.
| Payment Agreement Type | Payload Property | Value |
|---|---|---|
| Balloon Agreement | paymentAgreement.agreementDetails.balloonAgreementDetails.lastAmount | 10060 |
| Variable Agreement | paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount | 10060 |
| Fixed Agreement | paymentAgreement.agreementDetails.fixedAgreementDetails.amount | 10060 |
| Usage Agreement | paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount | 10060 |