Skip to main content
POST
Start a remote charging session

Authorizations

Authorization
string
header
required

Use OAuth2 client credentials to obtain a bearer token.

Token endpoint: POST <BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token

Use the same base URL as the selected API server:

  • Test environment: https://apigwuat.corpay.com
  • Production environment: https://apigw.corpay.com

Example:

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"