All URIs are relative to https://sandbox.finapi.io
| Method | HTTP request | Description |
|---|---|---|
| CreateNewCertificate | Post /api/v1/tppCertificates | Upload TPP certificate |
| DeleteCertificate | Delete /api/v1/tppCertificates/{id} | Delete a TPP certificate |
| GetAllCertificates | Get /api/v1/tppCertificates | Get all TPP certificates |
| GetCertificate | Get /api/v1/tppCertificates/{id} | Get a TPP certificate |
TppCertificate CreateNewCertificate(ctx).TppCertificateParams(tppCertificateParams).XRequestId(xRequestId).Execute()
Upload TPP certificate
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
tppCertificateParams := *openapiclient.NewTppCertificateParams(openapiclient.TppCertificateType("QWAC"), "PublicKey_example", "PrivateKey_example", "Label_example") // TppCertificateParams | Create new TPP certificate 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.TPPCertificatesApi.CreateNewCertificate(context.Background()).TppCertificateParams(tppCertificateParams).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TPPCertificatesApi.CreateNewCertificate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateNewCertificate`: TppCertificate
fmt.Fprintf(os.Stdout, "Response from `TPPCertificatesApi.CreateNewCertificate`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateNewCertificateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| tppCertificateParams | TppCertificateParams | Create new TPP certificate 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]
DeleteCertificate(ctx, id).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Delete a TPP certificate
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int64(789) // int64 | Id of the TPP certificate 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.TPPCertificatesApi.DeleteCertificate(context.Background(), id).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TPPCertificatesApi.DeleteCertificate``: %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 | Id of the TPP certificate to delete |
Other parameters are passed through a pointer to a apiDeleteCertificateRequest 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]
PageableTppCertificateList GetAllCertificates(ctx).Page(page).PerPage(perPage).Order(order).XRequestId(xRequestId).Execute()
Get all TPP certificates
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
page := int32(56) // int32 | Result page that you want to retrieve (optional) (default to 1)
perPage := int32(56) // int32 | Maximum number of records per page. By default it's 20. Can be at most 500. (optional) (default to 20)
order := []string{"Inner_example"} // []string | Determines the order of the results. You can order the results by 'label'. The default order for this service is 'label,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (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.TPPCertificatesApi.GetAllCertificates(context.Background()).Page(page).PerPage(perPage).Order(order).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TPPCertificatesApi.GetAllCertificates``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAllCertificates`: PageableTppCertificateList
fmt.Fprintf(os.Stdout, "Response from `TPPCertificatesApi.GetAllCertificates`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAllCertificatesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Result page that you want to retrieve | [default to 1] |
| perPage | int32 | Maximum number of records per page. By default it's 20. Can be at most 500. | [default to 20] |
| order | []string | Determines the order of the results. You can order the results by 'label'. The default order for this service is 'label,asc'. The general format is: 'property[,asc | desc]', with 'asc' being the default value. |
| 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]
TppCertificate GetCertificate(ctx, id).XRequestId(xRequestId).Execute()
Get a TPP certificate
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int64(789) // int64 | Id of requested TPP certificate
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.TPPCertificatesApi.GetCertificate(context.Background(), id).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TPPCertificatesApi.GetCertificate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCertificate`: TppCertificate
fmt.Fprintf(os.Stdout, "Response from `TPPCertificatesApi.GetCertificate`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Id of requested TPP certificate |
Other parameters are passed through a pointer to a apiGetCertificateRequest 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]