Skip to content

Latest commit

 

History

History
144 lines (90 loc) · 7.18 KB

MocksAndTestsApi.md

File metadata and controls

144 lines (90 loc) · 7.18 KB

\MocksAndTestsApi

All URIs are relative to https://sandbox.finapi.io

Method HTTP request Description
CheckCategorization Post /api/v1/tests/checkCategorization Check categorization
MockBatchUpdate Post /api/v1/tests/mockBatchUpdate Mock batch update

CheckCategorization

CategorizationCheckResults CheckCategorization(ctx).CheckCategorizationData(checkCategorizationData).XRequestId(xRequestId).Execute()

Check categorization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    checkCategorizationData := *openapiclient.NewCheckCategorizationData([]openapiclient.CheckCategorizationTransactionData{*openapiclient.NewCheckCategorizationTransactionData("transaction", int64(1), float64(-99.99))}) // CheckCategorizationData | Transactions data
    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.MocksAndTestsApi.CheckCategorization(context.Background()).CheckCategorizationData(checkCategorizationData).XRequestId(xRequestId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MocksAndTestsApi.CheckCategorization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckCategorization`: CategorizationCheckResults
    fmt.Fprintf(os.Stdout, "Response from `MocksAndTestsApi.CheckCategorization`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCheckCategorizationRequest struct via the builder pattern

Name Type Description Notes
checkCategorizationData CheckCategorizationData Transactions data
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.

Return type

CategorizationCheckResults

Authorization

finapi_auth, finapi_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MockBatchUpdate

MockBatchUpdate(ctx).MockBatchUpdateParams(mockBatchUpdateParams).XRequestId(xRequestId).Execute()

Mock batch update

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    mockBatchUpdateParams := *openapiclient.NewMockBatchUpdateParams([]openapiclient.MockBankConnectionUpdate{*openapiclient.NewMockBankConnectionUpdate(int64(1))}) // MockBatchUpdateParams | Data for mock bank connection updates
    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.MocksAndTestsApi.MockBatchUpdate(context.Background()).MockBatchUpdateParams(mockBatchUpdateParams).XRequestId(xRequestId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MocksAndTestsApi.MockBatchUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiMockBatchUpdateRequest struct via the builder pattern

Name Type Description Notes
mockBatchUpdateParams MockBatchUpdateParams Data for mock bank connection updates
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.

Return type

(empty response body)

Authorization

finapi_auth, finapi_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]