/agent_sso

post

https://api.paynearme-sandbox.com/json-api/agent_sso

After 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.

Body Params

Grant Access to the Business Portal and/or an Order.

site_identifier

string

required

Defaults to S2411573363

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

The version of the API. This version must match the version associated with your API key pair.

signature

string

required

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

agent_email

string

required

Defaults to [email protected]

The email address of the agent.

agent_name

string

required

Defaults to Rory smith

The name of the agent.

agent_role

string

required

Defaults to agent

The name of the role set for this agent.

order_identifier

string

Defaults to 84338052224

One of the following order identifiers, which can be used to locate the order after the agent authenticates into the Business Portal

pnm_order_identifier
site_order_identifier
site_customer_identifier

Response

Language

URL

Response

Choose an example:

application/json

201API Keys Revoked