Marketplace

Marketplace operations

Get list of Apps

Role Requirements

tenant-app-read or tenant-admin

Description

Gets the list of all available Apps in the marketplace.

Securitybearer

Request

header Parameters

x-account-id required	string The Account Id.
x-tenant-id required	string The Tenant Id.
x-correlation-id	string Correlation Id for the request.

Responses

200

OK - Returns the App response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v1/marketplace/apps

Request samples

Response samples

200

No sample

Get an App

Role Requirements

tenant-app-read or tenant-admin

Description

Gets an App from the marketplace by the appId.

Securitybearer

Request

path Parameters

appId

required

string

The App Id.

Example: BOTTOMLINE,BRAINTREE,CHECKOUT_DOT_COM,CITI,GLOBAL_PAYMENTS,GOCARDLESS,MVOUCHER,SIBS_DPG,STRIPE,TANGOCARD_RAAS

header Parameters

x-account-id required	string The Account Id.
x-tenant-id required	string The Tenant Id.
x-correlation-id	string Correlation Id for the request.

Responses

200

OK - Returns the App response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v1/marketplace/apps/{appId}

Request samples

Response samples

200

No sample

Install an App

Role Requirements

tenant-app-write or tenant-admin

Description

Installs an App for a tenant by the specified appId.

Securitybearer

Request

path Parameters

appId

required

string

The App Id.

header Parameters

x-account-id required	string The Account Id.
x-tenant-id required	string The Tenant Id.
x-correlation-id	string Correlation Id for the request.

Responses

202

No content returned when successful.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

post/v1/marketplace/apps/{appId}/install

Request samples

Get list of installed Apps

Role Requirements

tenant-app-read or tenant-admin

Description

Gets a list of a tenants installed Apps.

To install an App, call Marketplace > Install an App.

Securitybearer

Request

header Parameters

x-account-id required	string The Account Id.
x-tenant-id required	string The Tenant Id.
x-correlation-id	string Correlation Id for the request.

Responses

200

OK - Returns the Apps response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v1/apps/installed

Request samples

Response samples

200

No sample

Uninstall an App

Role Requirements

tenant-app-write or tenant-admin

Description

Uninstalls an existing installed App by the appId.

Securitybearer

Request

path Parameters

appId

required

string

The App Id.

header Parameters

x-account-id required	string The Account Id.
x-tenant-id required	string The Tenant Id.
x-correlation-id	string Correlation Id for the request.

Responses

200

OK - No Content

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

post/v1/apps/installed/{appId}/uninstall

Request samples