All URIs are relative to https://sandbox.finapi.io
| Method | HTTP request | Description |
|---|---|---|
| CreateNotificationRule | Post /api/v1/notificationRules | Create a new notification rule |
| DeleteAllNotificationRules | Delete /api/v1/notificationRules | Delete all notification rules |
| DeleteNotificationRule | Delete /api/v1/notificationRules/{id} | Delete a notification rule |
| GetAndSearchAllNotificationRules | Get /api/v1/notificationRules | Get and search all notification rules |
| GetNotificationRule | Get /api/v1/notificationRules/{id} | Get a notification rule |
NotificationRule CreateNotificationRule(ctx).NotificationRuleParams(notificationRuleParams).XRequestId(xRequestId).Execute()
Create a new notification rule
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
notificationRuleParams := *openapiclient.NewNotificationRuleParams("NEW_ACCOUNT_BALANCE") // NotificationRuleParams | Notification rule parameters
xRequestId := "xRequestId_example" // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.NotificationRulesApi.CreateNotificationRule(context.Background()).NotificationRuleParams(notificationRuleParams).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotificationRulesApi.CreateNotificationRule``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateNotificationRule`: NotificationRule
fmt.Fprintf(os.Stdout, "Response from `NotificationRulesApi.CreateNotificationRule`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateNotificationRuleRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationRuleParams | NotificationRuleParams | Notification rule parameters | |
| xRequestId | string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IdentifierList DeleteAllNotificationRules(ctx).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Delete all notification rules
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xHTTPMethodOverride := "xHTTPMethodOverride_example" // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. (optional)
xRequestId := "xRequestId_example" // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.NotificationRulesApi.DeleteAllNotificationRules(context.Background()).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotificationRulesApi.DeleteAllNotificationRules``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteAllNotificationRules`: IdentifierList
fmt.Fprintf(os.Stdout, "Response from `NotificationRulesApi.DeleteAllNotificationRules`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDeleteAllNotificationRulesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xHTTPMethodOverride | string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. | |
| xRequestId | string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteNotificationRule(ctx, id).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Delete a notification rule
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int64(789) // int64 | Identifier of the notification rule to delete
xHTTPMethodOverride := "xHTTPMethodOverride_example" // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. (optional)
xRequestId := "xRequestId_example" // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.NotificationRulesApi.DeleteNotificationRule(context.Background(), id).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotificationRulesApi.DeleteNotificationRule``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Identifier of the notification rule to delete |
Other parameters are passed through a pointer to a apiDeleteNotificationRuleRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xHTTPMethodOverride | string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. | xRequestId | string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NotificationRuleList GetAndSearchAllNotificationRules(ctx).Ids(ids).TriggerEvent(triggerEvent).IncludeDetails(includeDetails).XRequestId(xRequestId).Execute()
Get and search all notification rules
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
ids := []int64{int64(123)} // []int64 | A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)
triggerEvent := "triggerEvent_example" // string | If specified, then only notification rules with given trigger event will be regarded. (optional)
includeDetails := true // bool | If specified, then only notification rules that include or not include details will be regarded. (optional)
xRequestId := "xRequestId_example" // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.NotificationRulesApi.GetAndSearchAllNotificationRules(context.Background()).Ids(ids).TriggerEvent(triggerEvent).IncludeDetails(includeDetails).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotificationRulesApi.GetAndSearchAllNotificationRules``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAndSearchAllNotificationRules`: NotificationRuleList
fmt.Fprintf(os.Stdout, "Response from `NotificationRulesApi.GetAndSearchAllNotificationRules`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAndSearchAllNotificationRulesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| ids | []int64 | A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. | |
| triggerEvent | string | If specified, then only notification rules with given trigger event will be regarded. | |
| includeDetails | bool | If specified, then only notification rules that include or not include details will be regarded. | |
| xRequestId | string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NotificationRule GetNotificationRule(ctx, id).XRequestId(xRequestId).Execute()
Get a notification rule
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int64(789) // int64 | Identifier of requested notification rule
xRequestId := "xRequestId_example" // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.NotificationRulesApi.GetNotificationRule(context.Background(), id).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NotificationRulesApi.GetNotificationRule``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetNotificationRule`: NotificationRule
fmt.Fprintf(os.Stdout, "Response from `NotificationRulesApi.GetNotificationRule`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Identifier of requested notification rule |
Other parameters are passed through a pointer to a apiGetNotificationRuleRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xRequestId | string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]