Skip to main content
The MarketONE OpenAPIs provide predictable, resource-oriented URLs, and use HTTP response codes to indicate API errors. The APIs utilize built-in HTTP features, such as HTTP authentication and HTTP verbs, which are commonly used by off-the-shelf HTTP clients. MarketONE Rest API Design The MarketONE OpenAPIs are organized by resource. A resource is a set of data that Merchants can access, such as a customer’s Partner subscription. Merchants can access resources to manage their integration with MarketONE. Merchants can use an HTTP client in any programming language to interact with the MarketONE OpenAPIs. Parent topic:MarketONE APIs

​
Merchant Resources

Merchants can access the following resources through the endpoints that are listed in each section.
  • PartnerSubscription
  • Entitlement
  • Transaction
Note: To view the parameters for each request, see the MarketONE OpenAPI.

​
PartnerSubscription

The PartnerSubscription resource represents the customer’s subscription to the Merchant service within the MarketONE OpenAPI architecture. This is where changes related to the customer’s Partner subscription service are made. This is in contrast to the Reseller’s side of the integration, which is where changes to billing (Merchant-managed flow) and other Reseller-related functionality are made. The sections below show which endpoints the Merchant can use to access and update the PartnerSubscription resource in the Platform-managed and Merchant-managed flows. Platform-Managed APIs The Merchant can use these endpoints to update the PartnerSubscription resource or get information about it.
  • PUT /partnerSubscription/{id}: The Merchant uses this call to update a specific PartnerSubscription status. For example, after the Merchant has activated the user’s subscription, the Merchant makes this request.
  • GET /partnersub/v3/partnerSubscription/{id}: The Merchant uses this call to get details about the Partner Subscription.
  • PUT /partnersub/v3/partnerSubscription/{id}: The Merchant uses this call to update the details about the Partner Subscription. This call is normally made to update the status after the end user has activated the service.
Merchant-Managed APIs The Merchant can use these endpoints to create and manage the billing relationship with the Reseller (Service Provider), as well as to create and manage the Partner subscription relationship.
  • POST /partnerSubscription: The Merchant uses this endpoint to create a billing relationship with the Reseller, set up the Partner subscription relationship, and validate the account. It also triggers the sending of a PIN to the user.
  • GET /partnerSubscription/{partnerSubId}: The Merchant uses this call to get details about a Partner subscription.
  • POST /partnerSubscription/{id}/validate: The Merchant uses this call to validate the PIN generated by MarketONE against the value entered by the user. This API verifies the user’s identity.
  • POST /partnerSubscription/{id}/confirm: Once all the necessary information has been collected and validated, the Merchant uses this call to confirm that the billing partner subscription should be activated for billing. This Partner subscription ID can be used to submit transactions. Note: This API is optional. If the Merchant chooses not to use this API, it will be configured in MarketONE so that POST /partnerSubscription/{id}/validate returns an ACTIVE status instead.
  • POST /partnerSubscription/{id}/resend: This API triggers the re-sending of a PIN previously triggered by POST /partnerSubscription.
  • POST /partnerSubscription/{id}/cancel: This API is used to cancel an active billing partner subscription relationship. ​After receiving this request, MarketONE will​ no longer accept transactions against Partner subscriptions.​

​
Entitlement (Platform-Managed Only)

The Entitlement resource represents the customer’s entitlement to a Merchant’s product in the Platform-managed flow.
  • GET /entitlement?filter={id}: The Merchant uses this call to get details about the entitlement.

​
Transaction (Merchant-Managed Only)

The Transaction resource represents a subscription charge or refund in the Merchant-managed flow.
  • POST /transaction: The Merchant uses this call to post the charges of a subscription to MarketONE, which will relay the charge to the Reseller (Service Provider). This API is used for both one time charges and recurring charges. For recurring charges, Merchants are responsible for posting the charge at the beginning of each billing cycle. MarketONE then injects the charge to the Reseller’s (Service Provider’s) billing system.
  • POST /transaction/{id}/refund: The Merchant uses this call to post the refund of a subscription to MarketONE, which will relay the refund to the Reseller (Service Provider).
  • GET /transaction/{transactionId}/refund/{refundId}: The Merchant can use this call to get details about a particular transaction.
Parent topic:MarketONE OpenAPIs