On This Page
Implementing OAuth 2.0
This overview provides the steps that you and the merchant must take to implement OAuth.
- You enable mutual authentication by obtaining a Certificate Signing Request (CSR) from a supported certificate authority (CA). After obtaining a CSR, you provide your common name details toNational Australia Bank. For more information, see Enable Mutual Authentication.
- You register your web-application in theGateway Portal. You set a scope of permissions and a redirect URL to your web-application. For more information, see Register Your Application.
- The merchant visits your web-application, provides their credentials, and clicks a button or link to complete the permission process.
- Your application redirects the merchant to aNational Australia Bank-hosted webpage. For more information, see Register Your Application.
- The merchant logs in to theGateway Portaland grants your web-application permission to access their merchant account based on the scope you set previously. Notify the merchant that their account must have access to grant OAuth permissions to complete this requirement.
- National Australia Bankredirects the merchant to your application using the redirect URL you registered. An authentication code is appended to the redirect URL. For more information, see Interpreting the Redirect Response.
- Your application exchanges the authorization code withNational Australia Bankfor these two tokens:
- Access token:A token to authenticate transactions usingNational Australia Bank. For more information about how to authenticateNational Australia Banktransactions using this token, see Submit API Requests Using OAuth.
- Refresh token:A token that you can use to request additional access tokens.
For more information about requesting tokens, see Request the Access and Refresh Tokens.For more information about refreshing your existing tokens, see Refresh the Access Token and Refresh the Refresh Token.
To change the permissions the merchant grants you, you must repeat steps 2–7.
You must
obtain test
merchant credentials to emulate the access delegation. Your test account must contain
at least one card-based transaction from within the past 7 days.