Download OpenAPI specification:Download
Mobile API is a wrapper layer that serves as a mobile app gateway (or proxy) to Athena for some of the more complex requests. Authentication is done on Athena side, so endpoints usually require client_id
, client_secret
and Authorization
headers to be specified. For more information about Atehna authentication, see Athena's API docs. For more information about this service, check out the project's GitHub page.
This endpoint takes the original set of user properties that Athena returns for user account data from /users/me
, and adds corporate information from /corporations/me
.
client_id required | string Example: maobkd9284tjh68eagfb4vv29enfs Header token for a unique client ID (required in Athena) |
client_secret required | string Example: qwertyuio34567896789 Header token that is uniquely paired with a client ID (required in Athena) |
Authorization required | string Example: Bearer gadgoiaj3nm3b153goiudfsasdoiu Header token used as Bearer authentication (required in Athena) |
{- "corporation_uuid": "afsuio-k1j3n5-iosjafoqmenthfgpjo-f2e9i0f0",
- "corporation_name": "Zulu Corporation",
- "rewards_numbers": [
- { }
], - "rewards_programs": [
- { }
]
}
Particularly useful for reporting, tracking and mobile app home screen, this endpoint will collect information from booking data sources about the past, current and upcoming rides for the current user.
client_id required | string Example: maobkd9284tjh68eagfb4vv29enfs Header token for a unique client ID (required in Athena) |
client_secret required | string Example: qwertyuio34567896789 Header token that is uniquely paired with a client ID (required in Athena) |
Authorization required | string Example: Bearer gadgoiaj3nm3b153goiudfsasdoiu Header token used as Bearer authentication (required in Athena) |
{- "numberOfFinishedRides": 12,
- "numberOfTotalBookings": 301,
- "earliestUnfinishedRide": "A 'booking' object from Athena"
}
Combines current user's private and corporate payment methods (if user belongs to a corporation). This endpoint also adds a synthetic Invoice payment method in case the user's corporation allows collective invoicing.
kinds | string Example: kinds=credit_card,paypal_account Query param, specifies kinds of payment methods to fetch (comma-separated). Currently supported are |
client_id required | string Example: maobkd9284tjh68eagfb4vv29enfs Header token for a unique client ID (required in Athena) |
client_secret required | string Example: qwertyuio34567896789 Header token that is uniquely paired with a client ID (required in Athena) |
Authorization required | string Example: Bearer gadgoiaj3nm3b153goiudfsasdoiu Header token used as Bearer authentication (required in Athena) |
{- "defaultUuid": "ofij1o-asoifjas-09f09as0f9a-490usf09-1mwerml",
- "corporation": {
- "uuid": "adg099-n513ji5j1-a09dgua0kj3n31580",
- "name": "Zulu Corporation"
}, - "paymentMethods": [
- {
- "uuid": "ofij1o-asoifjas-09f09as0f9a-490usf09-1mwerml",
- "type": "string",
- "ownership": "string",
- "isDefault": true,
- "creditCardIssuer": "MasterCard",
- "lastDigits": "3012",
- "creditCardExpiryMonth": "09",
- "creditCardExpiryYear": "2043",
- "creditCardHolder": "Max Mustermann",
- "accountEmail": "john@blacklane.com",
- "corporation": {
- "uuid": "adg099-n513ji5j1-a09dgua0kj3n31580",
- "name": "Zulu Corporation"
}
}
]
}
Payment methods are created using the payment processor's SDK (such as Braintree). After creating a payment method, payment processor should provide a unique nonce as a result of that operation - this nonce should be sent to this endpoint to be able to connect our systems with the provided payment data. No real card or account data is ever sent through this API, it just accepts nonces.
client_id required | string Example: maobkd9284tjh68eagfb4vv29enfs Header token for a unique client ID (required in Athena) |
client_secret required | string Example: qwertyuio34567896789 Header token that is uniquely paired with a client ID (required in Athena) |
Authorization required | string Example: Bearer gadgoiaj3nm3b153goiudfsasdoiu Header token used as Bearer authentication (required in Athena) |
is_business_card | boolean Internal property, set it only if this card should be associated with the user's corporation. In case the user does not belong to a corporation, this flag is ignored |
payment_method_nonce | string <nonce> A unique nonce that comes from the payment processor (such as Braintree) after creating a payment method using their SDK |
{- "is_business_card": true,
- "payment_method_nonce": "gsomfg2935i029efdokmsbfme"
}
{- "uuid": "ofij1o-asoifjas-09f09as0f9a-490usf09-1mwerml",
- "type": "string",
- "ownership": "string",
- "isDefault": true,
- "creditCardIssuer": "MasterCard",
- "lastDigits": "3012",
- "creditCardExpiryMonth": "09",
- "creditCardExpiryYear": "2043",
- "creditCardHolder": "Max Mustermann",
- "accountEmail": "john@blacklane.com",
- "corporation": {
- "uuid": "adg099-n513ji5j1-a09dgua0kj3n31580",
- "name": "Zulu Corporation"
}
}
Responds with more information about the given payment method, such as security verification config (i.e. 3DS token data)
uuid required | string <uuid> (paymentMethodUuid) Example: ofij1o-asoifjas-09f09as0f9a-490usf09-1mwerml Path variable, uniquely identifies a payment method |
currency required | string Example: currency=EUR Query param, specifies the currency for which to fetch the security configuration. It should be in |
client_id required | string Example: maobkd9284tjh68eagfb4vv29enfs Header token for a unique client ID (required in Athena) |
client_secret required | string Example: qwertyuio34567896789 Header token that is uniquely paired with a client ID (required in Athena) |
Authorization required | string Example: Bearer gadgoiaj3nm3b153goiudfsasdoiu Header token used as Bearer authentication (required in Athena) |
{- "paymentMethod": {
- "uuid": "ofij1o-asoifjas-09f09as0f9a-490usf09-1mwerml",
- "type": "string",
- "ownership": "string",
- "isDefault": true,
- "creditCardIssuer": "MasterCard",
- "lastDigits": "3012",
- "creditCardExpiryMonth": "09",
- "creditCardExpiryYear": "2043",
- "creditCardHolder": "Max Mustermann",
- "accountEmail": "john@blacklane.com",
- "corporation": {
- "uuid": "adg099-n513ji5j1-a09dgua0kj3n31580",
- "name": "Zulu Corporation"
}
}, - "verification": {
- "3ds": true,
- "nonce": "a8s9ufjiomkrkfomw9d0fis9d009ijmork",
- "braintree_client_token": "kromji900d9sif0d9wmofkrkmoijfu9s8a"
}
}