Skip to main content
Welcome to the preview portal — This is an early release of the new Doc Hub experience, with more content coming soon.
LIMITED

Get Started


Follow the tasks on this page to register for OAuth 2.0 and integrate to the method that matches how your client obtains consent to access another organization's data.

Integration Methods

Before You Begin


Complete Steps 1 – 3 in the technology partner Go Live page before beginning to set up OAuth 2.0. The steps explain how to complete these requirements:

  • Sign up your organization as a technology partner in order to create a account.
  • Register your Solution in in order to receive your Solution ID.
  • Enable your system to send and receive REST API messages, which includes creating your API keys and setting up your system to construct JWTs.

In addition to the above requirements, verify that your account has OAuth Application Management permissions. For more information, contact your account manager or customer support.


 

Choose Your Integration Method

Choose the integration method that matches how your client obtains consent to access another organization's data.

Compare the three integration methods

offers three OAuth 2.0 integration methods. The method you integrate to is determined by your organization type and how your client obtains consent from another organization to access their data.

The On-Behalf-Of integration method uses the authorization code grant. A merchant or user signs in to the and grants your client permission to act on their behalf. This integration method is also known as on-behalf-of, or OBO.

This table lists the organization types that can use the On-Behalf-Of integration method and a business example for each:

Organization TypeExample
AI agent enablerAn AI assistant performs payment operations, dispute handling, or reconciliation on behalf of a consenting merchant, limited to the permissions that the merchant approves.
Partner acquirer or partner resellerA bank portal initiates refunds or views reporting data on behalf of its merchants.
Technology partnerA SaaS platform accesses payment and reporting APIs on behalf of its merchants.
MerchantA merchant grants a trusted client permission to access account data or perform permitted API operations on the merchant's behalf.

The Machine-to-Machine (M2M) integration method uses the client credentials grant. Your system accesses APIs without user sign-in or merchant consent during the flow. The client and authenticate each other before issues an access token.

This table lists the organization types that can use the Machine-to-Machine integration method and a business example for each:

Organization TypeExample
AI agent enablerAn AI coding agent or automated process connects to MCP to perform reconciliation, reporting, or scheduled payment operations.
MerchantA merchant ERP or reconciliation system accesses payment APIs securely with OAuth tokens instead of static API keys.
Partner acquirer or partner resellerAn enterprise reporting platform or AI automation system aggregates data across multiple merchants.
Technology partnerA Remote MCP integration or embedded component calls APIs as a system client.

The OpenID Connect (OIDC) integration method uses the authorization code grant. Your client authenticates users with one of the supported sign-in methods:

  • Sign in through the .
  • Single sign-on, or SSO.
  • A federated identity relationship between and another platform.

This table lists the organization types that can use the OpenID Connect integration method and a business example for each:

Organization TypeExample
Partner acquirer or partner resellerA bank platform uses federated login with or coordinates sign-in across multiple merchants.
Technology partnerA partner portal uses SSO so merchants can sign in with their credentials.

OAuth 2.0 Integration Methods

Choose a method to see the remaining setup steps.

Last published: November 18, 2026

Not available for your audience

This page isn't available for your current audience selection.