Skip to main content
POST
/
sessions
/
start
Start a remote charging session
curl --request POST \
  --url https://apigwuat.corpay.com/sessions/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorId": "aHeS4zN1UjzJf/HVDH66SbaItXqHvfLxexulktxTqJavgcbozuV9KJGqNYjmaQPwTb4Ck9wTZcWeEdfeco1srw==",
  "keyIdentifier": "BnZd3qp87z"
}
'
{
  "sessionId": "AAdmD55q8Vz"
}

Documentation Index

Fetch the complete documentation index at: https://api.corpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use OAuth2 client credentials to obtain a bearer token.

UAT token endpoint: POST https://apigwuat.corpay.com/keycloak/realms/longship/protocol/openid-connect/token

Example:

curl --location 'https://apigwuat.corpay.com/keycloak/realms/longship/protocol/openid-connect/token' \
--header 'accept: application/json' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=.......' \
--data-urlencode 'client_secret=......'

Body

application/json

Session start request identifying connector and charging key.

​
connectorId
string
required

Connector identifier to start charging on.

Example:

"aHeS4zN1UjzJf/HVDH66SbaItXqHvfLxexulktxTqJavgcbozuV9KJGqNYjmaQPwTb4Ck9wTZcWeEdfeco1srw=="

​
keyIdentifier
string
required

Charging key identifier used for authorization.

Example:

"BnZd3qp87z"

Response

OK

Session start response containing a session identifier.

​
sessionId
string

This session id should be stored and used in other endpoints.

Example:

"AAdmD55q8Vz"