Skip to main content
To start making authentication requests, your first step is to register an OAuth2 Client. This is the entity that represents you as a third-party developer and identifies your application to both Macropay and the end user during the authorization flow. Clients are created and managed directly from your User Settings. When registering a client, you’ll be asked to provide the following:
  • Application Name: the public-facing name your end users will see.
  • Client Type: which kind of client you’re registering. Read more
  • Redirect URIs: the URL(s) on your application where users are sent back after they approve access to their data. Declaring these up front is a security requirement.
    Your OAuth client must use an https:// URL for security reasons. Plain http:// URLs are rejected — the only exception is when the hostname is localhost, which lets you point at http://localhost while testing in development.
  • Scopes: the set of scopes your application is permitted to request. For better privacy and security, request only the scopes your application genuinely requires.
  • Homepage URL: a link to your application, displayed to end users on the authorization screen.
You may also optionally supply a logo, a terms of service URL, and a privacy policy URL. Each of these is surfaced to end users on the authorization page as well. After the client is created, Macropay issues you a Client ID and a Client Secret — the credentials you’ll use when making authentication requests. Treat these credentials as highly sensitive and never expose them: anyone holding them can make authentication requests against Macropay on your behalf.