The Imburse Marketplace is where you will find all the Apps Imburse can integrate with and is the starting place for installing Apps into your Tenant.
An App is an integration component that you configure that permits Imburse to communicate with the Apps’ provider to carry out some task on your behalf.
The following table illustrates some of the Apps, with their Provider and purpose.
App Name | App Id | Provider | Purpose |
---|---|---|---|
Braintree | BRAINTREE_SDK | Braintree Payments | Collect payments using credit cards + PayPal |
Tango Card | TANGOCARD_RAAS | Tango Card | Payout rewards |
Where the Provider is not Imburse, you may need an existing Account with that Provider. For some Providers, such as Tango Card, Imburse can create new accounts for you.
The Marketplace has endpoints to perform the following functions:
Access Token
derived from a Tenant API Key
.Returns a list of all Apps available in the Marketplace.
Replace the {access-token}
placeholder value with the Access Token
value.
curl --location --request POST "https://sandbox-api.imbursepayments.com/v1/marketplace/apps" \
--header "Authorization: Bearer {access-token}" \
--header "Content-Type: application/json"
}"
Response Code:
200 - OK
[
{
"appId": "BRAINTREE_SDK",
"name": "Braintree"
},
{
"appId": "TANGOCARD_RAAS",
"name": "Tangocard"
}
]
Returns the details of a specific App Id from the Marketplace.
Use the following endpoint to update any installed App.
https://sandbox-api.imbursepayments.com/v1/marketplace/apps/{AppId}
Replace the {AppId}
placeholder value with the App Id for the App you want to get.
In our example request, we’ll be using the Braintree App (AppId BRAINTREE_SDK
).
Replace the {access-token}
placeholder value with the Access Token
value.
curl --location --request POST "https://sandbox-api.imbursepayments.com/v1/marketplace/apps/braintree_sdk" \
--header "Authorization: Bearer {access-token}" \
--header "Content-Type: application/json"
}"
Response Code:
200 - OK
{
"appId": "BRAINTREE_SDK",
"name": "Braintree"
}
Use the following endpoint to install any App from the Marketplace.
https://sandbox-api.imbursepayments.com/v1/marketplace/apps/{AppId}/install
Replace the {AppId}
placeholder value with the App Id for the App you want to install.
In our example request, we’ll be using the Braintree App (AppId BRAINTREE_SDK
).
Note: The body of the request will be different between Apps.
Replace the {access-token}
placeholder value with the Access Token
value.
curl --location --request POST "https://sandbox-api.imbursepayments.com/v1/marketplace/apps/braintree_sdk/install" \
--header "Authorization: Bearer {access-token}" \
--header "Content-Type: application/json" \
--data "{
\"merchantId\": \"Ov6Y2kneVSyJSpoXBVnAGw0OTDzl0Jkg\",
\"privateKey\": \"gnD1Yrrw6KLes64J5A3Eb8vs4a8Zj2sA\",
\"publicKey\": \"NU0uRxhTpvCiF8QdkxFqEgAsOqmpX7i4\",
\"settings\": [
{
\"currency\": \"EUR\",
\"countries\": [],
\"merchantAccountId\": \"euro-account\",
\"description\": \"Euro Account\"
}
]
}"
Response Code:
200 - OK
{
"merchantId": "Ov6Y2kneVSyJSpoXBVnAGw0OTDzl0Jkg",
"privateKey": "gnD1Yrrw6KLes64J5A3Eb8vs4a8Zj2sA",
"publicKey": "NU0uRxhTpvCiF8QdkxFqEgAsOqmpX7i4",
"settings": [
{
"currency": "EUR",
"countries": [],
"merchantAccountId": "euro-account",
"description": "Euro Account"
}
]
}
Use the following endpoint to configure any installed App.
https://sandbox-api.imbursepayments.com/v1/apps/installed/{AppId}/configuration
Replace the {AppId}
placeholder value with the App Id for the App you want to update.
In our example request, we’ll be using the Braintree App (AppId BRAINTREE_SDK
).
Note: The body of the request will be different between Apps.
Replace the {access-token}
placeholder value with the Access Token
value.
curl --location --request POST "https://sandbox-api.imbursepayments.com/v1/apps/installed/braintree_sdk/configuration" \
--header "Authorization: Bearer {access-token}" \
--header "Content-Type: application/json" \
--data "{
\"merchantId\": \"Ov6Y2kneVSyJSpoXBVnAGw0OTDzl0Jkg\",
\"privateKey\": \"gnD1Yrrw6KLes64J5A3Eb8vs4a8Zj2sA\",
\"publicKey\": \"NU0uRxhTpvCiF8QdkxFqEgAsOqmpX7i4\",
\"settings\": [
{
\"currency\": \"EUR\",
\"countries\": [],
\"merchantAccountId\": \"euro-account\",
\"description\": \"Euro Account\"
}
]
}"
Response Code:
200 - OK
{
"merchantId": "Ov6Y2kneVSyJSpoXBVnAGw0OTDzl0Jkg",
"privateKey": "gnD1Yrrw6KLes64J5A3Eb8vs4a8Zj2sA",
"publicKey": "NU0uRxhTpvCiF8QdkxFqEgAsOqmpX7i4",
"settings": [
{
"currency": "EUR",
"countries": [],
"merchantAccountId": "euro-account",
"description": "Euro Account"
}
]
}
You can only uninstall an App if it is not being referenced in an existing Collection Scheme or Payout Scheme. Attempting to uninstall a referenced App will fail with an appropriate error message.
Use the following endpoint to update any installed App.
https://sandbox-api.imbursepayments.com/v1/marketplace/installed/{AppId}/uninstall
Replace the {AppId}
placeholder value with the App Id for the App you want to uninstall.
In our example request, we’ll be using the Braintree App (AppId BRAINTREE_SDK
).
curl --location --request POST "https://sandbox-api.imbursepayments.com/v1/apps/installed/braintree_sdk/uninstall" \
--header "Authorization: Bearer {access-token}" \
--header "Content-Type: application/json"
Response Code:
200 - OK