Create A Payment Request
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 /paymentrequests resource
Simulate a created Payment Request without payment
This scenario simulates a Payment Request being created, but no payment is made by the customer through their banking app. The paymentRequestStatus will be set to created after the Payment Request is initiated.
| Payload Property | Value |
|---|---|
| payment.amount | 10110 |
Simulate a created Payment Request with a successful payment
This scenario simulates a Payment Request being created, followed by a successful payment made by the customer through their banking app. The paymentRequestStatus will transition from created to completed. You will receive two payment_requests webhook notifications (one per status change) and, if subscribed to the transactions event, an additional transaction webhook.
| Payload Property | Value |
|---|---|
| payment.amount | 10120 |
Refund Scenarios
NOTE: These scenarios use the POST operation against the /transactions/{id}/refunds resource. The original Payment Request must be in
completedstatus.
Simulate a Refund that settles successfully
This scenario simulates a refund being submitted and settling successfully. The refund result.status will transition from pending to approved and you will receive a webhook notification with the updated status.
| Payload Property | Value |
|---|---|
| amount | 10010 |
Simulate a Refund that settles then is returned
This scenario simulates a refund that initially settles but is subsequently returned by the customer’s bank. The refund result.status will transition from pending to approved to declined and you will receive webhook notifications for each status change.
| Payload Property | Value |
|---|---|
| amount | 10020 |
Simulate a failed Refund
This scenario simulates a refund that fails to process. The refund result.status will transition from pending to declined and you will receive a webhook notification with the updated status.
| Payload Property | Value |
|---|---|
| amount | 10030 |