Skip to content

Latest commit

 

History

History
282 lines (179 loc) · 8.01 KB

ThreeDSApi.md

File metadata and controls

282 lines (179 loc) · 8.01 KB

\ThreeDSApi

All URIs are relative to https://api.basistheory.com

Method HTTP request Description
ThreeDSAuthenticateSession Post /3ds/sessions/{sessionId}/authenticate
ThreeDSCreateSession Post /3ds/sessions
ThreeDSGetChallengeResult Get /3ds/sessions/{sessionId}/challenge-result
ThreeDSGetSessionById Get /3ds/sessions/{id}

ThreeDSAuthenticateSession

ThreeDSAuthentication ThreeDSAuthenticateSession(ctx, sessionId).AuthenticateThreeDSSessionRequest(authenticateThreeDSSessionRequest).Execute()

Example

package main

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

func main() {
    sessionId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    authenticateThreeDSSessionRequest := *openapiclient.NewAuthenticateThreeDSSessionRequest("AuthenticationCategory_example", "AuthenticationType_example", *openapiclient.NewThreeDSRequestorInfo()) // AuthenticateThreeDSSessionRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ThreeDSApi.ThreeDSAuthenticateSession(context.Background(), sessionId).AuthenticateThreeDSSessionRequest(authenticateThreeDSSessionRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ThreeDSApi.ThreeDSAuthenticateSession``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ThreeDSAuthenticateSession`: ThreeDSAuthentication
    fmt.Fprintf(os.Stdout, "Response from `ThreeDSApi.ThreeDSAuthenticateSession`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionId string

Other Parameters

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

Name Type Description Notes

authenticateThreeDSSessionRequest | AuthenticateThreeDSSessionRequest | |

Return type

ThreeDSAuthentication

Authorization

ApiKey

HTTP request headers

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

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

ThreeDSCreateSession

CreateThreeDSSessionResponse ThreeDSCreateSession(ctx).CreateThreeDSSessionRequest(createThreeDSSessionRequest).Execute()

Example

package main

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

func main() {
    createThreeDSSessionRequest := *openapiclient.NewCreateThreeDSSessionRequest() // CreateThreeDSSessionRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ThreeDSApi.ThreeDSCreateSession(context.Background()).CreateThreeDSSessionRequest(createThreeDSSessionRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ThreeDSApi.ThreeDSCreateSession``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ThreeDSCreateSession`: CreateThreeDSSessionResponse
    fmt.Fprintf(os.Stdout, "Response from `ThreeDSApi.ThreeDSCreateSession`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createThreeDSSessionRequest CreateThreeDSSessionRequest

Return type

CreateThreeDSSessionResponse

Authorization

ApiKey

HTTP request headers

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

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

ThreeDSGetChallengeResult

ThreeDSAuthentication ThreeDSGetChallengeResult(ctx, sessionId).Execute()

Example

package main

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

func main() {
    sessionId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ThreeDSApi.ThreeDSGetChallengeResult(context.Background(), sessionId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ThreeDSApi.ThreeDSGetChallengeResult``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ThreeDSGetChallengeResult`: ThreeDSAuthentication
    fmt.Fprintf(os.Stdout, "Response from `ThreeDSApi.ThreeDSGetChallengeResult`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionId string

Other Parameters

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

Name Type Description Notes

Return type

ThreeDSAuthentication

Authorization

ApiKey

HTTP request headers

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

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

ThreeDSGetSessionById

ThreeDSSession ThreeDSGetSessionById(ctx, id).Execute()

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ThreeDSApi.ThreeDSGetSessionById(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ThreeDSApi.ThreeDSGetSessionById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ThreeDSGetSessionById`: ThreeDSSession
    fmt.Fprintf(os.Stdout, "Response from `ThreeDSApi.ThreeDSGetSessionById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

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

Name Type Description Notes

Return type

ThreeDSSession

Authorization

ApiKey

HTTP request headers

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

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