Agent SSO Token Authentication
POST /agent_sso
Changed onAfter your PayNearMe Technical Account Manager has configured your site to allow for Agent SSO Token Authentication, you can begin submitting calls to the /agent_sso endpoint. The call returns an authenticating token and the SSO URL where the agent can access the Business Portal and/or the specific order. Optional <code>deep_link</code> parameters can open a specific workflow on that order, such as a refund or an Autopay setup. Targeted deep links are off by default and must be enabled for your site by your PayNearMe Technical Account Manager (TAM).
Request
- Base URLhttps://api.paynearme-sandbox.com/json-api
- Auth
- OAuth 2Client credentialsToken URLhttps://login.paynearme.com/oauth/token
- or API key in query parameter signature
Request body
Response
API Keys Revoked
Example response
{
"status": "ok",
"token": "Sklb-GelNo-mVwaEgZxkXI-uWc0oFRgOZxScNVEEePA",
"token_expires": "2023-03-21 11:26:46 -0700",
"sso_url": "https://pro.paynearme-sandbox.com/single_sign_on/Sklb-GelNo-mVwaEgZxkXI-uWc0oFRgOZxScNVEEePA"
}Changes
- breaking
removed the success response with the status
- info
api operation id
agent_ssowas added - info
added the new optional request property
deep_link
5 more changes in this revision
- breaking