Class containing needed authenticaction and configuration to interact with the API. Environment correspond to the environment to use, it can be Integration or Production, each has a unique URL.

Constructors

  • Create an instance of Options

    Parameters

    • commerceCode: string

      unique commerce identifier provided by Transbank

    • apiKey: string

      the secret used to authenticate against the API, it must be kept safe at all times.

    • environment: string

      Environment correspond to the environment to use, it can be Integration or Production, each has a unique URL.

    • Optional timeout: number

      Timeout for requests in milliseconds

    Returns Options

Properties

apiKey: string

The secret used to authenticate against the API, it must be kept safe at all times.

commerceCode: string

Unique commerce identifier provided by Transbank

environment: string

Environment correspond to the environment to use, it can be Integration or Production, each has a unique URL.

timeout: number

Timeout for requests in milliseconds

Generated using TypeDoc