Create A Payment Agreement

Create 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 POST operation against the /customers/{id}/PaymentInstruments resource

Simulate an Authorised Payment Agreement

This scenario simulates a Payment Agreement being created and then authorised by the customer in their banking app. The paymentAgreement.agreementStatus will change from created to active and you will receive a webhook with the updated status.

Payment Agreement Type	Payload Property	Value
Balloon Agreement	paymentAgreement.agreementDetails.balloonAgreementDetails.amount	10010
Variable Agreement	paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount	10010
Fixed Agreement	paymentAgreement.agreementDetails.fixedAgreementDetails.amount	10010
Usage Agreement	paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount	10010

Simulate a Rejected Payment Agreement

This scenario simulates a Payment Agreement being created and then rejected by the customer in their banking app. The paymentAgreement.agreementStatus will change from created to cancelled and you will receive a webhook with the updated status.

Payment Agreement Type	Payload Property	Value
Balloon Agreement	paymentAgreement.agreementDetails.balloonAgreementDetails.amount	10050
Variable Agreement	paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount	10050
Fixed Agreement	paymentAgreement.agreementDetails.fixedAgreementDetails.amount	10050
Usage Agreement	paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount	10050

Simulate an Active Payment Agreement Being Cancelled

This scenario simulates an active Payment Agreement being cancelled by the customer in their banking app. The paymentAgreement.agreementStatus will go through the full lifecycle of being created to active, then finally to cancelled. You will receive a webhook with the updated status for each step.

Payment Agreement Type	Payload Property	Value
Balloon Agreement	paymentAgreement.agreementDetails.balloonAgreementDetails.amount	10020
Variable Agreement	paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount	10020
Fixed Agreement	paymentAgreement.agreementDetails.fixedAgreementDetails.amount	10020
Usage Agreement	paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount	10020

Simulate an Active Payment Agreement Being Suspended

This scenario simulates an active Payment Agreement being paused by the customer in their banking app. The paymentAgreement.agreementStatus will go through the full lifecycle of being created to active, then finally to suspended. You will receive a webhook with the updated status for each step.

Payment Agreement Type	Payload Property	Value
Balloon Agreement	paymentAgreement.agreementDetails.balloonAgreementDetails.amount	10030
Variable Agreement	paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount	10030
Fixed Agreement	paymentAgreement.agreementDetails.fixedAgreementDetails.amount	10030
Usage Agreement	paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount	10030

Simulate an Suspended Payment Agreement Being Cancelled

This scenario simulates an active Payment Agreement being paused by the customer in their banking app and then later cancelled. The paymentAgreement.agreementStatus will go through the full lifecycle of being created to active, then to suspended and finally cancelled. You will receive a webhook with the updated status for each step.

Payment Agreement Type	Payload Property	Value
Balloon Agreement	paymentAgreement.agreementDetails.balloonAgreementDetails.amount	10040
Variable Agreement	paymentAgreement.agreementDetails.variableAgreementDetails.maximumAmount	10040
Fixed Agreement	paymentAgreement.agreementDetails.fixedAgreementDetails.amount	10040
Usage Agreement	paymentAgreement.agreementDetails.usageAgreementDetails.maximumAmount	10040