Manually expire a session

POST

/v1/hosted-sessions/{sessionId}/expire

const url = 'https://api.govifi.com/v1/hosted-sessions/example/expire';
const options = {
  method: 'POST',
  headers: {'X-Payment-Account-Uid': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.govifi.com/v1/hosted-sessions/example/expire \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Payment-Account-Uid: example'

Authorizations

cognitoAdmin

Parameters

Path Parameters

sessionId

required

string

/^cs_[A-Za-z0-9]+$/

Header Parameters

X-Payment-Account-Uid

required

string

Identifies the tenant (payment account) for the server-side, Cognito-admin-authenticated operations (create / update / expire). Same header /api/paymentaccounts uses.

Responses

200

Expired