Skip to main content
GET
Get a session's payment

Authorizations

Authorization
string
header
required

OAuth2 Client Credentials Flow

Path Parameters

sessionId
string
required

ID of the charging session.

Response

The session's payment.

The payment for one charging session. All amounts are integers in the minor unit of currency (cents for USD). billedAmount = preTaxChargingSessionCost + preTaxAdditionalFee − priceAdjustment.calculatedAdjustment + totalTaxAmount.

id
string
required

Unique ID, prefixed pmt_.

Example:

"pmt_I4FkDaG7zlcoJvXJDsSsw"

network
string
required

ID of the network the session belongs to.

session
string
required

ID of the charging session. A session has at most one payment.

sitePartners
string[]
required

IDs of the charging station's site partners when the payment was recorded.

location
string
required

ID of the charging station's location.

currency
string
required

ISO 4217 currency code of the session's rate.

Example:

"USD"

status
enum<string>
required

PENDING: recorded, but the money has not been collected from the driver yet. COLLECTED: the money has been collected.

Available options:
PENDING,
COLLECTED
paymentType
enum<string>
required

How the session was paid for. GUEST: a guest checkout without a driver account. PAYMENT_TERMINAL: a card reader at the station. ROAMING: a roaming partner's driver. DRIVER_ACCOUNT: a driver's account, through the app, an RFID card or a vehicle. FREE: the session cost nothing and had no known payer. UNKNOWN: the session had a cost but no known payer.

Available options:
GUEST,
PAYMENT_TERMINAL,
ROAMING,
FREE,
UNKNOWN,
DRIVER_ACCOUNT
costs
object
required

The session's charges per pricing component, as the session service calculated them. Tax-inclusive, before any discount.

Example:
usages
object
required

What the session used.

taxConfig
object | null
required

The location's tax rates when the payment was recorded. null when the location has no tax configured.

preTaxChargingSessionCost
integer
required

Pre-tax cost of the charging session before any discount, excluding additionalFee.

Example:

2000

preTaxCosts
object
required

Pre-tax value of each component of costs. They normally sum to preTaxChargingSessionCost.

Example:
priceAdjustment
object | null
required

The driver discount applied to the session, as it stood when the payment was recorded. null when no discount applied.

taxes
object
required

Tax included in billedAmount, by kind. These are amounts, not rates.

totalTaxAmount
integer
required

Sum of taxes.

Example:

247

billedAmount
integer
required

Total charged to the driver: tax-inclusive, after any discount, including additionalFee.

Example:

2078

recordedAt
string<date-time>
required

When the payment was recorded.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
additionalFee
integer

Fee charged on top of the session, tax-inclusive. Omitted when no fee was charged.

Example:

250

preTaxAdditionalFee
integer

Pre-tax share of additionalFee. Its sales tax is part of taxes.totalPercentSalesTax. Omitted when there is no additionalFee.

Example:

231

collectedAt
string<date-time> | null

When the payment was collected. Not set while status is PENDING.