REST API Reference

For detailed API reference and documentation please read our Livecareer Ecommerce API documentation on Atlassian JIRA.

The Livecareer Ecommerce API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization & Authentication framework. Request and response payloads are formatted as JSON.

Table of Content

• API operations: API operation information.
• Authentication & Headers: Authentication and header details.
• Payments
  • Payment: Create payments or get details of one or more payments.
    • Create a payment
    • Look up a payment resource
    • List payment resources
  • Subscription: Get and create subscription (plan transactions).
    • Create a subscription
    • Get a subscription
    • Get subscription for a customer
    • Cancel a subscription
    • Cancel a subscription
  • Refunds:create subscription or one time purchase refund.
    • Create a subscription transaction refund
    • update the plan of a subscription during trial period
  • Authorizations: Capture, reauthorize, void, and look up authorizations.
    • Create an authorization
    • Void an authorization

API operations

The Livecareer Ecommerce REST APIs are supported in two environments. Use the Sandbox environment for testing purposes, then move to the live environment for production processing. Data and records created while accessing and using sandox environmnet can't be accessed on the production or Live environment URIs and vice versa.