Activity
A profile's activities.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
GET |
/profiles/{profileId}/activities |
list |
OK - Successfully retrieved activities |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
activitys, err := client.Activity(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(activitys)
Lua
Construct client as shown in the Lua setup, then call the operations:
local activitys, err = client:Activity():list({ profile_id = 1 })
PHP
Construct client as shown in the PHP setup, then call the operations:
$activitys = $client->Activity()->list(["profile_id" => 1]);
Python
Construct client as shown in the Python setup, then call the operations:
activitys = client.Activity().list({"profile_id": 1})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
activitys = client.Activity.list({ "profile_id" => 1 })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const activitys = await client.Activity().list({ profile_id: 1 })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
createdOn |
string |
No | Timestamp when the activity was created. |
description |
string |
No | A short description that briefly summarizes the activity. |
id |
string |
No | Activity id. |
primaryAmount |
string |
No | A currency formatted text that describe the primary amount of transaction. |
resource |
object |
No | The resource associated with the activity. |
secondaryAmount |
string |
No | A currency formatted text that describe the secondary amount of transaction. |
status |
string |
No | Status of the Activity. |
title |
string |
No | Title of the Activity. |
type |
string |
No | Type of Activity. |
updatedOn |
string |
No | Timestamp when the activity was last modified. |
list
GET /profiles/{profileId}/activities
Operation ID: activityList.
Authentication: bearer token (UserToken) or bearer token (PersonalToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | The unique identifier of the profile. |
monetaryResourceType |
query |
enum: ACCRUAL_CHARGE, ACQUIRING_PAYMENT, ASSETS_WITHDRAWAL, BALANCE_CASHBACK, BALANCE_INTEREST, BALANCE_TRANSACTION, ... |
No | Filter activity by resource type. |
status |
query |
enum: REQUIRES_ATTENTION, IN_PROGRESS, UPCOMING, COMPLETED, CANCELLED |
No | Filter by activity status. |
since |
query |
string (date-time) |
No | Filter activity list after a certain timestamp. Use ISO 8601 format. |
until |
query |
string (date-time) |
No | Filter activity list until a certain timestamp. Use ISO 8601 format. |
nextCursor |
query |
string |
No | Pagination cursor returned from a previous response. Use the cursor value from the response to fetch the next page of activities. |
size |
query |
integer |
No | Desired size of query. Min 1, max 100, and default value is 10 if not specified. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: OK - Successfully retrieved activities
application/json
| Property | Type | Required | Description |
|---|---|---|---|
activities |
array of object |
No | Array of activity objects. |
activities[].createdOn |
string (date-time) |
No | Timestamp when the activity was created. |
activities[].description |
string |
No | A short description that briefly summarizes the activity. |
activities[].id |
string |
No | Activity id. |
activities[].primaryAmount |
string |
No | A currency formatted text that describe the primary amount of transaction. Value of this field is intended to have units in it and should not be treated as a numeric value. One example of primaryAmount would be: "Topping up 100 USD balance with 80 GBP". In this case 100 USD would be the primaryAmount of the activity. |
activities[].resource |
object |
No | The resource associated with the activity. |
activities[].resource.id |
string |
No | The unique identifier of the resource. |
activities[].resource.type |
enum: ACCRUAL_CHARGE, ACQUIRING_PAYMENT, ASSETS_WITHDRAWAL, BALANCE_CASHBACK, BALANCE_INTEREST, BALANCE_TRANSACTION, ... |
No | Type of Activity Monetary Resource. |
activities[].secondaryAmount |
string |
No | A currency formatted text that describe the secondary amount of transaction. Value of this field is intended to have units in it and should not be treated as a numeric value. Value can be empty if there is no good candidate as secondary amount. One example of secondaryAmount would be: "Topping up 100 USD balance with 80 GBP". In this case 80 GBP would be the secondaryAmount of the activity. |
activities[].status |
enum: REQUIRES_ATTENTION, IN_PROGRESS, UPCOMING, COMPLETED, CANCELLED |
No | Status of the Activity. - REQUIRES_ATTENTION - Requires an end user attention. - IN_PROGRESS - Indicates that this activity has yet to be completed. (Example: In progress Top Up) - UPCOMING - Indicates that this activity is scheduled to happen in the future. By default these activities will only be shown 2 days before the date. (Example: A scheduled transfer) - COMPLETED - Indicates that this activity is at its end state. (Example: A completed Top Up) - CANCELLED - Indicates that this activity is cancelled. (Example: A Top Up is cancelled) |
activities[].title |
string |
No | Title of the Activity. Value can be formatted with custom tags to put emphasis on important wordings. Supported custom tags: - <strong>: Indicates strong emphasis on words that the end user should pay attention to. - <positive>: Indicates a positive transaction (for example, top up to balance is successful). - <negative>: Indicates a negative transaction (for example, amount is deducted from a balance). - <strikethrough>: (Coming soon) Indicates the negation of an activity (for example, transfer is cancelled). |
activities[].type |
enum: ACQUIRING_PAYMENT, AUTO_CONVERSION, BALANCE_ADJUSTMENT, BALANCE_ASSET_FEE, BALANCE_CASHBACK, BALANCE_DEPOSIT, ... |
No | Type of Activity. |
activities[].updatedOn |
string (date-time) |
No | Timestamp when the activity was last modified. |
cursor |
string,null |
No | Pagination cursor. Pass this value as the nextCursor query parameter to fetch the next page of results. Returns null when there are no more pages. |
Example response:
{
"activities": [
{
"createdOn": "2023-01-01T00:00:00.000Z",
"description": "",
"id": "TU9ORVRBUllfQUNUSVZJVFk6OjE0NTU4OTk4OjpDQVJEX1RSQU5TQUNUSU9OOjozNDMwNDk=",
"primaryAmount": "150 JPY",
"resource": {
"id": "343049",
"type": "CARD_TRANSACTION"
},
"secondaryAmount": "1.50 SGD",
"status": "COMPLETED",
"title": "<strong>Test Payment</strong>",
"type": "CARD_PAYMENT",
"updatedOn": "2023-01-01T00:00:00.000Z"
}
],
"cursor": "WyJQUklPUklUWSIsMTAwMDAxNjY5NzA4MjI0MDAwMDE2MDk5OV0="
}
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.