Test accounts - PaymentAgreement APIs

Create Payment Agreement

A call to POST /v1/paymentAgreement will result in:

PayID

PayIDType	PayID	Example	Expected status	failureCode	failureReason
Email	Prefix `error@`	`error@example.com`	`FAILED`	AZP2.1	An error has occurred with this Payment Agreement. Please contact support.
Phone	Prefix `+61-46`	`+61-469887654`	`FAILED`	AZP2.1	An error has occurred with this Payment Agreement. Please contact support.
Email	Prefix `error-2@`	`error-2@example.com`	`FAILED`	AZP2.2	The payer account is not eligible for PayTo payments.
Email	Prefix `error-3@`	`error-3@example.com`	`FAILED`	AZP2.3	The payer account is not eligible for NPP payments.
Email	Prefix `error-4@`	`error-4@example.com`	`FAILED`	AZP2.4	Payee alias details are invalid.
Email	Prefix `error-31a@`	`error-31a@example.com`	`FAILED`	AZP3.1	Last payment date must be equal to or after start date.
Email	Prefix `error-32@`	`error-32@example.com`	`FAILED`	AZP3.2	Start date must be today or future dated.
Email	Prefix `error-33a@`	`error-33a@example.com`	`FAILED`	AZP3.3	End date must be equal to or after start date.
Email	Prefix `error-41@`	`error-41@example.com`	`FAILED`	AZP4.1	Request Timed Out. Please Try again.
Email	Prefix `error-42@`	`error-42@example.com`	`FAILED`	AZP4.2	Possible NPP outage. Please try again later.
Email	Prefix `error-99@`	`error-99@example.com`	`FAILED`	AZP9.9	Fatal Error. Please contact support.
Email	Prefix `no-action@`	`no-action@example.com`	`CREATED`	N/A	N/A
Phone	Prefix `+61-47`	`+61-479887654`	`CREATED`	N/A	N/A
Email	Prefix `cancel-agreement@`	`cancel-agreement@example.com`	`CANCELLED`	N/A	N/A
Phone	Prefix `+61-48`	`+61-481223344`	`CANCELLED`	N/A	N/A
Email	Prefix `suspend-agreement@`	`suspend-agreement@example.com`	`SUSPENDED`	N/A	N/A
Phone	Prefix `+61-49`	`+61-499887654`	`SUSPENDED`	N/A	N/A
Phone	Anything else	`+61-453123123`	`ACTIVE`	N/A	N/A
Email	Anything else	`anythingelse@example.com`	`ACTIVE`	N/A	N/A

Bank Account Details

BSB	Account Number	Expected status	failureCode	failureReason
666666	Valid Account Number	`FAILED`	AZP2.1	An error has occurred with this Payment Agreement
555552	Valid Account Number	`FAILED`	AZP2.2	The payee account is not eligible for PayTo payments
555553	Valid Account Number	`FAILED`	AZP2.3	The payee account is not eligible for NPP payments
555554	Valid Account Number	`FAILED`	AZP2.4	Payee alias details are invalid
777777	Valid Account Number	`CREATED`	N/A	N/A
888888	Valid Account Number	`CANCELLED`	N/A	N/A
999999	Valid Account Number	`SUSPENDED`	N/A	N/A

Amend Payment Agreement

Payee Initiated Amendment

In the UAT environment, if the amendment contains a specific value as shown in the table below, it will trigger a
certain behaviour which is very useful for testing purpose.

Payee initiated amendment is categorised as bilateral amendment.
Bilateral amendment means it requires approval by the payer if the amendment is initiated by the payee
and vice versa.

Type	amount	maximumAmount	Expected Behaviour
Variable	N/A	0.11	A call to `POST /v1/paymentAgreement/amendment` will result in error
Variable	N/A	0.22	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `DECLINED`
Variable	N/A	0.33	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `RECALLED`
Variable	N/A	0.44	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `TIMEDOUT`
Fixed	0.11	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in error
Fixed	0.22	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `DECLINED`
Fixed	0.33	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `RECALLED`
Fixed	0.44	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `TIMEDOUT`
Usage Based	N/A	0.11	A call to `POST /v1/paymentAgreement/amendment` will result in error
Usage Based	N/A	0.22	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `DECLINED`
Usage Based	N/A	0.33	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `RECALLED`
Usage Based	N/A	0.44	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `TIMEDOUT`
Balloon	0.11	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in error
Balloon	0.22	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `DECLINED`
Balloon	0.33	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `RECALLED`
Balloon	0.44	N/A	A call to `POST /v1/paymentAgreement/amendment` will result in bilateral amendment status `TIMEDOUT`

Example of request payload for Variable agreement details that will result in bilateral status DECLINED:

POST https://api.azupay.com.au/v1/paymentAgreement/amendment
Authorization: SECR_MYBUSINESSID_myapikey
Content-Type: application/json

{
  "PaymentAgreementAmendment": {
    "paymentAgreementId": "827ce039a3cb464b0be8036453f8f54b",
    "clientTransactionId": "4733dbb4-af1d-451b-942c-291ca548289c",
    "agreementDetails": {
      "variableAgreementDetails": {
        "maximumAmount": "0.22"
      }
    }
  }
}

Initiate Payment

paymentAmount	Expected Behaviour
88.88	A call to `POST /v1/paymentInitiation` will result in status `FAILED`
0.77	A call to `POST /v1/paymentInitiation` will result in status `RETURN_COMPLETE`

1-Click Checkout App

When using the 1-click Checkout app (UAT):

PayID	Expected Behaviour
0400123123	The Payment Agreement created via the 1-click checkout app will automatically get approved to an ACTIVE state
0472345678	The Payment Agreement created via the 1-click checkout app will stay in a CREATED state

When using the 1-click Checkout app (UAT) with SMS authentication:

SMS OTP	Expected Behaviour
111 222	Will pass the SMS OTP check
Anything else	Will fail the SMS OTP check