The /app API calls

Version: v2 2014-01-08

The app object represents an app on WePay. The following calls let you view and modify app objects on WePay:

App States

The app object has the following states and the following possible state transitions:

active The app is active
disabled The app was disabled by WePay, please contact api@wepay.com for more details and instructions on re-enabling your app.
deleted The app was deleted by the user.

App States Diagram

/app

This call allows you to lookup the details of your API application.

Arguments:

Parameter Required Type Description
client_id Yes Integer (64 bits) The integer client ID issued to the app, found on your application's dashboard.
client_secret Yes String (255 chars) The string client secret issued to the app, found on your application's dashboard.

Example

{
    "client_id": 77871,
    "client_secret": "9e9ebb315z"
}

Response:

</tbody> </table>

Response Type Description
api_version String (255 chars) The API version of the application. See API Versioning for more details.
client_id Integer (64 bits) The integer client ID issued to the app, found on your application's dashboard.
state String (255 chars) The state of the API application.

Possible values:

  • active
  • disabled
  • deleted
</td> </tr>
status String (255 chars) The approval status of the API application.
theme_object Theme Structure The theme structure (a JSON object, not a JSON serialized string) you want to be used for app's flows and emails
gaq_domains Array An array of Google Analytics domains associated with the app. See the analytics tutorial for more details.

Example

{
    "client_id": 77871,
    "state": "active",
    "status": "approved",
    "api_version": "2016-05-18"
}

/app/modify

This call lets you modify details of your API application (such as adding a theme for your app).

Arguments:

Parameter Required Type Description
client_id Yes Integer (64 bits) The integer client ID issued to the app, found on your application's dashboard.
client_secret Yes String (255 chars) The string client secret issued to the app, found on your application's dashboard.
theme_object No Theme Structure The theme structure (a JSON object, not a JSON serialized string) you want to be used for app's flows and emails
gaq_domains No Array An array of Google Analytics domains associated with the app. See the analytics tutorial for more details.

Example

{
    "client_id": 77871,
    "client_secret": "9e9ebb315z",
    "theme_object": {
        "name": "API Theme for API App: My Sample Application",
        "primary_color": "FFFFFF",
        "secondary_color": "000000",
        "background_color": "004C64",
        "button_color": "0084A0"
    }
}

Response:

Response Type Description
client_id Integer (64 bits) The integer client ID issued to the app, found on your application's dashboard.
status String (255 chars) The approval status of the API application.
theme_object Theme Structure The theme structure (a JSON object, not a JSON serialized string) you want to be used for app's flows and emails.

Note: the /theme_id/ value returned is generated by the WePay system.
gaq_domains Array An array of Google Analytics domains associated with the app. See the analytics tutorial for more details.

Example

{
    "client_id": 77871,
    "state": "active",
    "status": "approved",
    "api_version": "2016-05-18",
    "theme_object": {
        "theme_id": 265192344,
        "name": "API Theme for App: Test App",
        "primary_color": "FFFFFF",
        "secondary_color": "000000",
        "background_color": "004C64",
        "button_color": "0084A0"
    }
}