Admin APIs
At its core, SyncTV is an API driven service. The APIs themselves are easy enough for developers to understand, but understanding the ecosystem is a little trickier. We've created the following tutorials to help you get your head around it.

Topics:

  • Xbox

This document describes the API for XBox billing.

Note:
Each call to the SyncTV V2 API described in this section requires a MD5 hash signature.
See the Authorization (User) API for details on generating the MD5 hash signature.
Actions

Url:

  • [GET] /api/v2/billing/xbox/request_order_token.[xml|json]

Returns order token base64 encoded xml string as specified in Xbox Wallet documentation.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
  • (Integer) invoice_id
    The unique identifier for the invoice under which the transaction is happening.
Example Request

[GET] https://service_name.synctv.com/api/v2/billing/xbox/request_order_token.xml?invoice_id=123&access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <order_token>DSF32a5f3sdf253</order_token>
  <code>1</code>
  <message>Successfully completed.</message>
</response>
Response Fields:
  • (String) order_token
    Base64 encoded SAML XML that represent signed order token for XBox live

Url:

  • [POST] /api/v2/billing/xbox/process_receipt.[xml|json]

Process base64 encoded receipt returned from XBox Live.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
  • (Integer) invoice_id
    Identifier number for invoice under which transaction is happening
  • (String) receipt
    Base64 encoded XML receipt sent from XBOX Live
Example Request

[POST] https://service_name.synctv.com/api/v2/billing/xbox/process_receipt.xml?invoice_id=123&receipt=s32refrgdfdfg&access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <code>1</code>
  <message>Successfully completed.</message>
</response>