Accessing the API
These are the stages of accessing the API:
- Get the test account.
- Configure your API credentials.
- Use the Postman collection to quickly make a test API request.
- Perform an integration.
Requesting a test account
To request a test account, please contact ANZ Worldline Payment Solutions (PSP). Depending on the complexity of your integration, the PSP may require a substantial amount of data from you to create and fully configure your merchant account. The exact details depend on the functionalities you want to use on the ANZ eGate payment gateway and on the acquirers you need. Each PSP has their own methods for gathering the necessary data from you.
Provide the following details to request for a test account:
- Business details
Specifies the basic data about your business, such as your name, the type of goods or services you sell, your web site URL, your geographical location, and your contact details. - PCI compliance
Determine whether you want to handle sensitive payment data based on SAQ-A or SAQ-D compliance. You can define the compliance setting separately for API requests and any manual transactions performed in the Merchant Administration. - Integration settings
Determine which integration methods and authentication options you want to use. - Transactions
Determine which transactions you want to use and how. - Services
Determine which additional features and security and fraud prevention functionalities, such as Reporting API or Tokenisation, are part of your setup.
Configure your profile
When your merchant account is ready, you receive the related credentials and the URL to the Merchant Administration from ANZ Worldline Payment Solutions. The Merchant Administration is a website where you can manage both your payments and your merchant account. Remember you test account Merchant ID is prefixed with TEST<your_merchantid>.
To configure your profile:
- Go to the Merchant Administration and customize your merchant profile as needed.
- Check out the available profile settings in the various subsections of the Admin menu. Make sure they reflect the setup that you want to use.
ANZ Worldline Payment Solutions is the only one who can see and change most of your account settings. If you need to change your merchant profile that you cannot make in the Merchant Administration yourself, contact ANZ Worldline Payment Solutions.
- Use the Merchant Administration to set up your API password, if you want to use the password as your authentication option.
- If needed, you can then later view your test transactions and their response using the Search function.
For more information about how to use the Merchant Administration, see Merchant Administration User Guide.