Account category events
The following webhook events are supported under Account category:
Account status
Tango supports sending webhook events when a customer account on your platform changes status. It ensures you receive timely notifications about changes such as accounts becoming active, inactive, disabled, frozen, or deleted. To subscribe to AccountStatus
events, create a subscription with thePOST {URI}/webhooks
and then select AccountStatus
for eventType
and ACCOUNTS
for category.
Use case
Acme, a wellness incentive company, wants to be notified whenever one of their customer accounts changes status in Tango. For example, they need to know immediately if an account freezes so they can take necessary actions.
To achieve this goal and stay proactive, Acme subscribes to AccountStatus
event using POST {URI}/webhooks
. They receive notifications whenever one of their customer accounts becomes frozen, disabled, inactive, or active again.
List of account statuses
The following account statuses are available with the AccountStatus
subscription:
Status | Description |
---|---|
Active | The account is Active, allowing you to conduct normal processing, funding, and placing orders. |
Inactive | The account is Inactive meaning you cannot fund or place orders. Unlike a Disabled account, you cannot change the Inactive status. The account might be inactive due to an internal request to close a platform or account(s). Contact your Customer Success Manager (CSM) at [email protected] for questions or help. |
Disabled | You can Disable your account without any assistance from Tango. Once your account is disabled, no transactions are allowed. For example, you can temporarily disable your seasonal account to prevent any order or funding activity outside the designated time, or you can take your account offline for auditing purposes. You can also disable an account to determine its status. |
Frozen | Your account has reached the velocity threshold. No transaction can be processed until the freeze is lifted by Tango. Contact your Customer Success Manager (CSM) at [email protected] for questions or assistance. |
Deleted | The account has been deleted and no longer exists. |
When creating a subscription for account status, use thePOST {URI}/webhooks
and enter the following body parameters:
Body Params | Type | Requirement | Description |
---|---|---|---|
url | string | required | Enter the URL of your webhook listener. It must be a valid URL. |
categories | array of strings | *optional | Enter ACCOUNT for categories. Optional if you're specifying eventTypes. |
eventTypes | array of strings | *optional | Enter AccountStatus for eventTypes. Optional if you're specifying categories. |
*See the description.
Here is a response payload of AccountStatus
:
{
"eventId": "45a2ddda-a159-42aa-a3ec-2f7b206a8495",
"revision": 6,
"category": "ACCOUNT",
"eventType": "AccountStatus",
"eventOccurredAt": "2024-06-17T20:31:19.852635900Z",
"eventData": {
"identifier": "A28448941",
"status": "INACTIVE"
}
}
The following response codes are supported by webhook endpoints:
- 200 Successful
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
Transaction
Tango supports sending webhook events when funds are added, removed, or transferred to/from my Tango account. Subscribing to the Transaction event ensures you receive timely notifications for such changes. To subscribe, create a subscription using POST {URI}/webhooks
. Select Transaction
for the eventType
and ACCOUNTS
for the category.
Use case
Acme, a wellness incentive company, would like to get notified whenever there's a new transaction event on an account. To achieve this goal and to stay proactive, Acme subscribes to Transaction
event using POST {URI}/webhooks
and receives notification whenever funds have been added, removed, or transferred to or from a Tango account
When creating a subscription for the transaction event, use thePOST {URI}/webhooks
and enter the following values:
Body Params | Type | Requirement | Description |
---|---|---|---|
url | string | required | Enter the URL of your webhook listener. It must be a valid URL. |
categories | array of strings | *optional | Enter ACCOUNT for categories. Optional if you're specifying eventTypes. |
eventTypes | array of strings | *optional | Enter Transaction for eventTypes. Optional if you're specifying categories. |
*See the description.
Here is a response payload of Transaction
:
"category": "Account",
"eventType": "Transaction",
"eventOccurredAt": "2024-11-09T04:25:36.4844028Z",
"eventData": {
"accountIdentifier":
"Transaction Type":
"Date":
"Funding Method":
"Funding Type::
"Funding Invoice Number":
"Transaction ID":
"Currency":
"Amount":
"Note":
}
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
- 200 Successful
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
Low balance (🚧 Coming soon)
Tango supports sending webhook events when an account reaches a predefined low balance. Subscribing to the Transaction event ensures you receive timely notifications for such changes. To subscribe, create a subscription using POST {URI}/webhooks
. Select LowBalance
for the eventType
and ACCOUNTS
for the category.
Use case
Acme, a wellness incentive company, would like to get notified whenever their balance goes under a certain amount. When creating a subscription for the transaction event, use thePOST {URI}/webhooks
and enter the following values:
Body Params | Type | Requirement | Description |
---|---|---|---|
url | string | required | Enter the URL of your webhook listener. It must be a valid URL. |
categories | array of strings | *optional | Enter ACCOUNT for categories. Optional if you're specifying eventTypes. |
eventTypes | array of strings | *optional | Enter LowBalance for eventTypes. Optional if you're specifying categories. |
*See the description.
Here is a response payload of LowBalance
:
{
"prevCursor": "QUNDT1VOVA==",
"nextCursor": "QUNDT1VOVA==",
"prevPageAvailable": false,
"nextPageAvailable": false,
"maxResults": 10,
"items": [
{
"category": "ACCOUNT",
"eventTypes": [
"LowBalance",
"AccountStatus",
"Transaction"
]
}
],
"numberOfElements": 1
}
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
- 200 Successful
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
Updated 12 days ago