curl --request GET \
--url https://apigwuat.corpay.com/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apigwuat.corpay.com/sessions/{sessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apigwuat.corpay.com/sessions/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apigwuat.corpay.com/sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apigwuat.corpay.com/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apigwuat.corpay.com/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"balanceStatus": "PROCESSING",
"sessionStatus": "CREATED",
"charger": {
"chargingStationName": "Drive_API_Test1_Station1",
"city": "Solna",
"connectorLabel": "1",
"evseId": "SE*CND*EC1*1",
"streetName": "Rättarvägen"
},
"balanceAmountMinor": "-2160",
"chargingKeyType": "virtual",
"connectorId": "O9UXK+YI5Q6i0FoI4qHwcA==",
"duration": "PT28.913S",
"energy": {
"unit": "WH",
"value": 57
},
"paymentMethod": "CREDIT_CARD",
"price": {
"currencyCode": "EUR",
"minorExclVat": 2785,
"minorInclVat": 1,
"vat": "17.5"
},
"receiptAvailable": true,
"sessionId": "AAdmD55q8Vz",
"site": "Drive_API_Test1",
"startTime": "2021-01-30T10:00:00.111Z",
"transactions": [
{
"paymentMethod": "CREDIT_CARD",
"paymentOutcome": "CHARGE",
"amount": {
"currencyCode": "EUR",
"minorExclVat": 2785,
"minorInclVat": 1,
"vat": "17.5"
},
"time": "2021-01-30T10:00:00.111Z"
}
]
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}Get a charging session
Returns charging session details
curl --request GET \
--url https://apigwuat.corpay.com/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apigwuat.corpay.com/sessions/{sessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apigwuat.corpay.com/sessions/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apigwuat.corpay.com/sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apigwuat.corpay.com/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apigwuat.corpay.com/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"balanceStatus": "PROCESSING",
"sessionStatus": "CREATED",
"charger": {
"chargingStationName": "Drive_API_Test1_Station1",
"city": "Solna",
"connectorLabel": "1",
"evseId": "SE*CND*EC1*1",
"streetName": "Rättarvägen"
},
"balanceAmountMinor": "-2160",
"chargingKeyType": "virtual",
"connectorId": "O9UXK+YI5Q6i0FoI4qHwcA==",
"duration": "PT28.913S",
"energy": {
"unit": "WH",
"value": 57
},
"paymentMethod": "CREDIT_CARD",
"price": {
"currencyCode": "EUR",
"minorExclVat": 2785,
"minorInclVat": 1,
"vat": "17.5"
},
"receiptAvailable": true,
"sessionId": "AAdmD55q8Vz",
"site": "Drive_API_Test1",
"startTime": "2021-01-30T10:00:00.111Z",
"transactions": [
{
"paymentMethod": "CREDIT_CARD",
"paymentOutcome": "CHARGE",
"amount": {
"currencyCode": "EUR",
"minorExclVat": 2785,
"minorInclVat": 1,
"vat": "17.5"
},
"time": "2021-01-30T10:00:00.111Z"
}
]
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}Authorizations
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:
curl --location '<BASE_URL>/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=......'
Path Parameters
Session id
Response
Session
Detailed charging session information.
Only available after a session has successfully started.
"O9UXK+YI5Q6i0FoI4qHwcA=="
Unique identifier of the charging session.
"AAdmD55q8Vz"
Current lifecycle status of the session.
CREATED, WAITING_TO_START, STARTED, WAITING_TO_STOP, STOPPED, COMPLETE, FAILED, UNKNOWN, STOP_FAILED Transactions linked to this charging session.
Show child attributes
Show child attributes
Type "Long". This field is not relevant for External Clearing (only used when using Plugsurfing's Payment Service Provider). Represents the remaining amount to be paid, expressed as a negative number. A value of 0 indicates the balance is fully paid. -2160 means there is an outstanding amount of 21.60 in the currency of the session.
"-2160"
Balance state after applying session costs.
PROCESSING, PAID, DEBT, REFUND Charger location and connector metadata.
Show child attributes
Show child attributes
Only available after a session has successfully started. Possible values are "tag", "card", "virtual" or "plug_and_charge".
"virtual"
The value is in ISO 8601 duration format
"PT28.913S"
Energy consumed during the session.
Show child attributes
Show child attributes
Returns the paymentMethod of the transaction with the earliest timestamp. This field is DEPRECATED and will be removed in future versions. Use session.transactions[].paymentMethod instead. Migration note: WRITE_OFF was renamed to NONE, where session.transactions[].paymentOutcome=WRITE_OFF is the replacement
CREDIT_CARD, EXTERNAL, PREPAID, WRITE_OFF Total session price.
Show child attributes
Show child attributes
Indicates whether a receipt can be downloaded.
Human-readable charging site name.
"Drive_API_Test1"
UTC timestamp when the session started.
"2021-01-30T10:00:00.111Z"