/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. Optional deep_link 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).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Grant access to the Business Portal, an order, or a specific workflow on that order.

Returns an authenticating token and SSO URL where an agent can access the Business Portal and/or a specific order. Optional deep-link parameters open a specific workflow on that order. Targeted deep links must be enabled for your site by your PayNearMe Technical Account Manager (TAM).

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

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.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

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

Required when deep_link is included.

deep_link

string

enum

The workflow to open on the order after the agent signs in. Supported values:

take_payment: the order page, ready for a one-time payment
schedule_autopay: the order page with the Autopay setup window open
refund: the refund form for the payment named by payment_identifier
cancel_future_payment: the scheduled-payment page for the schedule named by schedule_identifier
deactivate_autopay: the Autopay schedule page for the schedule named by schedule_identifier

Requires order_identifier. Targeted deep links are off by default and must be enabled for your site by your PayNearMe Technical Account Manager (TAM). If targeted deep links are not enabled for the site, the call returns an error: "Deep links are not available for this merchant, contact PayNearMe for details." For refund, cancel_future_payment, and deactivate_autopay, order_identifier must be the pnm_order_identifier of an existing order. take_payment and schedule_autopay also accept a site_order_identifier or site_customer_identifier. A site_customer_identifier can match more than one order, and the workflow then opens on whichever order the agent's search finds. Send the pnm_order_identifier when it has to be a specific order.

Allowed:

payment_identifier

string

The pnm_payment_identifier of the payment to refund. Required when deep_link is refund. The value can be up to 64 characters. Sending payment_identifier without a deep_link returns an error. If deep_link names a workflow that does not use this identifier, the value is not included in the returned sso_url. The identifier is not checked when the link is created. If the payment cannot be found or refunded, the call still succeeds, and the agent lands on the order page with a message explaining why the refund did not open.

schedule_identifier

string

The pnm_scheduled_payment_identifier of the scheduled payment or Autopay schedule. Required when deep_link is cancel_future_payment or deactivate_autopay. The value can be up to 64 characters. Sending schedule_identifier without a deep_link returns an error. If deep_link names a workflow that does not use this identifier, the value is not included in the returned sso_url. The identifier is not checked when the link is created. If the schedule cannot be found or acted on, the call still succeeds, and the agent lands on the order page with a message explaining why that workflow did not open.

Responses

200API Keys Revoked