lithic

package module
v0.63.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 25 Imported by: 0

README

Lithic Go API Library

Go Reference

The Lithic Go library provides convenient access to the Lithic REST API from applications written in Go. The full API of this library can be found in api.md.

Installation

import (
	"github.com/lithic-com/lithic-go" // imported as lithic
)

Or to pin the version:

go get -u 'github.com/lithic-com/lithic-go@v0.63.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/lithic-com/lithic-go"
	"github.com/lithic-com/lithic-go/option"
)

func main() {
	client := lithic.NewClient(
		option.WithAPIKey("My Lithic API Key"), // defaults to os.LookupEnv("LITHIC_API_KEY")
		option.WithEnvironmentSandbox(),        // defaults to option.WithEnvironmentProduction()
	)
	card, err := client.Cards.New(context.TODO(), lithic.CardNewParams{
		Type: lithic.F(lithic.CardNewParamsTypeSingleUse),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", card.Token)
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: lithic.F("hello"),

	// Explicitly send `"description": null`
	Description: lithic.Null[string](),

	Point: lithic.F(lithic.Point{
		X: lithic.Int(0),
		Y: lithic.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: lithic.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := lithic.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Cards.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

iter := client.Cards.ListAutoPaging(context.TODO(), lithic.CardListParams{})
// Automatically fetches more pages as needed.
for iter.Next() {
	card := iter.Current()
	fmt.Printf("%+v\n", card)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

page, err := client.Cards.List(context.TODO(), lithic.CardListParams{})
for page != nil {
	for _, card := range page.Data {
		fmt.Printf("%+v\n", card)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}
Errors

When the API returns a non-success status code, we return an error with type *lithic.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Cards.New(context.TODO(), lithic.CardNewParams{
	Type: lithic.F(lithic.CardNewParamsTypeAnIncorrectType),
})
if err != nil {
	var apierr *lithic.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
		println(apierr.Message)                    // Invalid parameter(s): type
		println(apierr.DebuggingRequestID)         // 94d5e915-xxxx-4cee-a4f5-2xd6ebd279ac
	}
	panic(err.Error()) // GET "/v1/cards": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Cards.List(
	ctx,
	lithic.CardListParams{
		PageSize: lithic.F(int64(10)),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper lithic.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := lithic.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Cards.List(
	context.TODO(),
	lithic.CardListParams{
		PageSize: lithic.F(int64(10)),
	},
	option.WithMaxRetries(5),
)
Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := lithic.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

View Source 
const CurrencyAed = shared.CurrencyAed

This is an alias to an internal value.

View Source 
const CurrencyAfn = shared.CurrencyAfn

This is an alias to an internal value.

View Source 
const CurrencyAll = shared.CurrencyAll

This is an alias to an internal value.

View Source 
const CurrencyAmd = shared.CurrencyAmd

This is an alias to an internal value.

View Source 
const CurrencyAng = shared.CurrencyAng

This is an alias to an internal value.

View Source 
const CurrencyAoa = shared.CurrencyAoa

This is an alias to an internal value.

View Source 
const CurrencyArs = shared.CurrencyArs

This is an alias to an internal value.

View Source 
const CurrencyAud = shared.CurrencyAud

This is an alias to an internal value.

View Source 
const CurrencyAwg = shared.CurrencyAwg

This is an alias to an internal value.

View Source 
const CurrencyAzn = shared.CurrencyAzn

This is an alias to an internal value.

View Source 
const CurrencyBam = shared.CurrencyBam

This is an alias to an internal value.

View Source 
const CurrencyBbd = shared.CurrencyBbd

This is an alias to an internal value.

View Source 
const CurrencyBdt = shared.CurrencyBdt

This is an alias to an internal value.

View Source 
const CurrencyBgn = shared.CurrencyBgn

This is an alias to an internal value.

View Source 
const CurrencyBhd = shared.CurrencyBhd

This is an alias to an internal value.

View Source 
const CurrencyBif = shared.CurrencyBif

This is an alias to an internal value.

View Source 
const CurrencyBmd = shared.CurrencyBmd

This is an alias to an internal value.

View Source 
const CurrencyBnd = shared.CurrencyBnd

This is an alias to an internal value.

View Source 
const CurrencyBob = shared.CurrencyBob

This is an alias to an internal value.

View Source 
const CurrencyBov = shared.CurrencyBov

This is an alias to an internal value.

View Source 
const CurrencyBrl = shared.CurrencyBrl

This is an alias to an internal value.

View Source 
const CurrencyBsd = shared.CurrencyBsd

This is an alias to an internal value.

View Source 
const CurrencyBtn = shared.CurrencyBtn

This is an alias to an internal value.

View Source 
const CurrencyBwp = shared.CurrencyBwp

This is an alias to an internal value.

View Source 
const CurrencyByn = shared.CurrencyByn

This is an alias to an internal value.

View Source 
const CurrencyBzd = shared.CurrencyBzd

This is an alias to an internal value.

View Source 
const CurrencyCad = shared.CurrencyCad

This is an alias to an internal value.

View Source 
const CurrencyCdf = shared.CurrencyCdf

This is an alias to an internal value.

View Source 
const CurrencyChe = shared.CurrencyChe

This is an alias to an internal value.

View Source 
const CurrencyChf = shared.CurrencyChf

This is an alias to an internal value.

View Source 
const CurrencyChw = shared.CurrencyChw

This is an alias to an internal value.

View Source 
const CurrencyClf = shared.CurrencyClf

This is an alias to an internal value.

View Source 
const CurrencyClp = shared.CurrencyClp

This is an alias to an internal value.

View Source 
const CurrencyCny = shared.CurrencyCny

This is an alias to an internal value.

View Source 
const CurrencyCop = shared.CurrencyCop

This is an alias to an internal value.

View Source 
const CurrencyCou = shared.CurrencyCou

This is an alias to an internal value.

View Source 
const CurrencyCrc = shared.CurrencyCrc

This is an alias to an internal value.

View Source 
const CurrencyCuc = shared.CurrencyCuc

This is an alias to an internal value.

View Source 
const CurrencyCup = shared.CurrencyCup

This is an alias to an internal value.

View Source 
const CurrencyCve = shared.CurrencyCve

This is an alias to an internal value.

View Source 
const CurrencyCzk = shared.CurrencyCzk

This is an alias to an internal value.

View Source 
const CurrencyDjf = shared.CurrencyDjf

This is an alias to an internal value.

View Source 
const CurrencyDkk = shared.CurrencyDkk

This is an alias to an internal value.

View Source 
const CurrencyDop = shared.CurrencyDop

This is an alias to an internal value.

View Source 
const CurrencyDzd = shared.CurrencyDzd

This is an alias to an internal value.

View Source 
const CurrencyEgp = shared.CurrencyEgp

This is an alias to an internal value.

View Source 
const CurrencyErn = shared.CurrencyErn

This is an alias to an internal value.

View Source 
const CurrencyEtb = shared.CurrencyEtb

This is an alias to an internal value.

View Source 
const CurrencyEur = shared.CurrencyEur

This is an alias to an internal value.

View Source 
const CurrencyFjd = shared.CurrencyFjd

This is an alias to an internal value.

View Source 
const CurrencyFkp = shared.CurrencyFkp

This is an alias to an internal value.

View Source 
const CurrencyGbp = shared.CurrencyGbp

This is an alias to an internal value.

View Source 
const CurrencyGel = shared.CurrencyGel

This is an alias to an internal value.

View Source 
const CurrencyGhs = shared.CurrencyGhs

This is an alias to an internal value.

View Source 
const CurrencyGip = shared.CurrencyGip

This is an alias to an internal value.

View Source 
const CurrencyGmd = shared.CurrencyGmd

This is an alias to an internal value.

View Source 
const CurrencyGnf = shared.CurrencyGnf

This is an alias to an internal value.

View Source 
const CurrencyGtq = shared.CurrencyGtq

This is an alias to an internal value.

View Source 
const CurrencyGyd = shared.CurrencyGyd

This is an alias to an internal value.

View Source 
const CurrencyHkd = shared.CurrencyHkd

This is an alias to an internal value.

View Source 
const CurrencyHnl = shared.CurrencyHnl

This is an alias to an internal value.

View Source 
const CurrencyHrk = shared.CurrencyHrk

This is an alias to an internal value.

View Source 
const CurrencyHtg = shared.CurrencyHtg

This is an alias to an internal value.

View Source 
const CurrencyHuf = shared.CurrencyHuf

This is an alias to an internal value.

View Source 
const CurrencyIdr = shared.CurrencyIdr

This is an alias to an internal value.

View Source 
const CurrencyIls = shared.CurrencyIls

This is an alias to an internal value.

View Source 
const CurrencyInr = shared.CurrencyInr

This is an alias to an internal value.

View Source 
const CurrencyIqd = shared.CurrencyIqd

This is an alias to an internal value.

View Source 
const CurrencyIrr = shared.CurrencyIrr

This is an alias to an internal value.

View Source 
const CurrencyIsk = shared.CurrencyIsk

This is an alias to an internal value.

View Source 
const CurrencyJmd = shared.CurrencyJmd

This is an alias to an internal value.

View Source 
const CurrencyJod = shared.CurrencyJod

This is an alias to an internal value.

View Source 
const CurrencyJpy = shared.CurrencyJpy

This is an alias to an internal value.

View Source 
const CurrencyKes = shared.CurrencyKes

This is an alias to an internal value.

View Source 
const CurrencyKgs = shared.CurrencyKgs

This is an alias to an internal value.

View Source 
const CurrencyKhr = shared.CurrencyKhr

This is an alias to an internal value.

View Source 
const CurrencyKmf = shared.CurrencyKmf

This is an alias to an internal value.

View Source 
const CurrencyKpw = shared.CurrencyKpw

This is an alias to an internal value.

View Source 
const CurrencyKrw = shared.CurrencyKrw

This is an alias to an internal value.

View Source 
const CurrencyKwd = shared.CurrencyKwd

This is an alias to an internal value.

View Source 
const CurrencyKyd = shared.CurrencyKyd

This is an alias to an internal value.

View Source 
const CurrencyKzt = shared.CurrencyKzt

This is an alias to an internal value.

View Source 
const CurrencyLak = shared.CurrencyLak

This is an alias to an internal value.

View Source 
const CurrencyLbp = shared.CurrencyLbp

This is an alias to an internal value.

View Source 
const CurrencyLkr = shared.CurrencyLkr

This is an alias to an internal value.

View Source 
const CurrencyLrd = shared.CurrencyLrd

This is an alias to an internal value.

View Source 
const CurrencyLsl = shared.CurrencyLsl

This is an alias to an internal value.

View Source 
const CurrencyLyd = shared.CurrencyLyd

This is an alias to an internal value.

View Source 
const CurrencyMad = shared.CurrencyMad

This is an alias to an internal value.

View Source 
const CurrencyMdl = shared.CurrencyMdl

This is an alias to an internal value.

View Source 
const CurrencyMga = shared.CurrencyMga

This is an alias to an internal value.

View Source 
const CurrencyMkd = shared.CurrencyMkd

This is an alias to an internal value.

View Source 
const CurrencyMmk = shared.CurrencyMmk

This is an alias to an internal value.

View Source 
const CurrencyMnt = shared.CurrencyMnt

This is an alias to an internal value.

View Source 
const CurrencyMop = shared.CurrencyMop

This is an alias to an internal value.

View Source 
const CurrencyMru = shared.CurrencyMru

This is an alias to an internal value.

View Source 
const CurrencyMur = shared.CurrencyMur

This is an alias to an internal value.

View Source 
const CurrencyMvr = shared.CurrencyMvr

This is an alias to an internal value.

View Source 
const CurrencyMwk = shared.CurrencyMwk

This is an alias to an internal value.

View Source 
const CurrencyMxn = shared.CurrencyMxn

This is an alias to an internal value.

View Source 
const CurrencyMxv = shared.CurrencyMxv

This is an alias to an internal value.

View Source 
const CurrencyMyr = shared.CurrencyMyr

This is an alias to an internal value.

View Source 
const CurrencyMzn = shared.CurrencyMzn

This is an alias to an internal value.

View Source 
const CurrencyNad = shared.CurrencyNad

This is an alias to an internal value.

View Source 
const CurrencyNgn = shared.CurrencyNgn

This is an alias to an internal value.

View Source 
const CurrencyNio = shared.CurrencyNio

This is an alias to an internal value.

View Source 
const CurrencyNok = shared.CurrencyNok

This is an alias to an internal value.

View Source 
const CurrencyNpr = shared.CurrencyNpr

This is an alias to an internal value.

View Source 
const CurrencyNzd = shared.CurrencyNzd

This is an alias to an internal value.

View Source 
const CurrencyOmr = shared.CurrencyOmr

This is an alias to an internal value.

View Source 
const CurrencyPab = shared.CurrencyPab

This is an alias to an internal value.

View Source 
const CurrencyPen = shared.CurrencyPen

This is an alias to an internal value.

View Source 
const CurrencyPgk = shared.CurrencyPgk

This is an alias to an internal value.

View Source 
const CurrencyPhp = shared.CurrencyPhp

This is an alias to an internal value.

View Source 
const CurrencyPkr = shared.CurrencyPkr

This is an alias to an internal value.

View Source 
const CurrencyPln = shared.CurrencyPln

This is an alias to an internal value.

View Source 
const CurrencyPyg = shared.CurrencyPyg

This is an alias to an internal value.

View Source 
const CurrencyQar = shared.CurrencyQar

This is an alias to an internal value.

View Source 
const CurrencyRon = shared.CurrencyRon

This is an alias to an internal value.

View Source 
const CurrencyRsd = shared.CurrencyRsd

This is an alias to an internal value.

View Source 
const CurrencyRub = shared.CurrencyRub

This is an alias to an internal value.

View Source 
const CurrencyRwf = shared.CurrencyRwf

This is an alias to an internal value.

View Source 
const CurrencySar = shared.CurrencySar

This is an alias to an internal value.

View Source 
const CurrencySbd = shared.CurrencySbd

This is an alias to an internal value.

View Source 
const CurrencyScr = shared.CurrencyScr

This is an alias to an internal value.

View Source 
const CurrencySdg = shared.CurrencySdg

This is an alias to an internal value.

View Source 
const CurrencySek = shared.CurrencySek

This is an alias to an internal value.

View Source 
const CurrencySgd = shared.CurrencySgd

This is an alias to an internal value.

View Source 
const CurrencyShp = shared.CurrencyShp

This is an alias to an internal value.

View Source 
const CurrencySle = shared.CurrencySle

This is an alias to an internal value.

View Source 
const CurrencySll = shared.CurrencySll

This is an alias to an internal value.

View Source 
const CurrencySos = shared.CurrencySos

This is an alias to an internal value.

View Source 
const CurrencySrd = shared.CurrencySrd

This is an alias to an internal value.

View Source 
const CurrencySsp = shared.CurrencySsp

This is an alias to an internal value.

View Source 
const CurrencyStn = shared.CurrencyStn

This is an alias to an internal value.

View Source 
const CurrencySvc = shared.CurrencySvc

This is an alias to an internal value.

View Source 
const CurrencySyp = shared.CurrencySyp

This is an alias to an internal value.

View Source 
const CurrencySzl = shared.CurrencySzl

This is an alias to an internal value.

View Source 
const CurrencyThb = shared.CurrencyThb

This is an alias to an internal value.

View Source 
const CurrencyTjs = shared.CurrencyTjs

This is an alias to an internal value.

View Source 
const CurrencyTmt = shared.CurrencyTmt

This is an alias to an internal value.

View Source 
const CurrencyTnd = shared.CurrencyTnd

This is an alias to an internal value.

View Source 
const CurrencyTop = shared.CurrencyTop

This is an alias to an internal value.

View Source 
const CurrencyTry = shared.CurrencyTry

This is an alias to an internal value.

View Source 
const CurrencyTtd = shared.CurrencyTtd

This is an alias to an internal value.

View Source 
const CurrencyTwd = shared.CurrencyTwd

This is an alias to an internal value.

View Source 
const CurrencyTzs = shared.CurrencyTzs

This is an alias to an internal value.

View Source 
const CurrencyUah = shared.CurrencyUah

This is an alias to an internal value.

View Source 
const CurrencyUgx = shared.CurrencyUgx

This is an alias to an internal value.

View Source 
const CurrencyUsd = shared.CurrencyUsd

This is an alias to an internal value.

View Source 
const CurrencyUsn = shared.CurrencyUsn

This is an alias to an internal value.

View Source 
const CurrencyUyi = shared.CurrencyUyi

This is an alias to an internal value.

View Source 
const CurrencyUyu = shared.CurrencyUyu

This is an alias to an internal value.

View Source 
const CurrencyUyw = shared.CurrencyUyw

This is an alias to an internal value.

View Source 
const CurrencyUzs = shared.CurrencyUzs

This is an alias to an internal value.

View Source 
const CurrencyVed = shared.CurrencyVed

This is an alias to an internal value.

View Source 
const CurrencyVes = shared.CurrencyVes

This is an alias to an internal value.

View Source 
const CurrencyVnd = shared.CurrencyVnd

This is an alias to an internal value.

View Source 
const CurrencyVuv = shared.CurrencyVuv

This is an alias to an internal value.

View Source 
const CurrencyWst = shared.CurrencyWst

This is an alias to an internal value.

View Source 
const CurrencyXaf = shared.CurrencyXaf

This is an alias to an internal value.

View Source 
const CurrencyXag = shared.CurrencyXag

This is an alias to an internal value.

View Source 
const CurrencyXau = shared.CurrencyXau

This is an alias to an internal value.

View Source 
const CurrencyXba = shared.CurrencyXba

This is an alias to an internal value.

View Source 
const CurrencyXbb = shared.CurrencyXbb

This is an alias to an internal value.

View Source 
const CurrencyXbc = shared.CurrencyXbc

This is an alias to an internal value.

View Source 
const CurrencyXbd = shared.CurrencyXbd

This is an alias to an internal value.

View Source 
const CurrencyXcd = shared.CurrencyXcd

This is an alias to an internal value.

View Source 
const CurrencyXdr = shared.CurrencyXdr

This is an alias to an internal value.

View Source 
const CurrencyXof = shared.CurrencyXof

This is an alias to an internal value.

View Source 
const CurrencyXpd = shared.CurrencyXpd

This is an alias to an internal value.

View Source 
const CurrencyXpf = shared.CurrencyXpf

This is an alias to an internal value.

View Source 
const CurrencyXpt = shared.CurrencyXpt

This is an alias to an internal value.

View Source 
const CurrencyXsu = shared.CurrencyXsu

This is an alias to an internal value.

View Source 
const CurrencyXts = shared.CurrencyXts

This is an alias to an internal value.

View Source 
const CurrencyXua = shared.CurrencyXua

This is an alias to an internal value.

View Source 
const CurrencyXxx = shared.CurrencyXxx

This is an alias to an internal value.

View Source 
const CurrencyYer = shared.CurrencyYer

This is an alias to an internal value.

View Source 
const CurrencyZar = shared.CurrencyZar

This is an alias to an internal value.

View Source 
const CurrencyZmw = shared.CurrencyZmw

This is an alias to an internal value.

View Source 
const CurrencyZwl = shared.CurrencyZwl

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeArticlesOfIncorporation = shared.DocumentDocumentTypeArticlesOfIncorporation

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeArticlesOfOrganization = shared.DocumentDocumentTypeArticlesOfOrganization

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeBankStatement = shared.DocumentDocumentTypeBankStatement

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeBylaws = shared.DocumentDocumentTypeBylaws

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeCertificateOfFormation = shared.DocumentDocumentTypeCertificateOfFormation

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeCertificateOfGoodStanding = shared.DocumentDocumentTypeCertificateOfGoodStanding

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeDriversLicense = shared.DocumentDocumentTypeDriversLicense

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeEinLetter = shared.DocumentDocumentTypeEinLetter

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeGovernmentBusinessLicense = shared.DocumentDocumentTypeGovernmentBusinessLicense

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeItinLetter = shared.DocumentDocumentTypeItinLetter

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeOperatingAgreement = shared.DocumentDocumentTypeOperatingAgreement

This is an alias to an internal value.

View Source 
const DocumentDocumentTypePartnershipAgreement = shared.DocumentDocumentTypePartnershipAgreement

This is an alias to an internal value.

View Source 
const DocumentDocumentTypePassport = shared.DocumentDocumentTypePassport

This is an alias to an internal value.

View Source 
const DocumentDocumentTypePassportCard = shared.DocumentDocumentTypePassportCard

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeSs4Form = shared.DocumentDocumentTypeSs4Form

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeSsnCard = shared.DocumentDocumentTypeSsnCard

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeTaxReturn = shared.DocumentDocumentTypeTaxReturn

This is an alias to an internal value.

View Source 
const DocumentDocumentTypeUtilityBillStatement = shared.DocumentDocumentTypeUtilityBillStatement

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsImageTypeBack = shared.DocumentRequiredDocumentUploadsImageTypeBack

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsImageTypeFront = shared.DocumentRequiredDocumentUploadsImageTypeFront

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusAccepted = shared.DocumentRequiredDocumentUploadsStatusAccepted

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusPartialApproval = shared.DocumentRequiredDocumentUploadsStatusPartialApproval

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusPendingUpload = shared.DocumentRequiredDocumentUploadsStatusPendingUpload

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonDocumentExpired = shared.DocumentRequiredDocumentUploadsStatusReasonDocumentExpired

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonDocumentIssuedGreaterThan30Days = shared.DocumentRequiredDocumentUploadsStatusReasonDocumentIssuedGreaterThan30Days

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonDocumentMissingRequiredData = shared.DocumentRequiredDocumentUploadsStatusReasonDocumentMissingRequiredData

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonDocumentTypeNotSupported = shared.DocumentRequiredDocumentUploadsStatusReasonDocumentTypeNotSupported

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonDocumentUploadTooBlurry = shared.DocumentRequiredDocumentUploadsStatusReasonDocumentUploadTooBlurry

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonFileSizeTooLarge = shared.DocumentRequiredDocumentUploadsStatusReasonFileSizeTooLarge

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentType = shared.DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentType

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentUpload = shared.DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentUpload

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonInvalidEntity = shared.DocumentRequiredDocumentUploadsStatusReasonInvalidEntity

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonUnknownError = shared.DocumentRequiredDocumentUploadsStatusReasonUnknownError

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusReasonUnknownFailureReason = shared.DocumentRequiredDocumentUploadsStatusReasonUnknownFailureReason

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusRejected = shared.DocumentRequiredDocumentUploadsStatusRejected

This is an alias to an internal value.

View Source 
const DocumentRequiredDocumentUploadsStatusUploaded = shared.DocumentRequiredDocumentUploadsStatusUploaded

This is an alias to an internal value.

View Source 
const VelocityLimitParamsPeriodWindowDay = shared.VelocityLimitParamsPeriodWindowDay

This is an alias to an internal value.

View Source 
const VelocityLimitParamsPeriodWindowMonth = shared.VelocityLimitParamsPeriodWindowMonth

This is an alias to an internal value.

View Source 
const VelocityLimitParamsScopeAccount = shared.VelocityLimitParamsScopeAccount

This is an alias to an internal value.

View Source 
const VelocityLimitParamsScopeCard = shared.VelocityLimitParamsScopeCard

This is an alias to an internal value.

Variables

This section is empty.

Functions

func Bool added in v0.6.5 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam added in v0.28.0 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type APIStatus 

type APIStatus struct {
	Message string        `json:"message"`
	JSON    apiStatusJSON `json:"-"`
}

func (*APIStatus) UnmarshalJSON 

func (r *APIStatus) UnmarshalJSON(data []byte) (err error)

type Account 

type Account struct {
	// Globally unique identifier for the account. This is the same as the
	// account_token returned by the enroll endpoint. If using this parameter, do not
	// include pagination.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when the account was created. For accounts created before
	// 2023-05-11, this field will be null.
	Created time.Time `json:"created,required,nullable" format:"date-time"`
	// Spend limit information for the user containing the daily, monthly, and lifetime
	// spend limit of the account. Any charges to a card owned by this account will be
	// declined once their transaction volume has surpassed the value in the applicable
	// time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
	// feature is disabled.
	SpendLimit AccountSpendLimit `json:"spend_limit,required"`
	// Account state:
	//
	//   - `ACTIVE` - Account is able to transact and create new cards.
	//   - `PAUSED` - Account will not be able to transact or create new cards. It can be
	//     set back to `ACTIVE`.
	//   - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
	//     accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
	//     `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
	//     risk/compliance reasons. Please contact
	//     [support@lithic.com](mailto:support@lithic.com) if you believe this was in
	//     error.
	State         AccountState         `json:"state,required"`
	AccountHolder AccountAccountHolder `json:"account_holder"`
	// List of identifiers for the Auth Rule(s) that are applied on the account. This
	// field is deprecated and will no longer be populated in the `account_holder`
	// object. The key will be removed from the schema in a future release. Use the
	// `/auth_rules` endpoints to fetch Auth Rule information instead.
	AuthRuleTokens []string `json:"auth_rule_tokens"`
	// 3-digit alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency  string                     `json:"cardholder_currency"`
	VerificationAddress AccountVerificationAddress `json:"verification_address"`
	JSON                accountJSON                `json:"-"`
}

func (*Account) UnmarshalJSON 

func (r *Account) UnmarshalJSON(data []byte) (err error)

type AccountAccountHolder 

type AccountAccountHolder struct {
	// Globally unique identifier for the account holder.
	Token string `json:"token,required"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Account_token of the enrolled business associated with an
	// enrolled AUTHORIZED_USER individual.
	BusinessAccountToken string `json:"business_account_token,required"`
	// Email address.
	Email string `json:"email,required"`
	// Phone number of the individual.
	PhoneNumber string                   `json:"phone_number,required"`
	JSON        accountAccountHolderJSON `json:"-"`
}

func (*AccountAccountHolder) UnmarshalJSON 

func (r *AccountAccountHolder) UnmarshalJSON(data []byte) (err error)

type AccountHolder 

type AccountHolder struct {
	// Globally unique identifier for the account holder.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when the account holder was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Globally unique identifier for the account.
	AccountToken string `json:"account_token" format:"uuid"`
	// Only present when user_type == "BUSINESS". List of all entities with >25%
	// ownership in the company.
	BeneficialOwnerEntities []AccountHolderBeneficialOwnerEntity `json:"beneficial_owner_entities"`
	// Only present when user_type == "BUSINESS". List of all individuals with >25%
	// ownership in the company.
	BeneficialOwnerIndividuals []AccountHolderBeneficialOwnerIndividual `json:"beneficial_owner_individuals"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Pass the account_token of the enrolled business associated
	// with the AUTHORIZED_USER in this field.
	BusinessAccountToken string `json:"business_account_token" format:"uuid"`
	// Only present when user_type == "BUSINESS". Information about the business for
	// which the account is being opened and KYB is being run.
	BusinessEntity AccountHolderBusinessEntity `json:"business_entity"`
	// Only present when user_type == "BUSINESS". An individual with significant
	// responsibility for managing the legal entity (e.g., a Chief Executive Officer,
	// Chief Financial Officer, Chief Operating Officer, Managing Member, General
	// Partner, President, Vice President, or Treasurer). This can be an executive, or
	// someone who will have program-wide access to the cards that Lithic will provide.
	// In some cases, this individual could also be a beneficial owner listed above.
	ControlPerson AccountHolderControlPerson `json:"control_person"`
	// < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
	// individual.phone_number when user_type == "INDIVIDUAL".
	//
	// > Primary email of Account Holder.
	Email string `json:"email"`
	// The type of KYC exemption for a KYC-Exempt Account Holder.
	ExemptionType AccountHolderExemptionType `json:"exemption_type"`
	// Customer-provided token that indicates a relationship with an object outside of
	// the Lithic ecosystem.
	ExternalID string `json:"external_id" format:"string"`
	// Only present when user_type == "INDIVIDUAL". Information about the individual
	// for which the account is being opened and KYC is being run.
	Individual AccountHolderIndividual `json:"individual"`
	// Only present when user_type == "BUSINESS". User-submitted description of the
	// business.
	NatureOfBusiness string `json:"nature_of_business" format:"string"`
	// < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
	// individual.phone_number when user_type == "INDIVIDUAL".
	//
	// > Primary phone of Account Holder, entered in E.164 format.
	PhoneNumber string `json:"phone_number"`
	// Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
	// required for the account holder to be approved.
	RequiredDocuments []RequiredDocument `json:"required_documents"`
	// <Deprecated. Use verification_application.status instead>
	//
	// KYC and KYB evaluation states.
	//
	// Note:
	//
	//   - `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
	//     `KYC_ADVANCED` workflow.
	//   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
	Status AccountHolderStatus `json:"status"`
	// <Deprecated. Use verification_application.status_reasons> Reason for the
	// evaluation status.
	StatusReasons []AccountHolderStatusReason `json:"status_reasons"`
	// The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
	// attribute will be present. If the type is "BUSINESS" then the "business_entity",
	// "control_person", "beneficial_owner_individuals", "beneficial_owner_entities",
	// "nature_of_business", and "website_url" attributes will be present.
	UserType AccountHolderUserType `json:"user_type"`
	// Information about the most recent identity verification attempt
	VerificationApplication AccountHolderVerificationApplication `json:"verification_application"`
	// Only present when user_type == "BUSINESS". Business's primary website.
	WebsiteURL string            `json:"website_url" format:"string"`
	JSON       accountHolderJSON `json:"-"`
}

func (*AccountHolder) UnmarshalJSON 

func (r *AccountHolder) UnmarshalJSON(data []byte) (err error)

type AccountHolderBeneficialOwnerEntity added in v0.8.0 

type AccountHolderBeneficialOwnerEntity struct {
	// Business's physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address shared.Address `json:"address,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName string `json:"dba_business_name,required"`
	// Globally unique identifier for the entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID string `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName string `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers []string `json:"phone_numbers,required"`
	// Parent company name (if applicable).
	ParentCompany string                                 `json:"parent_company"`
	JSON          accountHolderBeneficialOwnerEntityJSON `json:"-"`
}

func (*AccountHolderBeneficialOwnerEntity) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderBeneficialOwnerEntity) UnmarshalJSON(data []byte) (err error)

type AccountHolderBeneficialOwnerIndividual added in v0.8.0 

type AccountHolderBeneficialOwnerIndividual struct {
	// Individual's current address
	Address shared.Address `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob,required"`
	// Individual's email address.
	Email string `json:"email,required"`
	// Globally unique identifier for the entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                                     `json:"phone_number,required"`
	JSON        accountHolderBeneficialOwnerIndividualJSON `json:"-"`
}

Information about an individual associated with an account holder. A subset of the information provided via KYC. For example, we do not return the government id.

func (*AccountHolderBeneficialOwnerIndividual) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderBeneficialOwnerIndividual) UnmarshalJSON(data []byte) (err error)

type AccountHolderBusinessEntity added in v0.8.0 

type AccountHolderBusinessEntity struct {
	// Business's physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address shared.Address `json:"address,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName string `json:"dba_business_name,required"`
	// Globally unique identifier for the entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID string `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName string `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers []string `json:"phone_numbers,required"`
	// Parent company name (if applicable).
	ParentCompany string                          `json:"parent_company"`
	JSON          accountHolderBusinessEntityJSON `json:"-"`
}

Only present when user_type == "BUSINESS". Information about the business for which the account is being opened and KYB is being run.

func (*AccountHolderBusinessEntity) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderBusinessEntity) UnmarshalJSON(data []byte) (err error)

type AccountHolderControlPerson added in v0.8.0 

type AccountHolderControlPerson struct {
	// Individual's current address
	Address shared.Address `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob,required"`
	// Individual's email address.
	Email string `json:"email,required"`
	// Globally unique identifier for the entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                         `json:"phone_number,required"`
	JSON        accountHolderControlPersonJSON `json:"-"`
}

Only present when user_type == "BUSINESS". An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.

func (*AccountHolderControlPerson) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderControlPerson) UnmarshalJSON(data []byte) (err error)

type AccountHolderExemptionType added in v0.8.0 

type AccountHolderExemptionType string

The type of KYC exemption for a KYC-Exempt Account Holder. 

const (
	AccountHolderExemptionTypeAuthorizedUser  AccountHolderExemptionType = "AUTHORIZED_USER"
	AccountHolderExemptionTypePrepaidCardUser AccountHolderExemptionType = "PREPAID_CARD_USER"
)

func (AccountHolderExemptionType) IsKnown added in v0.27.0 

func (r AccountHolderExemptionType) IsKnown() bool

type AccountHolderIndividual added in v0.8.0 

type AccountHolderIndividual struct {
	// Individual's current address
	Address shared.Address `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob,required"`
	// Individual's email address.
	Email string `json:"email,required"`
	// Globally unique identifier for the entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                      `json:"phone_number,required"`
	JSON        accountHolderIndividualJSON `json:"-"`
}

Only present when user_type == "INDIVIDUAL". Information about the individual for which the account is being opened and KYC is being run.

func (*AccountHolderIndividual) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderIndividual) UnmarshalJSON(data []byte) (err error)

type AccountHolderListDocumentsResponse 

type AccountHolderListDocumentsResponse struct {
	Data []shared.Document                      `json:"data"`
	JSON accountHolderListDocumentsResponseJSON `json:"-"`
}

func (*AccountHolderListDocumentsResponse) UnmarshalJSON 

func (r *AccountHolderListDocumentsResponse) UnmarshalJSON(data []byte) (err error)

type AccountHolderListParams added in v0.19.1 

type AccountHolderListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Email address of the account holder. The query must be an exact match, case
	// insensitive.
	Email param.Field[string] `query:"email"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// If applicable, represents the external_id associated with the account_holder.
	ExternalID param.Field[string] `query:"external_id" format:"uuid"`
	// (Individual Account Holders only) The first name of the account holder. The
	// query is case insensitive and supports partial matches.
	FirstName param.Field[string] `query:"first_name"`
	// (Individual Account Holders only) The last name of the account holder. The query
	// is case insensitive and supports partial matches.
	LastName param.Field[string] `query:"last_name"`
	// (Business Account Holders only) The legal business name of the account holder.
	// The query is case insensitive and supports partial matches.
	LegalBusinessName param.Field[string] `query:"legal_business_name"`
	// The number of account_holders to limit the response to.
	Limit param.Field[int64] `query:"limit"`
	// Phone number of the account holder. The query must be an exact match.
	PhoneNumber param.Field[string] `query:"phone_number"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (AccountHolderListParams) URLQuery added in v0.19.1 

func (r AccountHolderListParams) URLQuery() (v url.Values)

URLQuery serializes AccountHolderListParams's query parameters as `url.Values`.

type AccountHolderNewParams 

type AccountHolderNewParams struct {
	Body AccountHolderNewParamsBodyUnion `json:"body,required"`
}

func (AccountHolderNewParams) MarshalJSON added in v0.29.0 

func (r AccountHolderNewParams) MarshalJSON() (data []byte, err error)

type AccountHolderNewParamsBody added in v0.29.0 

type AccountHolderNewParamsBody struct {
	// Specifies the type of KYB workflow to run.
	Workflow param.Field[AccountHolderNewParamsBodyWorkflow] `json:"workflow,required"`
	// KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address                    param.Field[shared.AddressParam] `json:"address"`
	BeneficialOwnerEntities    param.Field[interface{}]         `json:"beneficial_owner_entities"`
	BeneficialOwnerIndividuals param.Field[interface{}]         `json:"beneficial_owner_individuals"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Pass the account_token of the enrolled business associated
	// with the AUTHORIZED_USER in this field.
	BusinessAccountToken param.Field[string]      `json:"business_account_token"`
	BusinessEntity       param.Field[interface{}] `json:"business_entity"`
	ControlPerson        param.Field[interface{}] `json:"control_person"`
	// The KYC Exempt user's email
	Email param.Field[string] `json:"email"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// The KYC Exempt user's first name
	FirstName  param.Field[string]      `json:"first_name"`
	Individual param.Field[interface{}] `json:"individual"`
	// An RFC 3339 timestamp indicating when precomputed KYC was completed on the
	// business with a pass result.
	//
	// This field is required only if workflow type is `KYB_BYO`.
	KYBPassedTimestamp param.Field[string] `json:"kyb_passed_timestamp"`
	// Specifies the type of KYC Exempt user
	KYCExemptionType param.Field[AccountHolderNewParamsBodyKYCExemptionType] `json:"kyc_exemption_type"`
	// An RFC 3339 timestamp indicating when precomputed KYC was completed on the
	// individual with a pass result.
	//
	// This field is required only if workflow type is `KYC_BYO`.
	KYCPassedTimestamp param.Field[string] `json:"kyc_passed_timestamp"`
	// The KYC Exempt user's last name
	LastName param.Field[string] `json:"last_name"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness param.Field[string] `json:"nature_of_business"`
	// The KYC Exempt user's phone number
	PhoneNumber param.Field[string] `json:"phone_number"`
	// An RFC 3339 timestamp indicating when the account holder accepted the applicable
	// legal agreements (e.g., cardholder terms) as agreed upon during API customer's
	// implementation with Lithic.
	TosTimestamp param.Field[string] `json:"tos_timestamp"`
	// Company website URL.
	WebsiteURL param.Field[string] `json:"website_url"`
}

func (AccountHolderNewParamsBody) MarshalJSON added in v0.29.0 

func (r AccountHolderNewParamsBody) MarshalJSON() (data []byte, err error)

type AccountHolderNewParamsBodyKYCExemptionType added in v0.29.0 

type AccountHolderNewParamsBodyKYCExemptionType string

Specifies the type of KYC Exempt user 

const (
	AccountHolderNewParamsBodyKYCExemptionTypeAuthorizedUser  AccountHolderNewParamsBodyKYCExemptionType = "AUTHORIZED_USER"
	AccountHolderNewParamsBodyKYCExemptionTypePrepaidCardUser AccountHolderNewParamsBodyKYCExemptionType = "PREPAID_CARD_USER"
)

func (AccountHolderNewParamsBodyKYCExemptionType) IsKnown added in v0.29.0 

func (r AccountHolderNewParamsBodyKYCExemptionType) IsKnown() bool

type AccountHolderNewParamsBodyUnion added in v0.29.0 

type AccountHolderNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by KYBParam, KYCParam, KYCExemptParam, AccountHolderNewParamsBody.

type AccountHolderNewParamsBodyWorkflow added in v0.29.0 

type AccountHolderNewParamsBodyWorkflow string

Specifies the type of KYB workflow to run. 

const (
	AccountHolderNewParamsBodyWorkflowKYBBasic    AccountHolderNewParamsBodyWorkflow = "KYB_BASIC"
	AccountHolderNewParamsBodyWorkflowKYBByo      AccountHolderNewParamsBodyWorkflow = "KYB_BYO"
	AccountHolderNewParamsBodyWorkflowKYCAdvanced AccountHolderNewParamsBodyWorkflow = "KYC_ADVANCED"
	AccountHolderNewParamsBodyWorkflowKYCBasic    AccountHolderNewParamsBodyWorkflow = "KYC_BASIC"
	AccountHolderNewParamsBodyWorkflowKYCByo      AccountHolderNewParamsBodyWorkflow = "KYC_BYO"
	AccountHolderNewParamsBodyWorkflowKYCExempt   AccountHolderNewParamsBodyWorkflow = "KYC_EXEMPT"
)

func (AccountHolderNewParamsBodyWorkflow) IsKnown added in v0.29.0 

func (r AccountHolderNewParamsBodyWorkflow) IsKnown() bool

type AccountHolderNewResponse added in v0.20.0 

type AccountHolderNewResponse struct {
	// Globally unique identifier for the account holder.
	Token string `json:"token,required" format:"uuid"`
	// Globally unique identifier for the account.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// KYC and KYB evaluation states.
	//
	// Note:
	//
	//   - `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
	//     `KYC_ADVANCED` workflow.
	//   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
	Status AccountHolderNewResponseStatus `json:"status,required"`
	// Reason for the evaluation status.
	StatusReasons []AccountHolderNewResponseStatusReason `json:"status_reasons,required"`
	// Timestamp of when the account holder was created.
	Created time.Time `json:"created" format:"date-time"`
	// Customer-provided token that indicates a relationship with an object outside of
	// the Lithic ecosystem.
	ExternalID string `json:"external_id" format:"string"`
	// Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
	// required for the account holder to be approved.
	RequiredDocuments []RequiredDocument           `json:"required_documents"`
	JSON              accountHolderNewResponseJSON `json:"-"`
}

func (*AccountHolderNewResponse) UnmarshalJSON added in v0.20.0 

func (r *AccountHolderNewResponse) UnmarshalJSON(data []byte) (err error)

type AccountHolderNewResponseStatus added in v0.20.0 

type AccountHolderNewResponseStatus string

KYC and KYB evaluation states.

Note:

  • `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `KYC_ADVANCED` workflow.
  • `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
const (
	AccountHolderNewResponseStatusAccepted        AccountHolderNewResponseStatus = "ACCEPTED"
	AccountHolderNewResponseStatusPendingReview   AccountHolderNewResponseStatus = "PENDING_REVIEW"
	AccountHolderNewResponseStatusPendingDocument AccountHolderNewResponseStatus = "PENDING_DOCUMENT"
	AccountHolderNewResponseStatusPendingResubmit AccountHolderNewResponseStatus = "PENDING_RESUBMIT"
	AccountHolderNewResponseStatusRejected        AccountHolderNewResponseStatus = "REJECTED"
)

func (AccountHolderNewResponseStatus) IsKnown added in v0.27.0 

func (r AccountHolderNewResponseStatus) IsKnown() bool

type AccountHolderNewResponseStatusReason added in v0.20.0 

type AccountHolderNewResponseStatusReason string

Status Reasons for KYC/KYB enrollment states 

const (
	AccountHolderNewResponseStatusReasonAddressVerificationFailure                      AccountHolderNewResponseStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonAgeThresholdFailure                             AccountHolderNewResponseStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderNewResponseStatusReasonCompleteVerificationFailure                     AccountHolderNewResponseStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonDobVerificationFailure                          AccountHolderNewResponseStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonIDVerificationFailure                           AccountHolderNewResponseStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonMaxDocumentAttempts                             AccountHolderNewResponseStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderNewResponseStatusReasonMaxResubmissionAttempts                         AccountHolderNewResponseStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderNewResponseStatusReasonNameVerificationFailure                         AccountHolderNewResponseStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonOtherVerificationFailure                        AccountHolderNewResponseStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonRiskThresholdFailure                            AccountHolderNewResponseStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderNewResponseStatusReasonWatchlistAlertFailure                           AccountHolderNewResponseStatusReason = "WATCHLIST_ALERT_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityIDVerificationFailure      AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityAddressVerificationFailure AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityNameVerificationFailure    AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntitySosFilingInactive          AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntitySosNotMatched              AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityCmraFailure                AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityWatchlistFailure           AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderNewResponseStatusReasonPrimaryBusinessEntityRegisteredAgentFailure     AccountHolderNewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderNewResponseStatusReasonControlPersonBlocklistAlertFailure              AccountHolderNewResponseStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderNewResponseStatusReasonControlPersonIDVerificationFailure              AccountHolderNewResponseStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonControlPersonDobVerificationFailure             AccountHolderNewResponseStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderNewResponseStatusReasonControlPersonNameVerificationFailure            AccountHolderNewResponseStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderNewResponseStatusReason) IsKnown added in v0.27.0 

func (r AccountHolderNewResponseStatusReason) IsKnown() bool

type AccountHolderResubmitParams 

type AccountHolderResubmitParams struct {
	// Information on individual for whom the account is being opened and KYC is being
	// re-run.
	Individual param.Field[AccountHolderResubmitParamsIndividual] `json:"individual,required"`
	// An RFC 3339 timestamp indicating when the account holder accepted the applicable
	// legal agreements (e.g., cardholder terms) as agreed upon during API customer's
	// implementation with Lithic.
	TosTimestamp param.Field[string]                              `json:"tos_timestamp,required"`
	Workflow     param.Field[AccountHolderResubmitParamsWorkflow] `json:"workflow,required"`
}

func (AccountHolderResubmitParams) MarshalJSON 

func (r AccountHolderResubmitParams) MarshalJSON() (data []byte, err error)

type AccountHolderResubmitParamsIndividual 

type AccountHolderResubmitParamsIndividual struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[string] `json:"dob,required"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email param.Field[string] `json:"email,required"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name,required"`
	// Government-issued identification number (required for identity verification and
	// compliance with banking regulations). Social Security Numbers (SSN) and
	// Individual Taxpayer Identification Numbers (ITIN) are currently supported,
	// entered as full nine-digits, with or without hyphens
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber param.Field[string] `json:"phone_number,required"`
}

Information on individual for whom the account is being opened and KYC is being re-run.

func (AccountHolderResubmitParamsIndividual) MarshalJSON added in v0.3.1 

func (r AccountHolderResubmitParamsIndividual) MarshalJSON() (data []byte, err error)

type AccountHolderResubmitParamsWorkflow 

type AccountHolderResubmitParamsWorkflow string
const (
	AccountHolderResubmitParamsWorkflowKYCAdvanced AccountHolderResubmitParamsWorkflow = "KYC_ADVANCED"
)

func (AccountHolderResubmitParamsWorkflow) IsKnown added in v0.27.0 

func (r AccountHolderResubmitParamsWorkflow) IsKnown() bool

type AccountHolderService 

type AccountHolderService struct {
	Options []option.RequestOption
}

AccountHolderService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountHolderService method instead.

func NewAccountHolderService 

func NewAccountHolderService(opts ...option.RequestOption) (r *AccountHolderService)

NewAccountHolderService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AccountHolderService) Get 

func (r *AccountHolderService) Get(ctx context.Context, accountHolderToken string, opts ...option.RequestOption) (res *AccountHolder, err error)

Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status.

func (*AccountHolderService) GetDocument 

func (r *AccountHolderService) GetDocument(ctx context.Context, accountHolderToken string, documentToken string, opts ...option.RequestOption) (res *shared.Document, err error)

Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.

Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).

In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.

When a new account holder document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` array in a `PENDING` state for the corresponding `image_type`.

func (*AccountHolderService) List added in v0.19.1 

func (r *AccountHolderService) List(ctx context.Context, query AccountHolderListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AccountHolder], err error)

Get a list of individual or business account holders and their KYC or KYB evaluation status.

func (*AccountHolderService) ListAutoPaging added in v0.19.1 

func (r *AccountHolderService) ListAutoPaging(ctx context.Context, query AccountHolderListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AccountHolder]

Get a list of individual or business account holders and their KYC or KYB evaluation status.

func (*AccountHolderService) ListDocuments 

func (r *AccountHolderService) ListDocuments(ctx context.Context, accountHolderToken string, opts ...option.RequestOption) (res *AccountHolderListDocumentsResponse, err error)

Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads.

Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).

In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a previous account holder document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.

When a new document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` list in a `PENDING` state for the corresponding `image_type`.

func (*AccountHolderService) New 

func (r *AccountHolderService) New(ctx context.Context, body AccountHolderNewParams, opts ...option.RequestOption) (res *AccountHolderNewResponse, err error)

Run an individual or business's information through the Customer Identification Program (CIP). All calls to this endpoint will return an immediate response - though in some cases, the response may indicate the enrollment is under review or further action will be needed to complete the account enrollment process. This endpoint can only be used on accounts that are part of the program that the calling API key manages.

Note: If you choose to set a timeout for this request, we recommend 5 minutes.

func (*AccountHolderService) Resubmit 

func (r *AccountHolderService) Resubmit(ctx context.Context, accountHolderToken string, body AccountHolderResubmitParams, opts ...option.RequestOption) (res *AccountHolder, err error)

Resubmit a KYC submission. This endpoint should be used in cases where a KYC submission returned a `PENDING_RESUBMIT` result, meaning one or more critical KYC fields may have been mis-entered and the individual's identity has not yet been successfully verified. This step must be completed in order to proceed with the KYC evaluation.

Two resubmission attempts are permitted via this endpoint before a `REJECTED` status is returned and the account creation process is ended.

func (*AccountHolderService) SimulateEnrollmentDocumentReview added in v0.41.0 

func (r *AccountHolderService) SimulateEnrollmentDocumentReview(ctx context.Context, body AccountHolderSimulateEnrollmentDocumentReviewParams, opts ...option.RequestOption) (res *shared.Document, err error)

Simulates a review for an account holder document upload.

func (*AccountHolderService) SimulateEnrollmentReview added in v0.41.0 

func (r *AccountHolderService) SimulateEnrollmentReview(ctx context.Context, body AccountHolderSimulateEnrollmentReviewParams, opts ...option.RequestOption) (res *AccountHolderSimulateEnrollmentReviewResponse, err error)

Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as `KYB_BASIC` or `KYC_ADVANCED`.

func (*AccountHolderService) Update 

func (r *AccountHolderService) Update(ctx context.Context, accountHolderToken string, body AccountHolderUpdateParams, opts ...option.RequestOption) (res *AccountHolderUpdateResponse, err error)

Update the information associated with a particular account holder.

func (*AccountHolderService) UploadDocument 

func (r *AccountHolderService) UploadDocument(ctx context.Context, accountHolderToken string, body AccountHolderUploadDocumentParams, opts ...option.RequestOption) (res *shared.Document, err error)

Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification. It will return two URLs to upload your document images to - one for the front image and one for the back image.

This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.

Uploaded images must either be a `jpg` or `png` file, and each must be less than 15 MiB. Once both required uploads have been successfully completed, your document will be run through KYC verification.

If you have registered a webhook, you will receive evaluation updates for any document submission evaluations, as well as for any failed document uploads.

Two document submission attempts are permitted via this endpoint before a `REJECTED` status is returned and the account creation process is ended. Currently only one type of account holder document is supported per KYC verification.

type AccountHolderSimulateEnrollmentDocumentReviewParams added in v0.41.0 

type AccountHolderSimulateEnrollmentDocumentReviewParams struct {
	// The account holder document upload which to perform the simulation upon.
	DocumentUploadToken param.Field[string] `json:"document_upload_token,required"`
	// An account holder document's upload status for use within the simulation.
	Status param.Field[AccountHolderSimulateEnrollmentDocumentReviewParamsStatus] `json:"status,required"`
	// A list of status reasons associated with a KYB account holder in PENDING_REVIEW
	AcceptedEntityStatusReasons param.Field[[]string] `json:"accepted_entity_status_reasons"`
	// Status reason that will be associated with the simulated account holder status.
	// Only required for a `REJECTED` status or `PARTIAL_APPROVAL` status.
	StatusReason param.Field[AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason] `json:"status_reason"`
}

func (AccountHolderSimulateEnrollmentDocumentReviewParams) MarshalJSON added in v0.41.0 

func (r AccountHolderSimulateEnrollmentDocumentReviewParams) MarshalJSON() (data []byte, err error)

type AccountHolderSimulateEnrollmentDocumentReviewParamsStatus added in v0.41.0 

type AccountHolderSimulateEnrollmentDocumentReviewParamsStatus string

An account holder document's upload status for use within the simulation. 

const (
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusUploaded        AccountHolderSimulateEnrollmentDocumentReviewParamsStatus = "UPLOADED"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusAccepted        AccountHolderSimulateEnrollmentDocumentReviewParamsStatus = "ACCEPTED"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusRejected        AccountHolderSimulateEnrollmentDocumentReviewParamsStatus = "REJECTED"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusPartialApproval AccountHolderSimulateEnrollmentDocumentReviewParamsStatus = "PARTIAL_APPROVAL"
)

func (AccountHolderSimulateEnrollmentDocumentReviewParamsStatus) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentDocumentReviewParamsStatus) IsKnown() bool

type AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason added in v0.41.0 

type AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason string

Status reason that will be associated with the simulated account holder status. Only required for a `REJECTED` status or `PARTIAL_APPROVAL` status. 

const (
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonDocumentMissingRequiredData     AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "DOCUMENT_MISSING_REQUIRED_DATA"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonDocumentUploadTooBlurry         AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "DOCUMENT_UPLOAD_TOO_BLURRY"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonFileSizeTooLarge                AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "FILE_SIZE_TOO_LARGE"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonInvalidDocumentType             AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "INVALID_DOCUMENT_TYPE"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonInvalidDocumentUpload           AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "INVALID_DOCUMENT_UPLOAD"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonInvalidEntity                   AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "INVALID_ENTITY"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonDocumentExpired                 AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "DOCUMENT_EXPIRED"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonDocumentIssuedGreaterThan30Days AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "DOCUMENT_ISSUED_GREATER_THAN_30_DAYS"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonDocumentTypeNotSupported        AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "DOCUMENT_TYPE_NOT_SUPPORTED"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonUnknownFailureReason            AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "UNKNOWN_FAILURE_REASON"
	AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReasonUnknownError                    AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason = "UNKNOWN_ERROR"
)

func (AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentDocumentReviewParamsStatusReason) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewParams added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewParams struct {
	// The account holder which to perform the simulation upon.
	AccountHolderToken param.Field[string] `json:"account_holder_token"`
	// An account holder's status for use within the simulation.
	Status param.Field[AccountHolderSimulateEnrollmentReviewParamsStatus] `json:"status"`
	// Status reason that will be associated with the simulated account holder status.
	// Only required for a `REJECTED` status.
	StatusReasons param.Field[[]AccountHolderSimulateEnrollmentReviewParamsStatusReason] `json:"status_reasons"`
}

func (AccountHolderSimulateEnrollmentReviewParams) MarshalJSON added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewParams) MarshalJSON() (data []byte, err error)

type AccountHolderSimulateEnrollmentReviewParamsStatus added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewParamsStatus string

An account holder's status for use within the simulation. 

const (
	AccountHolderSimulateEnrollmentReviewParamsStatusAccepted AccountHolderSimulateEnrollmentReviewParamsStatus = "ACCEPTED"
	AccountHolderSimulateEnrollmentReviewParamsStatusRejected AccountHolderSimulateEnrollmentReviewParamsStatus = "REJECTED"
)

func (AccountHolderSimulateEnrollmentReviewParamsStatus) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewParamsStatus) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewParamsStatusReason added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewParamsStatusReason string
const (
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityIDVerificationFailure       AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityAddressVerificationFailure  AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityNameVerificationFailure     AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched  AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntitySosFilingInactive           AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntitySosNotMatched               AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityCmraFailure                 AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityWatchlistFailure            AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonPrimaryBusinessEntityRegisteredAgentFailure      AccountHolderSimulateEnrollmentReviewParamsStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonControlPersonBlocklistAlertFailure               AccountHolderSimulateEnrollmentReviewParamsStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonControlPersonIDVerificationFailure               AccountHolderSimulateEnrollmentReviewParamsStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonControlPersonDobVerificationFailure              AccountHolderSimulateEnrollmentReviewParamsStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonControlPersonNameVerificationFailure             AccountHolderSimulateEnrollmentReviewParamsStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonBeneficialOwnerIndividualDobVerificationFailure  AccountHolderSimulateEnrollmentReviewParamsStatusReason = "BENEFICIAL_OWNER_INDIVIDUAL_DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonBeneficialOwnerIndividualBlocklistAlertFailure   AccountHolderSimulateEnrollmentReviewParamsStatusReason = "BENEFICIAL_OWNER_INDIVIDUAL_BLOCKLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonBeneficialOwnerIndividualIDVerificationFailure   AccountHolderSimulateEnrollmentReviewParamsStatusReason = "BENEFICIAL_OWNER_INDIVIDUAL_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewParamsStatusReasonBeneficialOwnerIndividualNameVerificationFailure AccountHolderSimulateEnrollmentReviewParamsStatusReason = "BENEFICIAL_OWNER_INDIVIDUAL_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderSimulateEnrollmentReviewParamsStatusReason) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewParamsStatusReason) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponse added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponse struct {
	// Globally unique identifier for the account holder.
	Token string `json:"token" format:"uuid"`
	// Globally unique identifier for the account.
	AccountToken string `json:"account_token" format:"uuid"`
	// Only present when user_type == "BUSINESS". List of all entities with >25%
	// ownership in the company.
	BeneficialOwnerEntities []AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntity `json:"beneficial_owner_entities"`
	// Only present when user_type == "BUSINESS". List of all individuals with >25%
	// ownership in the company.
	BeneficialOwnerIndividuals []AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividual `json:"beneficial_owner_individuals"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Pass the account_token of the enrolled business associated
	// with the AUTHORIZED_USER in this field.
	BusinessAccountToken string `json:"business_account_token" format:"uuid"`
	// Only present when user_type == "BUSINESS". Information about the business for
	// which the account is being opened and KYB is being run.
	BusinessEntity AccountHolderSimulateEnrollmentReviewResponseBusinessEntity `json:"business_entity"`
	// Only present when user_type == "BUSINESS".
	//
	// An individual with significant responsibility for managing the legal entity
	// (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
	// Officer,
	//
	// Managing Member, General Partner, President, Vice President, or Treasurer). This
	// can be an executive, or someone who will have program-wide access
	//
	// to the cards that Lithic will provide. In some cases, this individual could also
	// be a beneficial owner listed above.
	ControlPerson AccountHolderSimulateEnrollmentReviewResponseControlPerson `json:"control_person"`
	// Timestamp of when the account holder was created.
	Created time.Time `json:"created" format:"date-time"`
	// < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
	// individual.phone_number when user_type == "INDIVIDUAL".
	//
	// > Primary email of Account Holder.
	Email string `json:"email"`
	// The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
	// holder is not KYC-Exempt.
	ExemptionType AccountHolderSimulateEnrollmentReviewResponseExemptionType `json:"exemption_type"`
	// Customer-provided token that indicates a relationship with an object outside of
	// the Lithic ecosystem.
	ExternalID string `json:"external_id" format:"string"`
	// Only present when user_type == "INDIVIDUAL". Information about the individual
	// for which the account is being opened and KYC is being run.
	Individual AccountHolderSimulateEnrollmentReviewResponseIndividual `json:"individual"`
	// Only present when user_type == "BUSINESS". User-submitted description of the
	// business.
	NatureOfBusiness string `json:"nature_of_business" format:"string"`
	// < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
	// individual.phone_number when user_type == "INDIVIDUAL".
	//
	// > Primary phone of Account Holder, entered in E.164 format.
	PhoneNumber string `json:"phone_number"`
	// Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
	// required for the account holder to be approved.
	RequiredDocuments []RequiredDocument `json:"required_documents"`
	// <Deprecated. Use verification_application.status instead>
	//
	// KYC and KYB evaluation states.
	//
	// Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
	// `ADVANCED` workflow.
	Status AccountHolderSimulateEnrollmentReviewResponseStatus `json:"status"`
	// <Deprecated. Use verification_application.status_reasons> Reason for the
	// evaluation status.
	StatusReasons []AccountHolderSimulateEnrollmentReviewResponseStatusReason `json:"status_reasons"`
	// The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
	// attribute will be present.
	//
	// If the type is "BUSINESS" then the "business_entity", "control_person",
	// "beneficial_owner_individuals", "beneficial_owner_entities",
	//
	// "nature_of_business", and "website_url" attributes will be present.
	UserType AccountHolderSimulateEnrollmentReviewResponseUserType `json:"user_type"`
	// Information about the most recent identity verification attempt
	VerificationApplication AccountHolderSimulateEnrollmentReviewResponseVerificationApplication `json:"verification_application"`
	// Only present when user_type == "BUSINESS". Business's primary website.
	WebsiteURL string                                            `json:"website_url" format:"string"`
	JSON       accountHolderSimulateEnrollmentReviewResponseJSON `json:"-"`
}

func (*AccountHolderSimulateEnrollmentReviewResponse) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponse) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddress added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// Name of city.
	City string `json:"city,required"`
	// Valid country code. Only USA is currently supported, entered in uppercase ISO
	// 3166-1 alpha-3 three-character format.
	Country string `json:"country,required"`
	// Valid postal code. Only USA ZIP codes are currently supported, entered as a
	// five-digit ZIP or nine-digit ZIP+4.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                                                                          `json:"address2"`
	JSON     accountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddressJSON `json:"-"`
}

Business”s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

func (*AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddress) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddress) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntity added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntity struct {
	// Business”s physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntitiesAddress `json:"address,required"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID string `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName string `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers []string `json:"phone_numbers,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName string `json:"dba_business_name"`
	// Parent company name (if applicable).
	ParentCompany string                                                                 `json:"parent_company"`
	JSON          accountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntityJSON `json:"-"`
}

func (*AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntity) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerEntity) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividual added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividual struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddress `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email string `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                                                                     `json:"phone_number"`
	JSON        accountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualJSON `json:"-"`
}

func (*AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividual) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividual) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddress added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// Name of city.
	City string `json:"city,required"`
	// Valid country code. Only USA is currently supported, entered in uppercase ISO
	// 3166-1 alpha-3 three-character format.
	Country string `json:"country,required"`
	// Valid postal code. Only USA ZIP codes are currently supported, entered as a
	// five-digit ZIP or nine-digit ZIP+4.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                                                                             `json:"address2"`
	JSON     accountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddressJSON `json:"-"`
}

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

func (*AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddress) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBeneficialOwnerIndividualsAddress) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBusinessEntity added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBusinessEntity struct {
	// Business”s physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address AccountHolderSimulateEnrollmentReviewResponseBusinessEntityAddress `json:"address,required"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID string `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName string `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers []string `json:"phone_numbers,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName string `json:"dba_business_name"`
	// Parent company name (if applicable).
	ParentCompany string                                                          `json:"parent_company"`
	JSON          accountHolderSimulateEnrollmentReviewResponseBusinessEntityJSON `json:"-"`
}

Only present when user_type == "BUSINESS". Information about the business for which the account is being opened and KYB is being run.

func (*AccountHolderSimulateEnrollmentReviewResponseBusinessEntity) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBusinessEntity) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseBusinessEntityAddress added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseBusinessEntityAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// Name of city.
	City string `json:"city,required"`
	// Valid country code. Only USA is currently supported, entered in uppercase ISO
	// 3166-1 alpha-3 three-character format.
	Country string `json:"country,required"`
	// Valid postal code. Only USA ZIP codes are currently supported, entered as a
	// five-digit ZIP or nine-digit ZIP+4.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                                                                 `json:"address2"`
	JSON     accountHolderSimulateEnrollmentReviewResponseBusinessEntityAddressJSON `json:"-"`
}

Business”s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

func (*AccountHolderSimulateEnrollmentReviewResponseBusinessEntityAddress) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseBusinessEntityAddress) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseControlPerson added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseControlPerson struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address AccountHolderSimulateEnrollmentReviewResponseControlPersonAddress `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email string `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                                                         `json:"phone_number"`
	JSON        accountHolderSimulateEnrollmentReviewResponseControlPersonJSON `json:"-"`
}

Only present when user_type == "BUSINESS".

An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,

Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access

to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.

func (*AccountHolderSimulateEnrollmentReviewResponseControlPerson) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseControlPerson) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseControlPersonAddress added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseControlPersonAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// Name of city.
	City string `json:"city,required"`
	// Valid country code. Only USA is currently supported, entered in uppercase ISO
	// 3166-1 alpha-3 three-character format.
	Country string `json:"country,required"`
	// Valid postal code. Only USA ZIP codes are currently supported, entered as a
	// five-digit ZIP or nine-digit ZIP+4.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                                                                `json:"address2"`
	JSON     accountHolderSimulateEnrollmentReviewResponseControlPersonAddressJSON `json:"-"`
}

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

func (*AccountHolderSimulateEnrollmentReviewResponseControlPersonAddress) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseControlPersonAddress) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseExemptionType added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseExemptionType string

The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account holder is not KYC-Exempt. 

const (
	AccountHolderSimulateEnrollmentReviewResponseExemptionTypeAuthorizedUser  AccountHolderSimulateEnrollmentReviewResponseExemptionType = "AUTHORIZED_USER"
	AccountHolderSimulateEnrollmentReviewResponseExemptionTypePrepaidCardUser AccountHolderSimulateEnrollmentReviewResponseExemptionType = "PREPAID_CARD_USER"
)

func (AccountHolderSimulateEnrollmentReviewResponseExemptionType) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseExemptionType) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponseIndividual added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseIndividual struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address AccountHolderSimulateEnrollmentReviewResponseIndividualAddress `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email string `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName string `json:"first_name"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName string `json:"last_name"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber string                                                      `json:"phone_number"`
	JSON        accountHolderSimulateEnrollmentReviewResponseIndividualJSON `json:"-"`
}

Only present when user_type == "INDIVIDUAL". Information about the individual for which the account is being opened and KYC is being run.

func (*AccountHolderSimulateEnrollmentReviewResponseIndividual) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseIndividual) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseIndividualAddress added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseIndividualAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// Name of city.
	City string `json:"city,required"`
	// Valid country code. Only USA is currently supported, entered in uppercase ISO
	// 3166-1 alpha-3 three-character format.
	Country string `json:"country,required"`
	// Valid postal code. Only USA ZIP codes are currently supported, entered as a
	// five-digit ZIP or nine-digit ZIP+4.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                                                             `json:"address2"`
	JSON     accountHolderSimulateEnrollmentReviewResponseIndividualAddressJSON `json:"-"`
}

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

func (*AccountHolderSimulateEnrollmentReviewResponseIndividualAddress) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseIndividualAddress) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseStatus added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseStatus string

<Deprecated. Use verification_application.status instead>

KYC and KYB evaluation states.

Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED` workflow. 

const (
	AccountHolderSimulateEnrollmentReviewResponseStatusAccepted        AccountHolderSimulateEnrollmentReviewResponseStatus = "ACCEPTED"
	AccountHolderSimulateEnrollmentReviewResponseStatusPendingDocument AccountHolderSimulateEnrollmentReviewResponseStatus = "PENDING_DOCUMENT"
	AccountHolderSimulateEnrollmentReviewResponseStatusPendingResubmit AccountHolderSimulateEnrollmentReviewResponseStatus = "PENDING_RESUBMIT"
	AccountHolderSimulateEnrollmentReviewResponseStatusRejected        AccountHolderSimulateEnrollmentReviewResponseStatus = "REJECTED"
)

func (AccountHolderSimulateEnrollmentReviewResponseStatus) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseStatus) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponseStatusReason added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseStatusReason string

Status Reasons for KYC/KYB enrollment states 

const (
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonAddressVerificationFailure                      AccountHolderSimulateEnrollmentReviewResponseStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonAgeThresholdFailure                             AccountHolderSimulateEnrollmentReviewResponseStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonCompleteVerificationFailure                     AccountHolderSimulateEnrollmentReviewResponseStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonDobVerificationFailure                          AccountHolderSimulateEnrollmentReviewResponseStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonIDVerificationFailure                           AccountHolderSimulateEnrollmentReviewResponseStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonMaxDocumentAttempts                             AccountHolderSimulateEnrollmentReviewResponseStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonMaxResubmissionAttempts                         AccountHolderSimulateEnrollmentReviewResponseStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonNameVerificationFailure                         AccountHolderSimulateEnrollmentReviewResponseStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonOtherVerificationFailure                        AccountHolderSimulateEnrollmentReviewResponseStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonRiskThresholdFailure                            AccountHolderSimulateEnrollmentReviewResponseStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonWatchlistAlertFailure                           AccountHolderSimulateEnrollmentReviewResponseStatusReason = "WATCHLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityIDVerificationFailure      AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityAddressVerificationFailure AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityNameVerificationFailure    AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntitySosFilingInactive          AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntitySosNotMatched              AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityCmraFailure                AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityWatchlistFailure           AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonPrimaryBusinessEntityRegisteredAgentFailure     AccountHolderSimulateEnrollmentReviewResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonControlPersonBlocklistAlertFailure              AccountHolderSimulateEnrollmentReviewResponseStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonControlPersonIDVerificationFailure              AccountHolderSimulateEnrollmentReviewResponseStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonControlPersonDobVerificationFailure             AccountHolderSimulateEnrollmentReviewResponseStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseStatusReasonControlPersonNameVerificationFailure            AccountHolderSimulateEnrollmentReviewResponseStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderSimulateEnrollmentReviewResponseStatusReason) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseStatusReason) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponseUserType added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseUserType string

The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attribute will be present.

If the type is "BUSINESS" then the "business_entity", "control_person", "beneficial_owner_individuals", "beneficial_owner_entities",

"nature_of_business", and "website_url" attributes will be present. 

const (
	AccountHolderSimulateEnrollmentReviewResponseUserTypeBusiness   AccountHolderSimulateEnrollmentReviewResponseUserType = "BUSINESS"
	AccountHolderSimulateEnrollmentReviewResponseUserTypeIndividual AccountHolderSimulateEnrollmentReviewResponseUserType = "INDIVIDUAL"
)

func (AccountHolderSimulateEnrollmentReviewResponseUserType) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseUserType) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplication added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplication struct {
	// Timestamp of when the application was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// KYC and KYB evaluation states.
	//
	// Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
	// `ADVANCED` workflow.
	Status AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus `json:"status,required"`
	// Reason for the evaluation status.
	StatusReasons []AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason `json:"status_reasons,required"`
	// Timestamp of when the application was last updated.
	Updated time.Time                                                                `json:"updated,required" format:"date-time"`
	JSON    accountHolderSimulateEnrollmentReviewResponseVerificationApplicationJSON `json:"-"`
}

Information about the most recent identity verification attempt

func (*AccountHolderSimulateEnrollmentReviewResponseVerificationApplication) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponseVerificationApplication) UnmarshalJSON(data []byte) (err error)

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus string

KYC and KYB evaluation states.

Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED` workflow. 

const (
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusAccepted        AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus = "ACCEPTED"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusPendingDocument AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus = "PENDING_DOCUMENT"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusPendingResubmit AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus = "PENDING_RESUBMIT"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusRejected        AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus = "REJECTED"
)

func (AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatus) IsKnown() bool

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason added in v0.41.0 

type AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason string

Status Reasons for KYC/KYB enrollment states 

const (
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonAddressVerificationFailure                      AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonAgeThresholdFailure                             AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonCompleteVerificationFailure                     AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonDobVerificationFailure                          AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonIDVerificationFailure                           AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonMaxDocumentAttempts                             AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonMaxResubmissionAttempts                         AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonNameVerificationFailure                         AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonOtherVerificationFailure                        AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonRiskThresholdFailure                            AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonWatchlistAlertFailure                           AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "WATCHLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityIDVerificationFailure      AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityAddressVerificationFailure AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityNameVerificationFailure    AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntitySosFilingInactive          AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntitySosNotMatched              AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityCmraFailure                AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityWatchlistFailure           AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonPrimaryBusinessEntityRegisteredAgentFailure     AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonControlPersonBlocklistAlertFailure              AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonControlPersonIDVerificationFailure              AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonControlPersonDobVerificationFailure             AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReasonControlPersonNameVerificationFailure            AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason) IsKnown added in v0.41.0 

func (r AccountHolderSimulateEnrollmentReviewResponseVerificationApplicationStatusReason) IsKnown() bool

type AccountHolderStatus 

type AccountHolderStatus string

<Deprecated. Use verification_application.status instead>

KYC and KYB evaluation states.

Note:

  • `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `KYC_ADVANCED` workflow.
  • `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
const (
	AccountHolderStatusAccepted        AccountHolderStatus = "ACCEPTED"
	AccountHolderStatusPendingReview   AccountHolderStatus = "PENDING_REVIEW"
	AccountHolderStatusPendingDocument AccountHolderStatus = "PENDING_DOCUMENT"
	AccountHolderStatusPendingResubmit AccountHolderStatus = "PENDING_RESUBMIT"
	AccountHolderStatusRejected        AccountHolderStatus = "REJECTED"
)

func (AccountHolderStatus) IsKnown added in v0.27.0 

func (r AccountHolderStatus) IsKnown() bool

type AccountHolderStatusReason added in v0.5.0 

type AccountHolderStatusReason string
const (
	AccountHolderStatusReasonAddressVerificationFailure  AccountHolderStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderStatusReasonAgeThresholdFailure         AccountHolderStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderStatusReasonCompleteVerificationFailure AccountHolderStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderStatusReasonDobVerificationFailure      AccountHolderStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderStatusReasonIDVerificationFailure       AccountHolderStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderStatusReasonMaxDocumentAttempts         AccountHolderStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderStatusReasonMaxResubmissionAttempts     AccountHolderStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderStatusReasonNameVerificationFailure     AccountHolderStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderStatusReasonOtherVerificationFailure    AccountHolderStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderStatusReasonRiskThresholdFailure        AccountHolderStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderStatusReasonWatchlistAlertFailure       AccountHolderStatusReason = "WATCHLIST_ALERT_FAILURE"
)

func (AccountHolderStatusReason) IsKnown added in v0.27.0 

func (r AccountHolderStatusReason) IsKnown() bool

type AccountHolderUpdateParams 

type AccountHolderUpdateParams struct {
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Pass the account_token of the enrolled business associated
	// with the AUTHORIZED_USER in this field.
	BusinessAccountToken param.Field[string] `json:"business_account_token"`
	// Account holder's email address. The primary purpose of this field is for
	// cardholder identification and verification during the digital wallet
	// tokenization process.
	Email param.Field[string] `json:"email"`
	// Account holder's phone number, entered in E.164 format. The primary purpose of
	// this field is for cardholder identification and verification during the digital
	// wallet tokenization process.
	PhoneNumber param.Field[string] `json:"phone_number"`
}

func (AccountHolderUpdateParams) MarshalJSON 

func (r AccountHolderUpdateParams) MarshalJSON() (data []byte, err error)

type AccountHolderUpdateResponse 

type AccountHolderUpdateResponse struct {
	// The token for the account holder that was updated
	Token string `json:"token"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll businesses
	// with authorized users. Pass the account_token of the enrolled business
	// associated with the AUTHORIZED_USER in this field.
	BusinessAccountToken string `json:"business_account_token"`
	// The newly updated email for the account holder
	Email string `json:"email"`
	// The newly updated phone_number for the account holder
	PhoneNumber string                          `json:"phone_number"`
	JSON        accountHolderUpdateResponseJSON `json:"-"`
}

func (*AccountHolderUpdateResponse) UnmarshalJSON 

func (r *AccountHolderUpdateResponse) UnmarshalJSON(data []byte) (err error)

type AccountHolderUploadDocumentParams 

type AccountHolderUploadDocumentParams struct {
	// The type of document to upload
	DocumentType param.Field[AccountHolderUploadDocumentParamsDocumentType] `json:"document_type,required"`
	// Globally unique identifier for the entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
}

func (AccountHolderUploadDocumentParams) MarshalJSON 

func (r AccountHolderUploadDocumentParams) MarshalJSON() (data []byte, err error)

type AccountHolderUploadDocumentParamsDocumentType 

type AccountHolderUploadDocumentParamsDocumentType string

The type of document to upload 

const (
	AccountHolderUploadDocumentParamsDocumentTypeEinLetter                 AccountHolderUploadDocumentParamsDocumentType = "EIN_LETTER"
	AccountHolderUploadDocumentParamsDocumentTypeTaxReturn                 AccountHolderUploadDocumentParamsDocumentType = "TAX_RETURN"
	AccountHolderUploadDocumentParamsDocumentTypeOperatingAgreement        AccountHolderUploadDocumentParamsDocumentType = "OPERATING_AGREEMENT"
	AccountHolderUploadDocumentParamsDocumentTypeCertificateOfFormation    AccountHolderUploadDocumentParamsDocumentType = "CERTIFICATE_OF_FORMATION"
	AccountHolderUploadDocumentParamsDocumentTypeDriversLicense            AccountHolderUploadDocumentParamsDocumentType = "DRIVERS_LICENSE"
	AccountHolderUploadDocumentParamsDocumentTypePassport                  AccountHolderUploadDocumentParamsDocumentType = "PASSPORT"
	AccountHolderUploadDocumentParamsDocumentTypePassportCard              AccountHolderUploadDocumentParamsDocumentType = "PASSPORT_CARD"
	AccountHolderUploadDocumentParamsDocumentTypeCertificateOfGoodStanding AccountHolderUploadDocumentParamsDocumentType = "CERTIFICATE_OF_GOOD_STANDING"
	AccountHolderUploadDocumentParamsDocumentTypeArticlesOfIncorporation   AccountHolderUploadDocumentParamsDocumentType = "ARTICLES_OF_INCORPORATION"
	AccountHolderUploadDocumentParamsDocumentTypeArticlesOfOrganization    AccountHolderUploadDocumentParamsDocumentType = "ARTICLES_OF_ORGANIZATION"
	AccountHolderUploadDocumentParamsDocumentTypeBylaws                    AccountHolderUploadDocumentParamsDocumentType = "BYLAWS"
	AccountHolderUploadDocumentParamsDocumentTypeGovernmentBusinessLicense AccountHolderUploadDocumentParamsDocumentType = "GOVERNMENT_BUSINESS_LICENSE"
	AccountHolderUploadDocumentParamsDocumentTypePartnershipAgreement      AccountHolderUploadDocumentParamsDocumentType = "PARTNERSHIP_AGREEMENT"
	AccountHolderUploadDocumentParamsDocumentTypeSs4Form                   AccountHolderUploadDocumentParamsDocumentType = "SS4_FORM"
	AccountHolderUploadDocumentParamsDocumentTypeBankStatement             AccountHolderUploadDocumentParamsDocumentType = "BANK_STATEMENT"
	AccountHolderUploadDocumentParamsDocumentTypeUtilityBillStatement      AccountHolderUploadDocumentParamsDocumentType = "UTILITY_BILL_STATEMENT"
	AccountHolderUploadDocumentParamsDocumentTypeSsnCard                   AccountHolderUploadDocumentParamsDocumentType = "SSN_CARD"
	AccountHolderUploadDocumentParamsDocumentTypeItinLetter                AccountHolderUploadDocumentParamsDocumentType = "ITIN_LETTER"
)

func (AccountHolderUploadDocumentParamsDocumentType) IsKnown added in v0.27.0 

func (r AccountHolderUploadDocumentParamsDocumentType) IsKnown() bool

type AccountHolderUserType added in v0.8.0 

type AccountHolderUserType string

The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attribute will be present. If the type is "BUSINESS" then the "business_entity", "control_person", "beneficial_owner_individuals", "beneficial_owner_entities", "nature_of_business", and "website_url" attributes will be present. 

const (
	AccountHolderUserTypeBusiness   AccountHolderUserType = "BUSINESS"
	AccountHolderUserTypeIndividual AccountHolderUserType = "INDIVIDUAL"
)

func (AccountHolderUserType) IsKnown added in v0.27.0 

func (r AccountHolderUserType) IsKnown() bool

type AccountHolderVerificationApplication added in v0.8.0 

type AccountHolderVerificationApplication struct {
	// Timestamp of when the application was created.
	Created time.Time `json:"created" format:"date-time"`
	// KYC and KYB evaluation states.
	//
	// Note:
	//
	//   - `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
	//     `KYC_ADVANCED` workflow.
	//   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
	Status AccountHolderVerificationApplicationStatus `json:"status"`
	// Reason for the evaluation status.
	StatusReasons []AccountHolderVerificationApplicationStatusReason `json:"status_reasons"`
	// Timestamp of when the application was last updated.
	Updated time.Time                                `json:"updated" format:"date-time"`
	JSON    accountHolderVerificationApplicationJSON `json:"-"`
}

Information about the most recent identity verification attempt

func (*AccountHolderVerificationApplication) UnmarshalJSON added in v0.8.0 

func (r *AccountHolderVerificationApplication) UnmarshalJSON(data []byte) (err error)

type AccountHolderVerificationApplicationStatus added in v0.8.0 

type AccountHolderVerificationApplicationStatus string

KYC and KYB evaluation states.

Note:

  • `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `KYC_ADVANCED` workflow.
  • `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
const (
	AccountHolderVerificationApplicationStatusAccepted        AccountHolderVerificationApplicationStatus = "ACCEPTED"
	AccountHolderVerificationApplicationStatusPendingReview   AccountHolderVerificationApplicationStatus = "PENDING_REVIEW"
	AccountHolderVerificationApplicationStatusPendingDocument AccountHolderVerificationApplicationStatus = "PENDING_DOCUMENT"
	AccountHolderVerificationApplicationStatusPendingResubmit AccountHolderVerificationApplicationStatus = "PENDING_RESUBMIT"
	AccountHolderVerificationApplicationStatusRejected        AccountHolderVerificationApplicationStatus = "REJECTED"
)

func (AccountHolderVerificationApplicationStatus) IsKnown added in v0.27.0 

func (r AccountHolderVerificationApplicationStatus) IsKnown() bool

type AccountHolderVerificationApplicationStatusReason added in v0.8.0 

type AccountHolderVerificationApplicationStatusReason string
const (
	AccountHolderVerificationApplicationStatusReasonAddressVerificationFailure  AccountHolderVerificationApplicationStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonAgeThresholdFailure         AccountHolderVerificationApplicationStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderVerificationApplicationStatusReasonCompleteVerificationFailure AccountHolderVerificationApplicationStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonDobVerificationFailure      AccountHolderVerificationApplicationStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonIDVerificationFailure       AccountHolderVerificationApplicationStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonMaxDocumentAttempts         AccountHolderVerificationApplicationStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderVerificationApplicationStatusReasonMaxResubmissionAttempts     AccountHolderVerificationApplicationStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderVerificationApplicationStatusReasonNameVerificationFailure     AccountHolderVerificationApplicationStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonOtherVerificationFailure    AccountHolderVerificationApplicationStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderVerificationApplicationStatusReasonRiskThresholdFailure        AccountHolderVerificationApplicationStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderVerificationApplicationStatusReasonWatchlistAlertFailure       AccountHolderVerificationApplicationStatusReason = "WATCHLIST_ALERT_FAILURE"
)

func (AccountHolderVerificationApplicationStatusReason) IsKnown added in v0.27.0 

func (r AccountHolderVerificationApplicationStatusReason) IsKnown() bool

type AccountListParams 

type AccountListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (AccountListParams) URLQuery 

func (r AccountListParams) URLQuery() (v url.Values)

URLQuery serializes AccountListParams's query parameters as `url.Values`.

type AccountService 

type AccountService struct {
	Options []option.RequestOption
}

AccountService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountService method instead.

func NewAccountService 

func NewAccountService(opts ...option.RequestOption) (r *AccountService)

NewAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AccountService) Get 

func (r *AccountService) Get(ctx context.Context, accountToken string, opts ...option.RequestOption) (res *Account, err error)

Get account configuration such as spend limits.

func (*AccountService) GetSpendLimits added in v0.15.0 

func (r *AccountService) GetSpendLimits(ctx context.Context, accountToken string, opts ...option.RequestOption) (res *AccountSpendLimits, err error)

Get an Account's available spend limits, which is based on the spend limit configured on the Account and the amount already spent over the spend limit's duration. For example, if the Account has a daily spend limit of $1000 configured, and has spent $600 in the last 24 hours, the available spend limit returned would be $400.

func (*AccountService) List 

func (r *AccountService) List(ctx context.Context, query AccountListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Account], err error)

List account configurations.

func (*AccountService) ListAutoPaging 

func (r *AccountService) ListAutoPaging(ctx context.Context, query AccountListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Account]

List account configurations.

func (*AccountService) Update 

func (r *AccountService) Update(ctx context.Context, accountToken string, body AccountUpdateParams, opts ...option.RequestOption) (res *Account, err error)

Update account configuration such as state or spend limits. Can only be run on accounts that are part of the program managed by this API key. Accounts that are in the `PAUSED` state will not be able to transact or create new cards.

type AccountSpendLimit 

type AccountSpendLimit struct {
	// Daily spend limit (in cents).
	Daily int64 `json:"daily,required"`
	// Total spend limit over account lifetime (in cents).
	Lifetime int64 `json:"lifetime,required"`
	// Monthly spend limit (in cents).
	Monthly int64                 `json:"monthly,required"`
	JSON    accountSpendLimitJSON `json:"-"`
}

Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.

func (*AccountSpendLimit) UnmarshalJSON 

func (r *AccountSpendLimit) UnmarshalJSON(data []byte) (err error)

type AccountSpendLimits added in v0.15.0 

type AccountSpendLimits struct {
	AvailableSpendLimit AccountSpendLimitsAvailableSpendLimit `json:"available_spend_limit,required"`
	SpendLimit          AccountSpendLimitsSpendLimit          `json:"spend_limit"`
	SpendVelocity       AccountSpendLimitsSpendVelocity       `json:"spend_velocity"`
	JSON                accountSpendLimitsJSON                `json:"-"`
}

func (*AccountSpendLimits) UnmarshalJSON added in v0.15.0 

func (r *AccountSpendLimits) UnmarshalJSON(data []byte) (err error)

type AccountSpendLimitsAvailableSpendLimit added in v0.15.0 

type AccountSpendLimitsAvailableSpendLimit struct {
	// The available spend limit (in cents) relative to the daily limit configured on
	// the Account.
	Daily int64 `json:"daily"`
	// The available spend limit (in cents) relative to the lifetime limit configured
	// on the Account.
	Lifetime int64 `json:"lifetime"`
	// The available spend limit (in cents) relative to the monthly limit configured on
	// the Account.
	Monthly int64                                     `json:"monthly"`
	JSON    accountSpendLimitsAvailableSpendLimitJSON `json:"-"`
}

func (*AccountSpendLimitsAvailableSpendLimit) UnmarshalJSON added in v0.15.0 

func (r *AccountSpendLimitsAvailableSpendLimit) UnmarshalJSON(data []byte) (err error)

type AccountSpendLimitsSpendLimit added in v0.28.0 

type AccountSpendLimitsSpendLimit struct {
	// The configured daily spend limit (in cents) on the Account.
	Daily int64 `json:"daily"`
	// The configured lifetime spend limit (in cents) on the Account.
	Lifetime int64 `json:"lifetime"`
	// The configured monthly spend limit (in cents) on the Account.
	Monthly int64                            `json:"monthly"`
	JSON    accountSpendLimitsSpendLimitJSON `json:"-"`
}

func (*AccountSpendLimitsSpendLimit) UnmarshalJSON added in v0.28.0 

func (r *AccountSpendLimitsSpendLimit) UnmarshalJSON(data []byte) (err error)

type AccountSpendLimitsSpendVelocity added in v0.28.0 

type AccountSpendLimitsSpendVelocity struct {
	// Current daily spend velocity (in cents) on the Account. Present if daily spend
	// limit is set.
	Daily int64 `json:"daily"`
	// Current lifetime spend velocity (in cents) on the Account. Present if lifetime
	// spend limit is set.
	Lifetime int64 `json:"lifetime"`
	// Current monthly spend velocity (in cents) on the Account. Present if monthly
	// spend limit is set.
	Monthly int64                               `json:"monthly"`
	JSON    accountSpendLimitsSpendVelocityJSON `json:"-"`
}

func (*AccountSpendLimitsSpendVelocity) UnmarshalJSON added in v0.28.0 

func (r *AccountSpendLimitsSpendVelocity) UnmarshalJSON(data []byte) (err error)

type AccountState 

type AccountState string

Account state:

  • `ACTIVE` - Account is able to transact and create new cards.
  • `PAUSED` - Account will not be able to transact or create new cards. It can be set back to `ACTIVE`.
  • `CLOSED` - Account will not be able to transact or create new cards. `CLOSED` accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states. `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for risk/compliance reasons. Please contact [support@lithic.com](mailto:support@lithic.com) if you believe this was in error.
const (
	AccountStateActive AccountState = "ACTIVE"
	AccountStatePaused AccountState = "PAUSED"
	AccountStateClosed AccountState = "CLOSED"
)

func (AccountState) IsKnown added in v0.27.0 

func (r AccountState) IsKnown() bool

type AccountUpdateParams 

type AccountUpdateParams struct {
	// Amount (in cents) for the account's daily spend limit. By default the daily
	// spend limit is set to $1,250.
	DailySpendLimit param.Field[int64] `json:"daily_spend_limit"`
	// Amount (in cents) for the account's lifetime spend limit. Once this limit is
	// reached, no transactions will be accepted on any card created for this account
	// until the limit is updated. Note that a spend limit of 0 is effectively no
	// limit, and should only be used to reset or remove a prior limit. Only a limit of
	// 1 or above will result in declined transactions due to checks against the
	// account limit. This behavior differs from the daily spend limit and the monthly
	// spend limit.
	LifetimeSpendLimit param.Field[int64] `json:"lifetime_spend_limit"`
	// Amount (in cents) for the account's monthly spend limit. By default the monthly
	// spend limit is set to $5,000.
	MonthlySpendLimit param.Field[int64] `json:"monthly_spend_limit"`
	// Account states.
	State param.Field[AccountUpdateParamsState] `json:"state"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules. This field is deprecated as AVS checks
	// are no longer supported by Authorization Rules. The field will be removed from
	// the schema in a future release.
	VerificationAddress param.Field[AccountUpdateParamsVerificationAddress] `json:"verification_address"`
}

func (AccountUpdateParams) MarshalJSON 

func (r AccountUpdateParams) MarshalJSON() (data []byte, err error)

type AccountUpdateParamsState 

type AccountUpdateParamsState string

Account states. 

const (
	AccountUpdateParamsStateActive AccountUpdateParamsState = "ACTIVE"
	AccountUpdateParamsStatePaused AccountUpdateParamsState = "PAUSED"
)

func (AccountUpdateParamsState) IsKnown added in v0.27.0 

func (r AccountUpdateParamsState) IsKnown() bool

type AccountUpdateParamsVerificationAddress 

type AccountUpdateParamsVerificationAddress struct {
	Address1   param.Field[string] `json:"address1"`
	Address2   param.Field[string] `json:"address2"`
	City       param.Field[string] `json:"city"`
	Country    param.Field[string] `json:"country"`
	PostalCode param.Field[string] `json:"postal_code"`
	State      param.Field[string] `json:"state"`
}

Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by Authorization Rules. The field will be removed from the schema in a future release.

func (AccountUpdateParamsVerificationAddress) MarshalJSON added in v0.3.1 

func (r AccountUpdateParamsVerificationAddress) MarshalJSON() (data []byte, err error)

type AccountVerificationAddress 

type AccountVerificationAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// City name.
	City string `json:"city,required"`
	// Country name. Only USA is currently supported.
	Country string `json:"country,required"`
	// Valid postal code. Only USA postal codes (ZIP codes) are currently supported,
	// entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the
	// format 12345-1234.
	PostalCode string `json:"postal_code,required"`
	// Valid state code. Only USA state codes are currently supported, entered in
	// uppercase ISO 3166-2 two-character format.
	State string `json:"state,required"`
	// Unit or apartment number (if applicable).
	Address2 string                         `json:"address2"`
	JSON     accountVerificationAddressJSON `json:"-"`
}

func (*AccountVerificationAddress) UnmarshalJSON 

func (r *AccountVerificationAddress) UnmarshalJSON(data []byte) (err error)

type Address added in v0.8.0 

type Address = shared.Address

This is an alias to an internal type.

type AddressParam 

type AddressParam = shared.AddressParam

This is an alias to an internal type.

type AggregateBalance 

type AggregateBalance struct {
	// Funds available for spend in the currency's smallest unit (e.g., cents for USD)
	AvailableAmount int64 `json:"available_amount,required"`
	// Date and time for when the balance was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the balance.
	Currency string `json:"currency,required"`
	// Type of financial account
	FinancialAccountType AggregateBalanceFinancialAccountType `json:"financial_account_type,required"`
	// Globally unique identifier for the financial account that had its balance
	// updated most recently
	LastFinancialAccountToken string `json:"last_financial_account_token,required" format:"uuid"`
	// Globally unique identifier for the last transaction event that impacted this
	// balance
	LastTransactionEventToken string `json:"last_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for the last transaction that impacted this balance
	LastTransactionToken string `json:"last_transaction_token,required" format:"uuid"`
	// Funds not available for spend due to card authorizations or pending ACH release.
	// Shown in the currency's smallest unit (e.g., cents for USD)
	PendingAmount int64 `json:"pending_amount,required"`
	// The sum of available and pending balance in the currency's smallest unit (e.g.,
	// cents for USD)
	TotalAmount int64 `json:"total_amount,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time            `json:"updated,required" format:"date-time"`
	JSON    aggregateBalanceJSON `json:"-"`
}

Aggregate Balance across all end-user accounts

func (*AggregateBalance) UnmarshalJSON 

func (r *AggregateBalance) UnmarshalJSON(data []byte) (err error)

type AggregateBalanceFinancialAccountType 

type AggregateBalanceFinancialAccountType string

Type of financial account 

const (
	AggregateBalanceFinancialAccountTypeIssuing   AggregateBalanceFinancialAccountType = "ISSUING"
	AggregateBalanceFinancialAccountTypeOperating AggregateBalanceFinancialAccountType = "OPERATING"
	AggregateBalanceFinancialAccountTypeReserve   AggregateBalanceFinancialAccountType = "RESERVE"
)

func (AggregateBalanceFinancialAccountType) IsKnown added in v0.27.0 

func (r AggregateBalanceFinancialAccountType) IsKnown() bool

type AggregateBalanceListParams 

type AggregateBalanceListParams struct {
	// Get the aggregate balance for a given Financial Account type.
	FinancialAccountType param.Field[AggregateBalanceListParamsFinancialAccountType] `query:"financial_account_type"`
}

func (AggregateBalanceListParams) URLQuery 

func (r AggregateBalanceListParams) URLQuery() (v url.Values)

URLQuery serializes AggregateBalanceListParams's query parameters as `url.Values`.

type AggregateBalanceListParamsFinancialAccountType 

type AggregateBalanceListParamsFinancialAccountType string

Get the aggregate balance for a given Financial Account type. 

const (
	AggregateBalanceListParamsFinancialAccountTypeIssuing   AggregateBalanceListParamsFinancialAccountType = "ISSUING"
	AggregateBalanceListParamsFinancialAccountTypeOperating AggregateBalanceListParamsFinancialAccountType = "OPERATING"
	AggregateBalanceListParamsFinancialAccountTypeReserve   AggregateBalanceListParamsFinancialAccountType = "RESERVE"
)

func (AggregateBalanceListParamsFinancialAccountType) IsKnown added in v0.27.0 

func (r AggregateBalanceListParamsFinancialAccountType) IsKnown() bool

type AggregateBalanceService 

type AggregateBalanceService struct {
	Options []option.RequestOption
}

AggregateBalanceService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAggregateBalanceService method instead.

func NewAggregateBalanceService 

func NewAggregateBalanceService(opts ...option.RequestOption) (r *AggregateBalanceService)

NewAggregateBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AggregateBalanceService) List 

func (r *AggregateBalanceService) List(ctx context.Context, query AggregateBalanceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AggregateBalance], err error)

Get the aggregated balance across all end-user accounts by financial account type

func (*AggregateBalanceService) ListAutoPaging 

func (r *AggregateBalanceService) ListAutoPaging(ctx context.Context, query AggregateBalanceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AggregateBalance]

Get the aggregated balance across all end-user accounts by financial account type

type AuthRuleService 

type AuthRuleService struct {
	Options []option.RequestOption
	V2      *AuthRuleV2Service
}

AuthRuleService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAuthRuleService method instead.

func NewAuthRuleService 

func NewAuthRuleService(opts ...option.RequestOption) (r *AuthRuleService)

NewAuthRuleService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AuthRuleV2ApplyParams added in v0.51.0 

type AuthRuleV2ApplyParams struct {
	Body AuthRuleV2ApplyParamsBodyUnion `json:"body,required"`
}

func (AuthRuleV2ApplyParams) MarshalJSON added in v0.51.0 

func (r AuthRuleV2ApplyParams) MarshalJSON() (data []byte, err error)

type AuthRuleV2ApplyParamsBody added in v0.51.0 

type AuthRuleV2ApplyParamsBody struct {
	AccountTokens param.Field[interface{}] `json:"account_tokens"`
	CardTokens    param.Field[interface{}] `json:"card_tokens"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level"`
}

func (AuthRuleV2ApplyParamsBody) MarshalJSON added in v0.51.0 

func (r AuthRuleV2ApplyParamsBody) MarshalJSON() (data []byte, err error)

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestAccountTokens added in v0.51.0 

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestAccountTokens struct {
	// Account tokens to which the Auth Rule applies.
	AccountTokens param.Field[[]string] `json:"account_tokens,required" format:"uuid"`
}

func (AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestAccountTokens) MarshalJSON added in v0.51.0 

func (r AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestAccountTokens) MarshalJSON() (data []byte, err error)

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestCardTokens added in v0.51.0 

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestCardTokens struct {
	// Card tokens to which the Auth Rule applies.
	CardTokens param.Field[[]string] `json:"card_tokens,required" format:"uuid"`
}

func (AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestCardTokens) MarshalJSON added in v0.51.0 

func (r AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestCardTokens) MarshalJSON() (data []byte, err error)

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestProgramLevel added in v0.51.0 

type AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestProgramLevel struct {
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level,required"`
}

func (AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestProgramLevel) MarshalJSON added in v0.51.0 

func (r AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestProgramLevel) MarshalJSON() (data []byte, err error)

type AuthRuleV2ApplyParamsBodyUnion added in v0.51.0 

type AuthRuleV2ApplyParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestAccountTokens, AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestCardTokens, AuthRuleV2ApplyParamsBodyApplyAuthRuleRequestProgramLevel, AuthRuleV2ApplyParamsBody.

type AuthRuleV2ApplyResponse added in v0.51.0 

type AuthRuleV2ApplyResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                              `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2ApplyResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2ApplyResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2ApplyResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2ApplyResponseType `json:"type,required"`
	JSON authRuleV2ApplyResponseJSON `json:"-"`
}

func (*AuthRuleV2ApplyResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseCurrentVersion added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2ApplyResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                     `json:"version,required"`
	JSON    authRuleV2ApplyResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2ApplyResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                          `json:"period"`
	Scope  AuthRuleV2ApplyResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2ApplyResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2ApplyResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParameters) AsUnion() AuthRuleV2ApplyResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2ApplyResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2ApplyResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ApplyResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ApplyResponseCurrentVersionParameters()

func (*AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2ApplyResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersScope string
const (
	AuthRuleV2ApplyResponseCurrentVersionParametersScopeCard    AuthRuleV2ApplyResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2ApplyResponseCurrentVersionParametersScopeAccount AuthRuleV2ApplyResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2ApplyResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2ApplyResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2ApplyResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2ApplyResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2ApplyResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2ApplyResponseDraftVersion added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2ApplyResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                   `json:"version,required"`
	JSON    authRuleV2ApplyResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2ApplyResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                        `json:"period"`
	Scope  AuthRuleV2ApplyResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2ApplyResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2ApplyResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParameters) AsUnion() AuthRuleV2ApplyResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2ApplyResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2ApplyResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ApplyResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ApplyResponseDraftVersionParameters()

func (*AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2ApplyResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersScope string
const (
	AuthRuleV2ApplyResponseDraftVersionParametersScopeCard    AuthRuleV2ApplyResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2ApplyResponseDraftVersionParametersScopeAccount AuthRuleV2ApplyResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2ApplyResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2ApplyResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2ApplyResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2ApplyResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2ApplyResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2ApplyResponseState added in v0.51.0 

type AuthRuleV2ApplyResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2ApplyResponseStateActive   AuthRuleV2ApplyResponseState = "ACTIVE"
	AuthRuleV2ApplyResponseStateInactive AuthRuleV2ApplyResponseState = "INACTIVE"
)

func (AuthRuleV2ApplyResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseState) IsKnown() bool

type AuthRuleV2ApplyResponseType added in v0.51.0 

type AuthRuleV2ApplyResponseType string

The type of Auth Rule 

const (
	AuthRuleV2ApplyResponseTypeConditionalBlock AuthRuleV2ApplyResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2ApplyResponseTypeVelocityLimit    AuthRuleV2ApplyResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2ApplyResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2ApplyResponseType) IsKnown() bool

type AuthRuleV2DraftParams added in v0.51.0 

type AuthRuleV2DraftParams struct {
	// Parameters for the current version of the Auth Rule
	Parameters param.Field[AuthRuleV2DraftParamsParametersUnion] `json:"parameters"`
}

func (AuthRuleV2DraftParams) MarshalJSON added in v0.51.0 

func (r AuthRuleV2DraftParams) MarshalJSON() (data []byte, err error)

type AuthRuleV2DraftParamsParameters added in v0.51.0 

type AuthRuleV2DraftParamsParameters struct {
	Conditions param.Field[interface{}] `json:"conditions"`
	Filters    param.Field[interface{}] `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount param.Field[float64] `json:"limit_amount"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount param.Field[float64]                              `json:"limit_count"`
	Period     param.Field[interface{}]                          `json:"period"`
	Scope      param.Field[AuthRuleV2DraftParamsParametersScope] `json:"scope"`
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2DraftParamsParameters) ImplementsAuthRuleV2DraftParamsParametersUnion added in v0.51.0 

func (r AuthRuleV2DraftParamsParameters) ImplementsAuthRuleV2DraftParamsParametersUnion()

func (AuthRuleV2DraftParamsParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2DraftParamsParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2DraftParamsParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParameters struct {
	Conditions param.Field[[]AuthRuleV2DraftParamsParametersConditionalBlockParametersCondition] `json:"conditions,required"`
}

func (AuthRuleV2DraftParamsParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftParamsParametersUnion added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftParamsParametersUnion()

func (AuthRuleV2DraftParamsParametersConditionalBlockParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2DraftParamsParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute param.Field[AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute] `json:"attribute"`
	// The operation to apply to the attribute
	Operation param.Field[AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation] `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value param.Field[AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion] `json:"value"`
}

func (AuthRuleV2DraftParamsParametersConditionalBlockParametersCondition) MarshalJSON added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParametersCondition) MarshalJSON() (data []byte, err error)

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Satisfied by shared.UnionString, shared.UnionFloat, AuthRuleV2DraftParamsParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2DraftParamsParametersScope added in v0.51.0 

type AuthRuleV2DraftParamsParametersScope string
const (
	AuthRuleV2DraftParamsParametersScopeCard    AuthRuleV2DraftParamsParametersScope = "CARD"
	AuthRuleV2DraftParamsParametersScopeAccount AuthRuleV2DraftParamsParametersScope = "ACCOUNT"
)

func (AuthRuleV2DraftParamsParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftParamsParametersScope) IsKnown() bool

type AuthRuleV2DraftParamsParametersUnion added in v0.51.0 

type AuthRuleV2DraftParamsParametersUnion interface {
	ImplementsAuthRuleV2DraftParamsParametersUnion()
}

Parameters for the current version of the Auth Rule

Satisfied by AuthRuleV2DraftParamsParametersConditionalBlockParameters, shared.VelocityLimitParams, AuthRuleV2DraftParamsParameters.

type AuthRuleV2DraftResponse added in v0.51.0 

type AuthRuleV2DraftResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                              `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2DraftResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2DraftResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2DraftResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2DraftResponseType `json:"type,required"`
	JSON authRuleV2DraftResponseJSON `json:"-"`
}

func (*AuthRuleV2DraftResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseCurrentVersion added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2DraftResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                     `json:"version,required"`
	JSON    authRuleV2DraftResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2DraftResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                          `json:"period"`
	Scope  AuthRuleV2DraftResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2DraftResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2DraftResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParameters) AsUnion() AuthRuleV2DraftResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2DraftResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2DraftResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftResponseCurrentVersionParameters()

func (*AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2DraftResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersScope string
const (
	AuthRuleV2DraftResponseCurrentVersionParametersScopeCard    AuthRuleV2DraftResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2DraftResponseCurrentVersionParametersScopeAccount AuthRuleV2DraftResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2DraftResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2DraftResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2DraftResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2DraftResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2DraftResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2DraftResponseDraftVersion added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2DraftResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                   `json:"version,required"`
	JSON    authRuleV2DraftResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2DraftResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                        `json:"period"`
	Scope  AuthRuleV2DraftResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2DraftResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2DraftResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParameters) AsUnion() AuthRuleV2DraftResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2DraftResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2DraftResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2DraftResponseDraftVersionParameters()

func (*AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2DraftResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersScope string
const (
	AuthRuleV2DraftResponseDraftVersionParametersScopeCard    AuthRuleV2DraftResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2DraftResponseDraftVersionParametersScopeAccount AuthRuleV2DraftResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2DraftResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2DraftResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2DraftResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2DraftResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2DraftResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2DraftResponseState added in v0.51.0 

type AuthRuleV2DraftResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2DraftResponseStateActive   AuthRuleV2DraftResponseState = "ACTIVE"
	AuthRuleV2DraftResponseStateInactive AuthRuleV2DraftResponseState = "INACTIVE"
)

func (AuthRuleV2DraftResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseState) IsKnown() bool

type AuthRuleV2DraftResponseType added in v0.51.0 

type AuthRuleV2DraftResponseType string

The type of Auth Rule 

const (
	AuthRuleV2DraftResponseTypeConditionalBlock AuthRuleV2DraftResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2DraftResponseTypeVelocityLimit    AuthRuleV2DraftResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2DraftResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2DraftResponseType) IsKnown() bool

type AuthRuleV2GetResponse added in v0.51.0 

type AuthRuleV2GetResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                            `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2GetResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2GetResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2GetResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2GetResponseType `json:"type,required"`
	JSON authRuleV2GetResponseJSON `json:"-"`
}

func (*AuthRuleV2GetResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseCurrentVersion added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2GetResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                   `json:"version,required"`
	JSON    authRuleV2GetResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2GetResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                        `json:"period"`
	Scope  AuthRuleV2GetResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2GetResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2GetResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParameters) AsUnion() AuthRuleV2GetResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2GetResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2GetResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2GetResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2GetResponseCurrentVersionParameters()

func (*AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2GetResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersScope string
const (
	AuthRuleV2GetResponseCurrentVersionParametersScopeCard    AuthRuleV2GetResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2GetResponseCurrentVersionParametersScopeAccount AuthRuleV2GetResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2GetResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2GetResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2GetResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2GetResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2GetResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2GetResponseDraftVersion added in v0.51.0 

type AuthRuleV2GetResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2GetResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                 `json:"version,required"`
	JSON    authRuleV2GetResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2GetResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                      `json:"period"`
	Scope  AuthRuleV2GetResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2GetResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2GetResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParameters) AsUnion() AuthRuleV2GetResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2GetResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2GetResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2GetResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2GetResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2GetResponseDraftVersionParameters()

func (*AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2GetResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersScope string
const (
	AuthRuleV2GetResponseDraftVersionParametersScopeCard    AuthRuleV2GetResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2GetResponseDraftVersionParametersScopeAccount AuthRuleV2GetResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2GetResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2GetResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2GetResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2GetResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2GetResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2GetResponseState added in v0.51.0 

type AuthRuleV2GetResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2GetResponseStateActive   AuthRuleV2GetResponseState = "ACTIVE"
	AuthRuleV2GetResponseStateInactive AuthRuleV2GetResponseState = "INACTIVE"
)

func (AuthRuleV2GetResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseState) IsKnown() bool

type AuthRuleV2GetResponseType added in v0.51.0 

type AuthRuleV2GetResponseType string

The type of Auth Rule 

const (
	AuthRuleV2GetResponseTypeConditionalBlock AuthRuleV2GetResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2GetResponseTypeVelocityLimit    AuthRuleV2GetResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2GetResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2GetResponseType) IsKnown() bool

type AuthRuleV2ListParams added in v0.51.0 

type AuthRuleV2ListParams struct {
	// Only return Authorization Rules that are bound to the provided account token.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Only return Authorization Rules that are bound to the provided card token.
	CardToken param.Field[string] `query:"card_token" format:"uuid"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (AuthRuleV2ListParams) URLQuery added in v0.51.0 

func (r AuthRuleV2ListParams) URLQuery() (v url.Values)

URLQuery serializes AuthRuleV2ListParams's query parameters as `url.Values`.

type AuthRuleV2ListResponse added in v0.51.0 

type AuthRuleV2ListResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                             `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2ListResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2ListResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2ListResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2ListResponseType `json:"type,required"`
	JSON authRuleV2ListResponseJSON `json:"-"`
}

func (*AuthRuleV2ListResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseCurrentVersion added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2ListResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                    `json:"version,required"`
	JSON    authRuleV2ListResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2ListResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                         `json:"period"`
	Scope  AuthRuleV2ListResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2ListResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2ListResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParameters) AsUnion() AuthRuleV2ListResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2ListResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2ListResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ListResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ListResponseCurrentVersionParameters()

func (*AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2ListResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersScope string
const (
	AuthRuleV2ListResponseCurrentVersionParametersScopeCard    AuthRuleV2ListResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2ListResponseCurrentVersionParametersScopeAccount AuthRuleV2ListResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2ListResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2ListResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2ListResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2ListResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2ListResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2ListResponseDraftVersion added in v0.51.0 

type AuthRuleV2ListResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2ListResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                  `json:"version,required"`
	JSON    authRuleV2ListResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2ListResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                       `json:"period"`
	Scope  AuthRuleV2ListResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2ListResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2ListResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParameters) AsUnion() AuthRuleV2ListResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2ListResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2ListResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2ListResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ListResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2ListResponseDraftVersionParameters()

func (*AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2ListResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersScope string
const (
	AuthRuleV2ListResponseDraftVersionParametersScopeCard    AuthRuleV2ListResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2ListResponseDraftVersionParametersScopeAccount AuthRuleV2ListResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2ListResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2ListResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2ListResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2ListResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2ListResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2ListResponseState added in v0.51.0 

type AuthRuleV2ListResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2ListResponseStateActive   AuthRuleV2ListResponseState = "ACTIVE"
	AuthRuleV2ListResponseStateInactive AuthRuleV2ListResponseState = "INACTIVE"
)

func (AuthRuleV2ListResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseState) IsKnown() bool

type AuthRuleV2ListResponseType added in v0.51.0 

type AuthRuleV2ListResponseType string

The type of Auth Rule 

const (
	AuthRuleV2ListResponseTypeConditionalBlock AuthRuleV2ListResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2ListResponseTypeVelocityLimit    AuthRuleV2ListResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2ListResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2ListResponseType) IsKnown() bool

type AuthRuleV2NewParams added in v0.51.0 

type AuthRuleV2NewParams struct {
	Body AuthRuleV2NewParamsBodyUnion `json:"body,required"`
}

func (AuthRuleV2NewParams) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParams) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBody added in v0.51.0 

type AuthRuleV2NewParamsBody struct {
	AccountTokens param.Field[interface{}] `json:"account_tokens"`
	CardTokens    param.Field[interface{}] `json:"card_tokens"`
	Parameters    param.Field[interface{}] `json:"parameters"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level"`
	// The type of Auth Rule
	Type param.Field[AuthRuleV2NewParamsBodyType] `json:"type"`
}

func (AuthRuleV2NewParamsBody) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBody) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokens added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokens struct {
	// Account tokens to which the Auth Rule applies.
	AccountTokens param.Field[[]string] `json:"account_tokens,required" format:"uuid"`
	// Parameters for the current version of the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion] `json:"parameters"`
	// The type of Auth Rule
	Type param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType] `json:"type"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokens) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokens) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters struct {
	Conditions param.Field[interface{}] `json:"conditions"`
	Filters    param.Field[interface{}] `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount param.Field[float64] `json:"limit_amount"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount param.Field[float64]                                                                  `json:"limit_count"`
	Period     param.Field[interface{}]                                                              `json:"period"`
	Scope      param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope] `json:"scope"`
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters struct {
	Conditions param.Field[[]AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersCondition] `json:"conditions,required"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute] `json:"attribute"`
	// The operation to apply to the attribute
	Operation param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation] `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion] `json:"value"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersCondition) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersCondition) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Satisfied by shared.UnionString, shared.UnionFloat, AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope string
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScopeCard    AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope = "CARD"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScopeAccount AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersUnion()
}

Parameters for the current version of the Auth Rule

Satisfied by AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParametersConditionalBlockParameters, shared.VelocityLimitParams, AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensParameters.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType string

The type of Auth Rule 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensTypeConditionalBlock AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensTypeVelocityLimit    AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType = "VELOCITY_LIMIT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokensType) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokens added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokens struct {
	// Card tokens to which the Auth Rule applies.
	CardTokens param.Field[[]string] `json:"card_tokens,required" format:"uuid"`
	// Parameters for the current version of the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion] `json:"parameters"`
	// The type of Auth Rule
	Type param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType] `json:"type"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokens) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokens) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters struct {
	Conditions param.Field[interface{}] `json:"conditions"`
	Filters    param.Field[interface{}] `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount param.Field[float64] `json:"limit_amount"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount param.Field[float64]                                                               `json:"limit_count"`
	Period     param.Field[interface{}]                                                           `json:"period"`
	Scope      param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope] `json:"scope"`
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters struct {
	Conditions param.Field[[]AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersCondition] `json:"conditions,required"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute] `json:"attribute"`
	// The operation to apply to the attribute
	Operation param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation] `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion] `json:"value"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersCondition) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersCondition) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Satisfied by shared.UnionString, shared.UnionFloat, AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope string
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScopeCard    AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope = "CARD"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScopeAccount AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersUnion()
}

Parameters for the current version of the Auth Rule

Satisfied by AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParametersConditionalBlockParameters, shared.VelocityLimitParams, AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensParameters.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType string

The type of Auth Rule 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensTypeConditionalBlock AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensTypeVelocityLimit    AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType = "VELOCITY_LIMIT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokensType) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevel added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevel struct {
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level,required"`
	// Parameters for the current version of the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion] `json:"parameters"`
	// The type of Auth Rule
	Type param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType] `json:"type"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevel) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevel) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters struct {
	Conditions param.Field[interface{}] `json:"conditions"`
	Filters    param.Field[interface{}] `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount param.Field[float64] `json:"limit_amount"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount param.Field[float64]                                                                 `json:"limit_count"`
	Period     param.Field[interface{}]                                                             `json:"period"`
	Scope      param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope] `json:"scope"`
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters struct {
	Conditions param.Field[[]AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersCondition] `json:"conditions,required"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion()

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute] `json:"attribute"`
	// The operation to apply to the attribute
	Operation param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation] `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value param.Field[AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion] `json:"value"`
}

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersCondition) MarshalJSON added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersCondition) MarshalJSON() (data []byte, err error)

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Satisfied by shared.UnionString, shared.UnionFloat, AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope string
const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScopeCard    AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope = "CARD"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScopeAccount AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion interface {
	ImplementsAuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersUnion()
}

Parameters for the current version of the Auth Rule

Satisfied by AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParametersConditionalBlockParameters, shared.VelocityLimitParams, AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelParameters.

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType added in v0.51.0 

type AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType string

The type of Auth Rule 

const (
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelTypeConditionalBlock AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelTypeVelocityLimit    AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType = "VELOCITY_LIMIT"
)

func (AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevelType) IsKnown() bool

type AuthRuleV2NewParamsBodyType added in v0.51.0 

type AuthRuleV2NewParamsBodyType string

The type of Auth Rule 

const (
	AuthRuleV2NewParamsBodyTypeConditionalBlock AuthRuleV2NewParamsBodyType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyTypeVelocityLimit    AuthRuleV2NewParamsBodyType = "VELOCITY_LIMIT"
)

func (AuthRuleV2NewParamsBodyType) IsKnown added in v0.51.0 

func (r AuthRuleV2NewParamsBodyType) IsKnown() bool

type AuthRuleV2NewParamsBodyUnion added in v0.51.0 

type AuthRuleV2NewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by AuthRuleV2NewParamsBodyCreateAuthRuleRequestAccountTokens, AuthRuleV2NewParamsBodyCreateAuthRuleRequestCardTokens, AuthRuleV2NewParamsBodyCreateAuthRuleRequestProgramLevel, AuthRuleV2NewParamsBody.

type AuthRuleV2NewResponse added in v0.51.0 

type AuthRuleV2NewResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                            `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2NewResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2NewResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2NewResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2NewResponseType `json:"type,required"`
	JSON authRuleV2NewResponseJSON `json:"-"`
}

func (*AuthRuleV2NewResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseCurrentVersion added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2NewResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                   `json:"version,required"`
	JSON    authRuleV2NewResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2NewResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                        `json:"period"`
	Scope  AuthRuleV2NewResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2NewResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2NewResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParameters) AsUnion() AuthRuleV2NewResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2NewResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2NewResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2NewResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2NewResponseCurrentVersionParameters()

func (*AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2NewResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersScope string
const (
	AuthRuleV2NewResponseCurrentVersionParametersScopeCard    AuthRuleV2NewResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2NewResponseCurrentVersionParametersScopeAccount AuthRuleV2NewResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2NewResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2NewResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2NewResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2NewResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2NewResponseDraftVersion added in v0.51.0 

type AuthRuleV2NewResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2NewResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                 `json:"version,required"`
	JSON    authRuleV2NewResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2NewResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                      `json:"period"`
	Scope  AuthRuleV2NewResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2NewResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2NewResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParameters) AsUnion() AuthRuleV2NewResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2NewResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2NewResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2NewResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2NewResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2NewResponseDraftVersionParameters()

func (*AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2NewResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersScope string
const (
	AuthRuleV2NewResponseDraftVersionParametersScopeCard    AuthRuleV2NewResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2NewResponseDraftVersionParametersScopeAccount AuthRuleV2NewResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2NewResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2NewResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2NewResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2NewResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2NewResponseState added in v0.51.0 

type AuthRuleV2NewResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2NewResponseStateActive   AuthRuleV2NewResponseState = "ACTIVE"
	AuthRuleV2NewResponseStateInactive AuthRuleV2NewResponseState = "INACTIVE"
)

func (AuthRuleV2NewResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseState) IsKnown() bool

type AuthRuleV2NewResponseType added in v0.51.0 

type AuthRuleV2NewResponseType string

The type of Auth Rule 

const (
	AuthRuleV2NewResponseTypeConditionalBlock AuthRuleV2NewResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewResponseTypeVelocityLimit    AuthRuleV2NewResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2NewResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2NewResponseType) IsKnown() bool

type AuthRuleV2PromoteResponse added in v0.51.0 

type AuthRuleV2PromoteResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                                `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2PromoteResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2PromoteResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2PromoteResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2PromoteResponseType `json:"type,required"`
	JSON authRuleV2PromoteResponseJSON `json:"-"`
}

func (*AuthRuleV2PromoteResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseCurrentVersion added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2PromoteResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                       `json:"version,required"`
	JSON    authRuleV2PromoteResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2PromoteResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                            `json:"period"`
	Scope  AuthRuleV2PromoteResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2PromoteResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2PromoteResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParameters) AsUnion() AuthRuleV2PromoteResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2PromoteResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2PromoteResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2PromoteResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2PromoteResponseCurrentVersionParameters()

func (*AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2PromoteResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersScope string
const (
	AuthRuleV2PromoteResponseCurrentVersionParametersScopeCard    AuthRuleV2PromoteResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2PromoteResponseCurrentVersionParametersScopeAccount AuthRuleV2PromoteResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2PromoteResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2PromoteResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2PromoteResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2PromoteResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2PromoteResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2PromoteResponseDraftVersion added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2PromoteResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                     `json:"version,required"`
	JSON    authRuleV2PromoteResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2PromoteResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                          `json:"period"`
	Scope  AuthRuleV2PromoteResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2PromoteResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2PromoteResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParameters) AsUnion() AuthRuleV2PromoteResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2PromoteResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2PromoteResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2PromoteResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2PromoteResponseDraftVersionParameters()

func (*AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2PromoteResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersScope string
const (
	AuthRuleV2PromoteResponseDraftVersionParametersScopeCard    AuthRuleV2PromoteResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2PromoteResponseDraftVersionParametersScopeAccount AuthRuleV2PromoteResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2PromoteResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2PromoteResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2PromoteResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2PromoteResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2PromoteResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2PromoteResponseState added in v0.51.0 

type AuthRuleV2PromoteResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2PromoteResponseStateActive   AuthRuleV2PromoteResponseState = "ACTIVE"
	AuthRuleV2PromoteResponseStateInactive AuthRuleV2PromoteResponseState = "INACTIVE"
)

func (AuthRuleV2PromoteResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseState) IsKnown() bool

type AuthRuleV2PromoteResponseType added in v0.51.0 

type AuthRuleV2PromoteResponseType string

The type of Auth Rule 

const (
	AuthRuleV2PromoteResponseTypeConditionalBlock AuthRuleV2PromoteResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2PromoteResponseTypeVelocityLimit    AuthRuleV2PromoteResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2PromoteResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2PromoteResponseType) IsKnown() bool

type AuthRuleV2ReportResponse added in v0.51.0 

type AuthRuleV2ReportResponse struct {
	ReportToken string                       `json:"report_token" format:"uuid"`
	JSON        authRuleV2ReportResponseJSON `json:"-"`
}

func (*AuthRuleV2ReportResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2ReportResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2Service added in v0.51.0 

type AuthRuleV2Service struct {
	Options []option.RequestOption
}

AuthRuleV2Service contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAuthRuleV2Service method instead.

func NewAuthRuleV2Service added in v0.51.0 

func NewAuthRuleV2Service(opts ...option.RequestOption) (r *AuthRuleV2Service)

NewAuthRuleV2Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AuthRuleV2Service) Apply added in v0.51.0 

func (r *AuthRuleV2Service) Apply(ctx context.Context, authRuleToken string, body AuthRuleV2ApplyParams, opts ...option.RequestOption) (res *AuthRuleV2ApplyResponse, err error)

Associates an authorization rules with a card program, the provided account(s) or card(s).

This endpoint will replace any existing associations with the provided list of entities.

func (*AuthRuleV2Service) Draft added in v0.51.0 

func (r *AuthRuleV2Service) Draft(ctx context.Context, authRuleToken string, body AuthRuleV2DraftParams, opts ...option.RequestOption) (res *AuthRuleV2DraftResponse, err error)

Creates a new draft version of an authorization rules that will be ran in shadow mode.

This can also be utilized to reset the draft parameters, causing a draft version to no longer be ran in shadow mode.

func (*AuthRuleV2Service) Get added in v0.51.0 

func (r *AuthRuleV2Service) Get(ctx context.Context, authRuleToken string, opts ...option.RequestOption) (res *AuthRuleV2GetResponse, err error)

Fetches an authorization rule by its token

func (*AuthRuleV2Service) List added in v0.51.0 

func (r *AuthRuleV2Service) List(ctx context.Context, query AuthRuleV2ListParams, opts ...option.RequestOption) (res *pagination.CursorPage[AuthRuleV2ListResponse], err error)

Lists V2 authorization rules

func (*AuthRuleV2Service) ListAutoPaging added in v0.51.0 

func (r *AuthRuleV2Service) ListAutoPaging(ctx context.Context, query AuthRuleV2ListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[AuthRuleV2ListResponse]

Lists V2 authorization rules

func (*AuthRuleV2Service) New added in v0.51.0 

func (r *AuthRuleV2Service) New(ctx context.Context, body AuthRuleV2NewParams, opts ...option.RequestOption) (res *AuthRuleV2NewResponse, err error)

Creates a new V2 authorization rule in draft mode

func (*AuthRuleV2Service) Promote added in v0.51.0 

func (r *AuthRuleV2Service) Promote(ctx context.Context, authRuleToken string, opts ...option.RequestOption) (res *AuthRuleV2PromoteResponse, err error)

Promotes a draft version of an authorization rule to the currently active version such that it is enforced in the authorization stream.

func (*AuthRuleV2Service) Report added in v0.51.0 

func (r *AuthRuleV2Service) Report(ctx context.Context, authRuleToken string, opts ...option.RequestOption) (res *AuthRuleV2ReportResponse, err error)

Requests a performance report of an authorization rule to be asynchronously generated. Reports can only be run on rules in draft or active mode and will included approved and declined statistics as well as examples. The generated report will be delivered asynchronously through a webhook with `event_type` = `auth_rules.performance_report.created`. See the docs on setting up [webhook subscriptions](https://docs.lithic.com/docs/events-api).

Reports are generated based on data collected by Lithic's authorization processing system in the trailing week. The performance of the auth rule will be assessed on the configuration of the auth rule at the time the report is requested. This implies that if a performance report is requested, right after updating an auth rule, depending on the number of authorizations processed for a card program, it may be the case that no data is available for the report. Therefore Lithic recommends to decouple making updates to an Auth Rule, and requesting performance reports.

To make this concrete, consider the following example:

  1. At time `t`, a new Auth Rule is created, and applies to all authorizations on a card program. The Auth Rule has not yet been promoted, causing the draft version of the rule to be applied in shadow mode.
  2. At time `t + 1 hour` a performance report is requested for the Auth Rule. This performance report will _only_ contain data for the Auth Rule being executed in the window between `t` and `t + 1 hour`. This is because Lithic's transaction processing system will only start capturing data for the Auth Rule at the time it is created.
  3. At time `t + 2 hours` the draft version of the Auth Rule is promoted to the active version of the Auth Rule by calling the `/v2/auth_rules/{auth_rule_token}/promote` endpoint. If a performance report is requested at this moment it will still only contain data for this version of the rule, but the window of available data will now span from `t` to `t + 2 hours`.
  4. At time `t + 3 hours` a new version of the rule is drafted by calling the `/v2/auth_rules/{auth_rule_token}/draft` endpoint. If a performance report is requested right at this moment, it will only contain data for authorizations to which both the active version and the draft version is applied. Lithic does this to ensure that performance reports represent a fair comparison between rules. Because there may be no authorizations in this window, and because there may be some lag before data is available in a performance report, the requested performance report could contain no to little data.
  5. At time `t + 4 hours` another performance report is requested: this time the performance report will contain data from the window between `t + 3 hours` and `t + 4 hours`, for any authorizations to which both the current version of the authorization rule (in enforcing mode) and the draft version of the authorization rule (in shadow mode) applied.

Note that generating a report may take up to 15 minutes and that delivery is not guaranteed. Customers are required to have created an event subscription to receive the webhook. Additionally, there is a delay of approximately 15 minutes between when Lithic's transaction processing systems have processed the transaction, and when a transaction will be included in the report.

func (*AuthRuleV2Service) Update added in v0.51.0 

func (r *AuthRuleV2Service) Update(ctx context.Context, authRuleToken string, body AuthRuleV2UpdateParams, opts ...option.RequestOption) (res *AuthRuleV2UpdateResponse, err error)

Updates an authorization rule's properties

type AuthRuleV2UpdateParams added in v0.51.0 

type AuthRuleV2UpdateParams struct {
	// The desired state of the Auth Rule.
	//
	// Note that only deactivating an Auth Rule through this endpoint is supported at
	// this time. If you need to (re-)activate an Auth Rule the /promote endpoint
	// should be used to promote a draft to the currently active version.
	State param.Field[AuthRuleV2UpdateParamsState] `json:"state"`
}

func (AuthRuleV2UpdateParams) MarshalJSON added in v0.51.0 

func (r AuthRuleV2UpdateParams) MarshalJSON() (data []byte, err error)

type AuthRuleV2UpdateParamsState added in v0.51.0 

type AuthRuleV2UpdateParamsState string

The desired state of the Auth Rule.

Note that only deactivating an Auth Rule through this endpoint is supported at this time. If you need to (re-)activate an Auth Rule the /promote endpoint should be used to promote a draft to the currently active version. 

const (
	AuthRuleV2UpdateParamsStateInactive AuthRuleV2UpdateParamsState = "INACTIVE"
)

func (AuthRuleV2UpdateParamsState) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateParamsState) IsKnown() bool

type AuthRuleV2UpdateResponse added in v0.51.0 

type AuthRuleV2UpdateResponse struct {
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string                               `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleV2UpdateResponseCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleV2UpdateResponseDraftVersion   `json:"draft_version,required,nullable"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel bool `json:"program_level,required"`
	// The state of the Auth Rule
	State AuthRuleV2UpdateResponseState `json:"state,required"`
	// The type of Auth Rule
	Type AuthRuleV2UpdateResponseType `json:"type,required"`
	JSON authRuleV2UpdateResponseJSON `json:"-"`
}

func (*AuthRuleV2UpdateResponse) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponse) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseCurrentVersion added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2UpdateResponseCurrentVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                      `json:"version,required"`
	JSON    authRuleV2UpdateResponseCurrentVersionJSON `json:"-"`
}

func (*AuthRuleV2UpdateResponseCurrentVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseCurrentVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseCurrentVersionParameters added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                           `json:"period"`
	Scope  AuthRuleV2UpdateResponseCurrentVersionParametersScope `json:"scope"`
	JSON   authRuleV2UpdateResponseCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2UpdateResponseCurrentVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParameters) AsUnion() AuthRuleV2UpdateResponseCurrentVersionParametersUnion

AsUnion returns a AuthRuleV2UpdateResponseCurrentVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2UpdateResponseCurrentVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseCurrentVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2UpdateResponseCurrentVersionParameters added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2UpdateResponseCurrentVersionParameters()

func (*AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2UpdateResponseCurrentVersionParametersScope added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersScope string
const (
	AuthRuleV2UpdateResponseCurrentVersionParametersScopeCard    AuthRuleV2UpdateResponseCurrentVersionParametersScope = "CARD"
	AuthRuleV2UpdateResponseCurrentVersionParametersScopeAccount AuthRuleV2UpdateResponseCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2UpdateResponseCurrentVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseCurrentVersionParametersScope) IsKnown() bool

type AuthRuleV2UpdateResponseCurrentVersionParametersUnion added in v0.51.0 

type AuthRuleV2UpdateResponseCurrentVersionParametersUnion interface {
	ImplementsAuthRuleV2UpdateResponseCurrentVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2UpdateResponseCurrentVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2UpdateResponseDraftVersion added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersion struct {
	// Parameters for the current version of the Auth Rule
	Parameters AuthRuleV2UpdateResponseDraftVersionParameters `json:"parameters,required"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64                                    `json:"version,required"`
	JSON    authRuleV2UpdateResponseDraftVersionJSON `json:"-"`
}

func (*AuthRuleV2UpdateResponseDraftVersion) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseDraftVersion) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseDraftVersionParameters added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParameters struct {
	// This field can have the runtime type of
	// [[]AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [shared.VelocityLimitParamsFilters].
	Filters interface{} `json:"filters"`
	// The maximum amount of spend velocity allowed in the period in minor units (the
	// smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
	// limit will be declined.
	LimitAmount float64 `json:"limit_amount,nullable"`
	// The number of spend velocity impacting transactions may not exceed this limit in
	// the period. Transactions exceeding this limit will be declined. A spend velocity
	// impacting transaction is a transaction that has been authorized, and optionally
	// settled, or a force post (a transaction that settled without prior
	// authorization).
	LimitCount float64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [shared.VelocityLimitParamsPeriodUnion].
	Period interface{}                                         `json:"period"`
	Scope  AuthRuleV2UpdateResponseDraftVersionParametersScope `json:"scope"`
	JSON   authRuleV2UpdateResponseDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the current version of the Auth Rule

func (AuthRuleV2UpdateResponseDraftVersionParameters) AsUnion added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParameters) AsUnion() AuthRuleV2UpdateResponseDraftVersionParametersUnion

AsUnion returns a AuthRuleV2UpdateResponseDraftVersionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters, shared.VelocityLimitParams.

func (*AuthRuleV2UpdateResponseDraftVersionParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseDraftVersionParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters struct {
	Conditions []AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition `json:"conditions,required"`
	JSON       authRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersJSON        `json:"-"`
}

func (AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2UpdateResponseDraftVersionParameters added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters) ImplementsAuthRuleV2UpdateResponseDraftVersionParameters()

func (*AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
	//     business by the types of goods or services it provides.
	//   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
	//     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
	//     Netherlands Antilles.
	//   - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
	//     transaction.
	//   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
	//     (merchant).
	//   - `DESCRIPTOR`: Short description of card acceptor.
	//   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
	//     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
	//     `TOKEN_AUTHENTICATED`.
	//   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
	//     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
	//     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
	//     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
	//     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
	//   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
	//     fee field in the settlement/cardholder billing currency. This is the amount
	//     the issuer should authorize against unless the issuer is paying the acquirer
	//     fee on behalf of the cardholder.
	//   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
	//     given authorization. Scores are on a range of 0-999, with 0 representing the
	//     lowest risk and 999 representing the highest risk. For Visa transactions,
	//     where the raw score has a range of 0-99, Lithic will normalize the score by
	//     multiplying the raw score by 10x.
	Attribute AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute `json:"attribute"`
	// The operation to apply to the attribute
	Operation AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation `json:"operation"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion `json:"value"`
	JSON  authRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionJSON        `json:"-"`
}

func (*AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON added in v0.51.0 

func (r *AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersCondition) UnmarshalJSON(data []byte) (err error)

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
  • `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
  • `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
  • `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
  • `DESCRIPTOR`: Short description of card acceptor.
  • `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
  • `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
  • `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.
  • `RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
const (
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMcc               AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MCC"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCountry           AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "COUNTRY"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeCurrency          AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "CURRENCY"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeMerchantID        AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "MERCHANT_ID"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeDescriptor        AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "DESCRIPTOR"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeLiabilityShift    AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "LIABILITY_SHIFT"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributePanEntryMode      AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "PAN_ENTRY_MODE"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeTransactionAmount AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttributeRiskScore         AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute = "RISK_SCORE"
)

func (AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsAttribute) IsKnown() bool

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation string

The operation to apply to the attribute 

const (
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsOneOf       AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_ONE_OF"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsNotOneOf    AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_NOT_ONE_OF"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationMatches       AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "MATCHES"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationDoesNotMatch  AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "DOES_NOT_MATCH"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsGreaterThan AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_GREATER_THAN"
	AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperationIsLessThan    AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation = "IS_LESS_THAN"
)

func (AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsOperation) IsKnown() bool

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray []string

func (AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray) ImplementsAuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion interface {
	ImplementsAuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueUnion()
}

A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`

Union satisfied by shared.UnionString, shared.UnionFloat or AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParametersConditionsValueArray.

type AuthRuleV2UpdateResponseDraftVersionParametersScope added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersScope string
const (
	AuthRuleV2UpdateResponseDraftVersionParametersScopeCard    AuthRuleV2UpdateResponseDraftVersionParametersScope = "CARD"
	AuthRuleV2UpdateResponseDraftVersionParametersScopeAccount AuthRuleV2UpdateResponseDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleV2UpdateResponseDraftVersionParametersScope) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseDraftVersionParametersScope) IsKnown() bool

type AuthRuleV2UpdateResponseDraftVersionParametersUnion added in v0.51.0 

type AuthRuleV2UpdateResponseDraftVersionParametersUnion interface {
	ImplementsAuthRuleV2UpdateResponseDraftVersionParameters()
}

Parameters for the current version of the Auth Rule

Union satisfied by AuthRuleV2UpdateResponseDraftVersionParametersConditionalBlockParameters or shared.VelocityLimitParams.

type AuthRuleV2UpdateResponseState added in v0.51.0 

type AuthRuleV2UpdateResponseState string

The state of the Auth Rule 

const (
	AuthRuleV2UpdateResponseStateActive   AuthRuleV2UpdateResponseState = "ACTIVE"
	AuthRuleV2UpdateResponseStateInactive AuthRuleV2UpdateResponseState = "INACTIVE"
)

func (AuthRuleV2UpdateResponseState) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseState) IsKnown() bool

type AuthRuleV2UpdateResponseType added in v0.51.0 

type AuthRuleV2UpdateResponseType string

The type of Auth Rule 

const (
	AuthRuleV2UpdateResponseTypeConditionalBlock AuthRuleV2UpdateResponseType = "CONDITIONAL_BLOCK"
	AuthRuleV2UpdateResponseTypeVelocityLimit    AuthRuleV2UpdateResponseType = "VELOCITY_LIMIT"
)

func (AuthRuleV2UpdateResponseType) IsKnown added in v0.51.0 

func (r AuthRuleV2UpdateResponseType) IsKnown() bool

type AuthStreamEnrollmentService 

type AuthStreamEnrollmentService struct {
	Options []option.RequestOption
}

AuthStreamEnrollmentService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAuthStreamEnrollmentService method instead.

func NewAuthStreamEnrollmentService 

func NewAuthStreamEnrollmentService(opts ...option.RequestOption) (r *AuthStreamEnrollmentService)

NewAuthStreamEnrollmentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AuthStreamEnrollmentService) GetSecret 

func (r *AuthStreamEnrollmentService) GetSecret(ctx context.Context, opts ...option.RequestOption) (res *AuthStreamSecret, err error)

Retrieve the ASA HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify webhooks) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification) for more detail about verifying ASA webhooks.

func (*AuthStreamEnrollmentService) RotateSecret 

func (r *AuthStreamEnrollmentService) RotateSecret(ctx context.Context, opts ...option.RequestOption) (err error)

Generate a new ASA HMAC secret key. The old ASA HMAC secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret) request to retrieve the new secret key.

type AuthStreamSecret 

type AuthStreamSecret struct {
	// The shared HMAC ASA secret
	Secret string               `json:"secret"`
	JSON   authStreamSecretJSON `json:"-"`
}

func (*AuthStreamSecret) UnmarshalJSON 

func (r *AuthStreamSecret) UnmarshalJSON(data []byte) (err error)

type Balance 

type Balance struct {
	// Funds available for spend in the currency's smallest unit (e.g., cents for USD)
	AvailableAmount int64 `json:"available_amount,required"`
	// Date and time for when the balance was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the balance.
	Currency string `json:"currency,required"`
	// Globally unique identifier for the financial account that holds this balance.
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Type of financial account.
	FinancialAccountType BalanceFinancialAccountType `json:"financial_account_type,required"`
	// Globally unique identifier for the last financial transaction event that
	// impacted this balance.
	LastTransactionEventToken string `json:"last_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for the last financial transaction that impacted this
	// balance.
	LastTransactionToken string `json:"last_transaction_token,required" format:"uuid"`
	// Funds not available for spend due to card authorizations or pending ACH release.
	// Shown in the currency's smallest unit (e.g., cents for USD).
	PendingAmount int64 `json:"pending_amount,required"`
	// The sum of available and pending balance in the currency's smallest unit (e.g.,
	// cents for USD).
	TotalAmount int64 `json:"total_amount,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time   `json:"updated,required" format:"date-time"`
	JSON    balanceJSON `json:"-"`
}

Balance

func (*Balance) UnmarshalJSON 

func (r *Balance) UnmarshalJSON(data []byte) (err error)

type BalanceFinancialAccountType added in v0.17.0 

type BalanceFinancialAccountType string

Type of financial account. 

const (
	BalanceFinancialAccountTypeIssuing   BalanceFinancialAccountType = "ISSUING"
	BalanceFinancialAccountTypeOperating BalanceFinancialAccountType = "OPERATING"
	BalanceFinancialAccountTypeReserve   BalanceFinancialAccountType = "RESERVE"
)

func (BalanceFinancialAccountType) IsKnown added in v0.27.0 

func (r BalanceFinancialAccountType) IsKnown() bool

type BalanceListParams 

type BalanceListParams struct {
	// List balances for all financial accounts of a given account_token.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// UTC date and time of the balances to retrieve. Defaults to latest available
	// balances
	BalanceDate param.Field[time.Time] `query:"balance_date" format:"date-time"`
	// List balances for all financial accounts of a given business_account_token.
	BusinessAccountToken param.Field[string] `query:"business_account_token" format:"uuid"`
	// List balances for a given Financial Account type.
	FinancialAccountType param.Field[BalanceListParamsFinancialAccountType] `query:"financial_account_type"`
}

func (BalanceListParams) URLQuery 

func (r BalanceListParams) URLQuery() (v url.Values)

URLQuery serializes BalanceListParams's query parameters as `url.Values`.

type BalanceListParamsFinancialAccountType 

type BalanceListParamsFinancialAccountType string

List balances for a given Financial Account type. 

const (
	BalanceListParamsFinancialAccountTypeIssuing   BalanceListParamsFinancialAccountType = "ISSUING"
	BalanceListParamsFinancialAccountTypeOperating BalanceListParamsFinancialAccountType = "OPERATING"
	BalanceListParamsFinancialAccountTypeReserve   BalanceListParamsFinancialAccountType = "RESERVE"
)

func (BalanceListParamsFinancialAccountType) IsKnown added in v0.27.0 

func (r BalanceListParamsFinancialAccountType) IsKnown() bool

type BalanceService 

type BalanceService struct {
	Options []option.RequestOption
}

BalanceService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBalanceService method instead.

func NewBalanceService 

func NewBalanceService(opts ...option.RequestOption) (r *BalanceService)

NewBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BalanceService) List 

func (r *BalanceService) List(ctx context.Context, query BalanceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Balance], err error)

Get the balances for a program, business, or a given end-user account

func (*BalanceService) ListAutoPaging 

func (r *BalanceService) ListAutoPaging(ctx context.Context, query BalanceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Balance]

Get the balances for a program, business, or a given end-user account

type BookTransferListParams added in v0.35.0 

type BookTransferListParams struct {
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin                param.Field[time.Time] `query:"begin" format:"date-time"`
	BusinessAccountToken param.Field[string]    `query:"business_account_token" format:"uuid"`
	// Book Transfer category to be returned.
	Category param.Field[BookTransferListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Globally unique identifier for the financial account or card that will send the
	// funds. Accepted type dependent on the program's use case.
	FinancialAccountToken param.Field[string] `query:"financial_account_token" format:"uuid"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// Book transfer result to be returned.
	Result param.Field[BookTransferListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Book transfer status to be returned.
	Status param.Field[BookTransferListParamsStatus] `query:"status"`
}

func (BookTransferListParams) URLQuery added in v0.35.0 

func (r BookTransferListParams) URLQuery() (v url.Values)

URLQuery serializes BookTransferListParams's query parameters as `url.Values`.

type BookTransferListParamsCategory added in v0.35.0 

type BookTransferListParamsCategory string

Book Transfer category to be returned. 

const (
	BookTransferListParamsCategoryBalanceOrFunding BookTransferListParamsCategory = "BALANCE_OR_FUNDING"
	BookTransferListParamsCategoryFee              BookTransferListParamsCategory = "FEE"
	BookTransferListParamsCategoryReward           BookTransferListParamsCategory = "REWARD"
	BookTransferListParamsCategoryAdjustment       BookTransferListParamsCategory = "ADJUSTMENT"
	BookTransferListParamsCategoryDerecognition    BookTransferListParamsCategory = "DERECOGNITION"
	BookTransferListParamsCategoryDispute          BookTransferListParamsCategory = "DISPUTE"
	BookTransferListParamsCategoryInternal         BookTransferListParamsCategory = "INTERNAL"
)

func (BookTransferListParamsCategory) IsKnown added in v0.35.0 

func (r BookTransferListParamsCategory) IsKnown() bool

type BookTransferListParamsResult added in v0.35.0 

type BookTransferListParamsResult string

Book transfer result to be returned. 

const (
	BookTransferListParamsResultApproved BookTransferListParamsResult = "APPROVED"
	BookTransferListParamsResultDeclined BookTransferListParamsResult = "DECLINED"
)

func (BookTransferListParamsResult) IsKnown added in v0.35.0 

func (r BookTransferListParamsResult) IsKnown() bool

type BookTransferListParamsStatus added in v0.35.0 

type BookTransferListParamsStatus string

Book transfer status to be returned. 

const (
	BookTransferListParamsStatusDeclined BookTransferListParamsStatus = "DECLINED"
	BookTransferListParamsStatusSettled  BookTransferListParamsStatus = "SETTLED"
)

func (BookTransferListParamsStatus) IsKnown added in v0.35.0 

func (r BookTransferListParamsStatus) IsKnown() bool

type BookTransferNewParams added in v0.35.0 

type BookTransferNewParams struct {
	// Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
	// This should always be a positive value.
	Amount param.Field[int64] `json:"amount,required"`
	// Category of the book transfer
	Category param.Field[BookTransferNewParamsCategory] `json:"category,required"`
	// Globally unique identifier for the financial account or card that will send the
	// funds. Accepted type dependent on the program's use case.
	FromFinancialAccountToken param.Field[string] `json:"from_financial_account_token,required" format:"uuid"`
	// The program specific subtype code for the specified category/type.
	Subtype param.Field[string] `json:"subtype,required"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case.
	ToFinancialAccountToken param.Field[string] `json:"to_financial_account_token,required" format:"uuid"`
	// Type of book_transfer
	Type param.Field[BookTransferNewParamsType] `json:"type,required"`
	// Customer-provided token that will serve as an idempotency token. This token will
	// become the transaction token.
	Token param.Field[string] `json:"token" format:"uuid"`
	// Optional descriptor for the transfer.
	Memo param.Field[string] `json:"memo"`
}

func (BookTransferNewParams) MarshalJSON added in v0.35.0 

func (r BookTransferNewParams) MarshalJSON() (data []byte, err error)

type BookTransferNewParamsCategory added in v0.35.0 

type BookTransferNewParamsCategory string

Category of the book transfer 

const (
	BookTransferNewParamsCategoryAdjustment       BookTransferNewParamsCategory = "ADJUSTMENT"
	BookTransferNewParamsCategoryBalanceOrFunding BookTransferNewParamsCategory = "BALANCE_OR_FUNDING"
	BookTransferNewParamsCategoryDerecognition    BookTransferNewParamsCategory = "DERECOGNITION"
	BookTransferNewParamsCategoryDispute          BookTransferNewParamsCategory = "DISPUTE"
	BookTransferNewParamsCategoryFee              BookTransferNewParamsCategory = "FEE"
	BookTransferNewParamsCategoryReward           BookTransferNewParamsCategory = "REWARD"
	BookTransferNewParamsCategoryTransfer         BookTransferNewParamsCategory = "TRANSFER"
)

func (BookTransferNewParamsCategory) IsKnown added in v0.35.0 

func (r BookTransferNewParamsCategory) IsKnown() bool

type BookTransferNewParamsType added in v0.35.0 

type BookTransferNewParamsType string

Type of book_transfer 

const (
	BookTransferNewParamsTypeAtmWithdrawal              BookTransferNewParamsType = "ATM_WITHDRAWAL"
	BookTransferNewParamsTypeAtmDecline                 BookTransferNewParamsType = "ATM_DECLINE"
	BookTransferNewParamsTypeInternationalAtmWithdrawal BookTransferNewParamsType = "INTERNATIONAL_ATM_WITHDRAWAL"
	BookTransferNewParamsTypeInactivity                 BookTransferNewParamsType = "INACTIVITY"
	BookTransferNewParamsTypeStatement                  BookTransferNewParamsType = "STATEMENT"
	BookTransferNewParamsTypeMonthly                    BookTransferNewParamsType = "MONTHLY"
	BookTransferNewParamsTypeQuarterly                  BookTransferNewParamsType = "QUARTERLY"
	BookTransferNewParamsTypeAnnual                     BookTransferNewParamsType = "ANNUAL"
	BookTransferNewParamsTypeCustomerService            BookTransferNewParamsType = "CUSTOMER_SERVICE"
	BookTransferNewParamsTypeAccountMaintenance         BookTransferNewParamsType = "ACCOUNT_MAINTENANCE"
	BookTransferNewParamsTypeAccountActivation          BookTransferNewParamsType = "ACCOUNT_ACTIVATION"
	BookTransferNewParamsTypeAccountClosure             BookTransferNewParamsType = "ACCOUNT_CLOSURE"
	BookTransferNewParamsTypeCardReplacement            BookTransferNewParamsType = "CARD_REPLACEMENT"
	BookTransferNewParamsTypeCardDelivery               BookTransferNewParamsType = "CARD_DELIVERY"
	BookTransferNewParamsTypeCardCreate                 BookTransferNewParamsType = "CARD_CREATE"
	BookTransferNewParamsTypeCurrencyConversion         BookTransferNewParamsType = "CURRENCY_CONVERSION"
	BookTransferNewParamsTypeInterest                   BookTransferNewParamsType = "INTEREST"
	BookTransferNewParamsTypeLatePayment                BookTransferNewParamsType = "LATE_PAYMENT"
	BookTransferNewParamsTypeBillPayment                BookTransferNewParamsType = "BILL_PAYMENT"
	BookTransferNewParamsTypeCashBack                   BookTransferNewParamsType = "CASH_BACK"
	BookTransferNewParamsTypeAccountToAccount           BookTransferNewParamsType = "ACCOUNT_TO_ACCOUNT"
	BookTransferNewParamsTypeCardToCard                 BookTransferNewParamsType = "CARD_TO_CARD"
	BookTransferNewParamsTypeDisburse                   BookTransferNewParamsType = "DISBURSE"
	BookTransferNewParamsTypeBillingError               BookTransferNewParamsType = "BILLING_ERROR"
	BookTransferNewParamsTypeLossWriteOff               BookTransferNewParamsType = "LOSS_WRITE_OFF"
	BookTransferNewParamsTypeExpiredCard                BookTransferNewParamsType = "EXPIRED_CARD"
	BookTransferNewParamsTypeEarlyDerecognition         BookTransferNewParamsType = "EARLY_DERECOGNITION"
	BookTransferNewParamsTypeEscheatment                BookTransferNewParamsType = "ESCHEATMENT"
	BookTransferNewParamsTypeInactivityFeeDown          BookTransferNewParamsType = "INACTIVITY_FEE_DOWN"
	BookTransferNewParamsTypeProvisionalCredit          BookTransferNewParamsType = "PROVISIONAL_CREDIT"
	BookTransferNewParamsTypeDisputeWon                 BookTransferNewParamsType = "DISPUTE_WON"
	BookTransferNewParamsTypeTransfer                   BookTransferNewParamsType = "TRANSFER"
)

func (BookTransferNewParamsType) IsKnown added in v0.35.0 

func (r BookTransferNewParamsType) IsKnown() bool

type BookTransferResponse added in v0.35.0 

type BookTransferResponse struct {
	// Customer-provided token that will serve as an idempotency token. This token will
	// become the transaction token.
	Token string `json:"token,required" format:"uuid"`
	// Category of the book transfer
	Category BookTransferResponseCategory `json:"category,required"`
	// Date and time when the transfer occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction.
	Currency string `json:"currency,required"`
	// A list of all financial events that have modified this transfer.
	Events []BookTransferResponseEvent `json:"events,required"`
	// Globally unique identifier for the financial account or card that will send the
	// funds. Accepted type dependent on the program's use case.
	FromFinancialAccountToken string `json:"from_financial_account_token,required" format:"uuid"`
	// Pending amount of the transaction in the currency's smallest unit (e.g., cents),
	// including any acquirer fees. The value of this field will go to zero over time
	// once the financial transaction is settled.
	PendingAmount int64 `json:"pending_amount,required"`
	// APPROVED transactions were successful while DECLINED transactions were declined
	// by user, Lithic, or the network.
	Result BookTransferResponseResult `json:"result,required"`
	// Amount of the transaction that has been settled in the currency's smallest unit
	// (e.g., cents).
	SettledAmount int64 `json:"settled_amount,required"`
	// Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
	// transfer was reversed \* `SETTLED` - The transfer is completed.
	Status BookTransferResponseStatus `json:"status,required"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case.
	ToFinancialAccountToken interface{} `json:"to_financial_account_token,required"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated time.Time                `json:"updated,required" format:"date-time"`
	JSON    bookTransferResponseJSON `json:"-"`
}

func (*BookTransferResponse) UnmarshalJSON added in v0.35.0 

func (r *BookTransferResponse) UnmarshalJSON(data []byte) (err error)

type BookTransferResponseCategory added in v0.35.0 

type BookTransferResponseCategory string

Category of the book transfer 

const (
	BookTransferResponseCategoryAdjustment       BookTransferResponseCategory = "ADJUSTMENT"
	BookTransferResponseCategoryBalanceOrFunding BookTransferResponseCategory = "BALANCE_OR_FUNDING"
	BookTransferResponseCategoryDerecognition    BookTransferResponseCategory = "DERECOGNITION"
	BookTransferResponseCategoryDispute          BookTransferResponseCategory = "DISPUTE"
	BookTransferResponseCategoryFee              BookTransferResponseCategory = "FEE"
	BookTransferResponseCategoryReward           BookTransferResponseCategory = "REWARD"
	BookTransferResponseCategoryTransfer         BookTransferResponseCategory = "TRANSFER"
)

func (BookTransferResponseCategory) IsKnown added in v0.35.0 

func (r BookTransferResponseCategory) IsKnown() bool

type BookTransferResponseEvent added in v0.35.0 

type BookTransferResponseEvent struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount,required"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Detailed Results
	DetailedResults []BookTransferResponseEventsDetailedResult `json:"detailed_results,required"`
	// Memo for the transfer.
	Memo string `json:"memo,required"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result BookTransferResponseEventsResult `json:"result,required"`
	// The program specific subtype code for the specified category/type.
	Subtype string `json:"subtype,required"`
	// Type of the book transfer
	Type string                        `json:"type,required"`
	JSON bookTransferResponseEventJSON `json:"-"`
}

func (*BookTransferResponseEvent) UnmarshalJSON added in v0.35.0 

func (r *BookTransferResponseEvent) UnmarshalJSON(data []byte) (err error)

type BookTransferResponseEventsDetailedResult added in v0.35.0 

type BookTransferResponseEventsDetailedResult string
const (
	BookTransferResponseEventsDetailedResultApproved          BookTransferResponseEventsDetailedResult = "APPROVED"
	BookTransferResponseEventsDetailedResultFundsInsufficient BookTransferResponseEventsDetailedResult = "FUNDS_INSUFFICIENT"
)

func (BookTransferResponseEventsDetailedResult) IsKnown added in v0.35.0 

func (r BookTransferResponseEventsDetailedResult) IsKnown() bool

type BookTransferResponseEventsResult added in v0.35.0 

type BookTransferResponseEventsResult string

APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network. 

const (
	BookTransferResponseEventsResultApproved BookTransferResponseEventsResult = "APPROVED"
	BookTransferResponseEventsResultDeclined BookTransferResponseEventsResult = "DECLINED"
)

func (BookTransferResponseEventsResult) IsKnown added in v0.35.0 

func (r BookTransferResponseEventsResult) IsKnown() bool

type BookTransferResponseResult added in v0.35.0 

type BookTransferResponseResult string

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. 

const (
	BookTransferResponseResultApproved BookTransferResponseResult = "APPROVED"
	BookTransferResponseResultDeclined BookTransferResponseResult = "DECLINED"
)

func (BookTransferResponseResult) IsKnown added in v0.35.0 

func (r BookTransferResponseResult) IsKnown() bool

type BookTransferResponseStatus added in v0.35.0 

type BookTransferResponseStatus string

Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The transfer was reversed \* `SETTLED` - The transfer is completed. 

const (
	BookTransferResponseStatusDeclined BookTransferResponseStatus = "DECLINED"
	BookTransferResponseStatusReversed BookTransferResponseStatus = "REVERSED"
	BookTransferResponseStatusSettled  BookTransferResponseStatus = "SETTLED"
)

func (BookTransferResponseStatus) IsKnown added in v0.35.0 

func (r BookTransferResponseStatus) IsKnown() bool

type BookTransferReverseParams added in v0.36.0 

type BookTransferReverseParams struct {
	// Optional descriptor for the reversal.
	Memo param.Field[string] `json:"memo"`
}

func (BookTransferReverseParams) MarshalJSON added in v0.36.0 

func (r BookTransferReverseParams) MarshalJSON() (data []byte, err error)

type BookTransferService added in v0.35.0 

type BookTransferService struct {
	Options []option.RequestOption
}

BookTransferService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBookTransferService method instead.

func NewBookTransferService added in v0.35.0 

func NewBookTransferService(opts ...option.RequestOption) (r *BookTransferService)

NewBookTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BookTransferService) Get added in v0.35.0 

func (r *BookTransferService) Get(ctx context.Context, bookTransferToken string, opts ...option.RequestOption) (res *BookTransferResponse, err error)

Get book transfer by token

func (*BookTransferService) List added in v0.35.0 

func (r *BookTransferService) List(ctx context.Context, query BookTransferListParams, opts ...option.RequestOption) (res *pagination.CursorPage[BookTransferResponse], err error)

List book transfers

func (*BookTransferService) ListAutoPaging added in v0.35.0 

func (r *BookTransferService) ListAutoPaging(ctx context.Context, query BookTransferListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[BookTransferResponse]

List book transfers

func (*BookTransferService) New added in v0.35.0 

func (r *BookTransferService) New(ctx context.Context, body BookTransferNewParams, opts ...option.RequestOption) (res *BookTransferResponse, err error)

Book transfer funds between two financial accounts or between a financial account and card

func (*BookTransferService) Reverse added in v0.36.0 

func (r *BookTransferService) Reverse(ctx context.Context, bookTransferToken string, body BookTransferReverseParams, opts ...option.RequestOption) (res *BookTransferResponse, err error)

Reverse a book transfer

type Card 

type Card struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Globally unique identifier for the account to which the card belongs.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Globally unique identifier for the card program on which the card exists.
	CardProgramToken string `json:"card_program_token,required" format:"uuid"`
	// An RFC 3339 timestamp for when the card was created. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Deprecated: Funding account for the card.
	Funding CardFunding `json:"funding,required"`
	// Last four digits of the card number.
	LastFour string `json:"last_four,required"`
	// Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
	// attempts).
	PinStatus CardPinStatus `json:"pin_status,required"`
	// Amount (in cents) to limit approved authorizations. Transaction requests above
	// the spend limit will be declined.
	SpendLimit int64 `json:"spend_limit,required"`
	// Spend limit duration values:
	//
	//   - `ANNUALLY` - Card will authorize transactions up to spend limit for the
	//     trailing year.
	//   - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
	//     of the card.
	//   - `MONTHLY` - Card will authorize transactions up to spend limit for the
	//     trailing month. To support recurring monthly payments, which can occur on
	//     different day every month, the time window we consider for monthly velocity
	//     starts 6 days after the current calendar date one month prior.
	//   - `TRANSACTION` - Card will authorize multiple transactions if each individual
	//     transaction is under the spend limit.
	SpendLimitDuration SpendLimitDuration `json:"spend_limit_duration,required"`
	// Card state values:
	//
	//   - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
	//     be undone.
	//   - `OPEN` - Card will approve authorizations (if they match card and account
	//     parameters).
	//   - `PAUSED` - Card will decline authorizations, but can be resumed at a later
	//     time.
	//   - `PENDING_FULFILLMENT` - The initial state for cards of type `PHYSICAL`. The
	//     card is provisioned pending manufacturing and fulfillment. Cards in this state
	//     can accept authorizations for e-commerce purchases, but not for "Card Present"
	//     purchases where the physical card itself is present.
	//   - `PENDING_ACTIVATION` - At regular intervals, cards of type `PHYSICAL` in state
	//     `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to
	//     state `PENDING_ACTIVATION` . Similar to `PENDING_FULFILLMENT`, cards in this
	//     state can be used for e-commerce transactions. API clients should update the
	//     card's state to `OPEN` only after the cardholder confirms receipt of the card.
	//
	// In sandbox, the same daily batch fulfillment occurs, but no cards are actually
	// manufactured.
	State CardState `json:"state,required"`
	// Card types:
	//
	//   - `VIRTUAL` - Card will authorize at any merchant and can be added to a digital
	//     wallet like Apple Pay or Google Pay (if the card program is digital
	//     wallet-enabled).
	//   - `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label
	//     branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality.
	//     Reach out at [lithic.com/contact](https://lithic.com/contact) for more
	//     information.
	//   - `SINGLE_USE` - Card is closed upon first successful authorization.
	//   - `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that
	//     successfully authorizes the card.
	Type CardType `json:"type,required"`
	// List of identifiers for the Auth Rule(s) that are applied on the card. This
	// field is deprecated and will no longer be populated in the `Card` object. The
	// key will be removed from the schema in a future release. Use the `/auth_rules`
	// endpoints to fetch Auth Rule information instead.
	AuthRuleTokens []string `json:"auth_rule_tokens"`
	// 3-digit alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency string `json:"cardholder_currency"`
	// Three digit cvv printed on the back of the card.
	Cvv string `json:"cvv"`
	// Specifies the digital card art to be displayed in the user’s digital wallet
	// after tokenization. This artwork must be approved by Mastercard and configured
	// by Lithic to use. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken string `json:"digital_card_art_token" format:"uuid"`
	// Two digit (MM) expiry month.
	ExpMonth string `json:"exp_month"`
	// Four digit (yyyy) expiry year.
	ExpYear string `json:"exp_year"`
	// Hostname of card’s locked merchant (will be empty if not applicable).
	Hostname string `json:"hostname"`
	// Friendly name to identify the card.
	Memo string `json:"memo"`
	// Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
	// compliant to have PAN returned as a field in production. Please contact
	// [support@lithic.com](mailto:support@lithic.com) for questions.
	Pan string `json:"pan"`
	// Indicates if there are offline PIN changes pending card interaction with an
	// offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
	// only to cards issued in markets supporting offline PINs.
	PendingCommands []string `json:"pending_commands"`
	// Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
	// before use. Specifies the configuration (i.e., physical card art) that the card
	// should be manufactured with.
	ProductID string   `json:"product_id"`
	JSON      cardJSON `json:"-"`
}

func (*Card) UnmarshalJSON 

func (r *Card) UnmarshalJSON(data []byte) (err error)

type CardAggregateBalanceListParams added in v0.9.0 

type CardAggregateBalanceListParams struct {
	// Cardholder to retrieve aggregate balances for.
	AccountToken param.Field[string] `query:"account_token"`
	// Business to retrieve aggregate balances for.
	BusinessAccountToken param.Field[string] `query:"business_account_token"`
}

func (CardAggregateBalanceListParams) URLQuery added in v0.9.0 

func (r CardAggregateBalanceListParams) URLQuery() (v url.Values)

URLQuery serializes CardAggregateBalanceListParams's query parameters as `url.Values`.

type CardAggregateBalanceListResponse added in v0.9.0 

type CardAggregateBalanceListResponse struct {
	// Funds available for spend in the currency's smallest unit (e.g., cents for USD)
	AvailableAmount int64 `json:"available_amount,required"`
	// Date and time for when the balance was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the balance.
	Currency string `json:"currency,required"`
	// Globally unique identifier for the card that had its balance updated most
	// recently
	LastCardToken string `json:"last_card_token,required" format:"uuid"`
	// Globally unique identifier for the last transaction event that impacted this
	// balance
	LastTransactionEventToken string `json:"last_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for the last transaction that impacted this balance
	LastTransactionToken string `json:"last_transaction_token,required" format:"uuid"`
	// Funds not available for spend due to card authorizations or pending ACH release.
	// Shown in the currency's smallest unit (e.g., cents for USD)
	PendingAmount int64 `json:"pending_amount,required"`
	// The sum of available and pending balance in the currency's smallest unit (e.g.,
	// cents for USD)
	TotalAmount int64 `json:"total_amount,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time                            `json:"updated,required" format:"date-time"`
	JSON    cardAggregateBalanceListResponseJSON `json:"-"`
}

Card Aggregate Balance across all end-user accounts

func (*CardAggregateBalanceListResponse) UnmarshalJSON added in v0.9.0 

func (r *CardAggregateBalanceListResponse) UnmarshalJSON(data []byte) (err error)

type CardAggregateBalanceService added in v0.9.0 

type CardAggregateBalanceService struct {
	Options []option.RequestOption
}

CardAggregateBalanceService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardAggregateBalanceService method instead.

func NewCardAggregateBalanceService added in v0.9.0 

func NewCardAggregateBalanceService(opts ...option.RequestOption) (r *CardAggregateBalanceService)

NewCardAggregateBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CardAggregateBalanceService) List added in v0.9.0 

func (r *CardAggregateBalanceService) List(ctx context.Context, query CardAggregateBalanceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CardAggregateBalanceListResponse], err error)

Get the aggregated card balance across all end-user accounts.

func (*CardAggregateBalanceService) ListAutoPaging added in v0.9.0 

func (r *CardAggregateBalanceService) ListAutoPaging(ctx context.Context, query CardAggregateBalanceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CardAggregateBalanceListResponse]

Get the aggregated card balance across all end-user accounts.

type CardBalanceListParams added in v0.9.0 

type CardBalanceListParams struct {
	// UTC date of the balance to retrieve. Defaults to latest available balance
	BalanceDate param.Field[time.Time] `query:"balance_date" format:"date-time"`
	// Balance after a given financial event occured. For example, passing the
	// event_token of a $5 CARD_CLEARING financial event will return a balance
	// decreased by $5
	LastTransactionEventToken param.Field[string] `query:"last_transaction_event_token" format:"uuid"`
}

func (CardBalanceListParams) URLQuery added in v0.9.0 

func (r CardBalanceListParams) URLQuery() (v url.Values)

URLQuery serializes CardBalanceListParams's query parameters as `url.Values`.

type CardBalanceListResponse added in v0.29.0 

type CardBalanceListResponse struct {
	// Globally unique identifier for the financial account that holds this balance.
	Token string `json:"token,required" format:"uuid"`
	// Funds available for spend in the currency's smallest unit (e.g., cents for USD)
	AvailableAmount int64 `json:"available_amount,required"`
	// Date and time for when the balance was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the balance.
	Currency string `json:"currency,required"`
	// Globally unique identifier for the last financial transaction event that
	// impacted this balance.
	LastTransactionEventToken string `json:"last_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for the last financial transaction that impacted this
	// balance.
	LastTransactionToken string `json:"last_transaction_token,required" format:"uuid"`
	// Funds not available for spend due to card authorizations or pending ACH release.
	// Shown in the currency's smallest unit (e.g., cents for USD).
	PendingAmount int64 `json:"pending_amount,required"`
	// The sum of available and pending balance in the currency's smallest unit (e.g.,
	// cents for USD).
	TotalAmount int64 `json:"total_amount,required"`
	// Type of financial account.
	Type CardBalanceListResponseType `json:"type,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time                   `json:"updated,required" format:"date-time"`
	JSON    cardBalanceListResponseJSON `json:"-"`
}

Balance of a Financial Account

func (*CardBalanceListResponse) UnmarshalJSON added in v0.29.0 

func (r *CardBalanceListResponse) UnmarshalJSON(data []byte) (err error)

type CardBalanceListResponseType added in v0.29.0 

type CardBalanceListResponseType string

Type of financial account. 

const (
	CardBalanceListResponseTypeIssuing   CardBalanceListResponseType = "ISSUING"
	CardBalanceListResponseTypeOperating CardBalanceListResponseType = "OPERATING"
	CardBalanceListResponseTypeReserve   CardBalanceListResponseType = "RESERVE"
)

func (CardBalanceListResponseType) IsKnown added in v0.29.0 

func (r CardBalanceListResponseType) IsKnown() bool

type CardBalanceService added in v0.9.0 

type CardBalanceService struct {
	Options []option.RequestOption
}

CardBalanceService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardBalanceService method instead.

func NewCardBalanceService added in v0.9.0 

func NewCardBalanceService(opts ...option.RequestOption) (r *CardBalanceService)

NewCardBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CardBalanceService) List added in v0.9.0 

func (r *CardBalanceService) List(ctx context.Context, cardToken string, query CardBalanceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CardBalanceListResponse], err error)

Get the balances for a given card.

func (*CardBalanceService) ListAutoPaging added in v0.9.0 

func (r *CardBalanceService) ListAutoPaging(ctx context.Context, cardToken string, query CardBalanceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CardBalanceListResponse]

Get the balances for a given card.

type CardEmbedParams 

type CardEmbedParams struct {
	// A base64 encoded JSON string of an EmbedRequest to specify which card to load.
	EmbedRequest param.Field[string] `query:"embed_request,required"`
	// SHA256 HMAC of the embed_request JSON string with base64 digest.
	Hmac param.Field[string] `query:"hmac,required"`
}

func (CardEmbedParams) URLQuery 

func (r CardEmbedParams) URLQuery() (v url.Values)

URLQuery serializes CardEmbedParams's query parameters as `url.Values`.

type CardFinancialTransactionListParams added in v0.9.0 

type CardFinancialTransactionListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Financial Transaction category to be returned.
	Category param.Field[CardFinancialTransactionListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Financial Transaction result to be returned.
	Result param.Field[CardFinancialTransactionListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Financial Transaction status to be returned.
	Status param.Field[CardFinancialTransactionListParamsStatus] `query:"status"`
}

func (CardFinancialTransactionListParams) URLQuery added in v0.9.0 

func (r CardFinancialTransactionListParams) URLQuery() (v url.Values)

URLQuery serializes CardFinancialTransactionListParams's query parameters as `url.Values`.

type CardFinancialTransactionListParamsCategory added in v0.9.0 

type CardFinancialTransactionListParamsCategory string

Financial Transaction category to be returned. 

const (
	CardFinancialTransactionListParamsCategoryCard     CardFinancialTransactionListParamsCategory = "CARD"
	CardFinancialTransactionListParamsCategoryTransfer CardFinancialTransactionListParamsCategory = "TRANSFER"
)

func (CardFinancialTransactionListParamsCategory) IsKnown added in v0.27.0 

func (r CardFinancialTransactionListParamsCategory) IsKnown() bool

type CardFinancialTransactionListParamsResult added in v0.9.0 

type CardFinancialTransactionListParamsResult string

Financial Transaction result to be returned. 

const (
	CardFinancialTransactionListParamsResultApproved CardFinancialTransactionListParamsResult = "APPROVED"
	CardFinancialTransactionListParamsResultDeclined CardFinancialTransactionListParamsResult = "DECLINED"
)

func (CardFinancialTransactionListParamsResult) IsKnown added in v0.27.0 

func (r CardFinancialTransactionListParamsResult) IsKnown() bool

type CardFinancialTransactionListParamsStatus added in v0.9.0 

type CardFinancialTransactionListParamsStatus string

Financial Transaction status to be returned. 

const (
	CardFinancialTransactionListParamsStatusDeclined CardFinancialTransactionListParamsStatus = "DECLINED"
	CardFinancialTransactionListParamsStatusExpired  CardFinancialTransactionListParamsStatus = "EXPIRED"
	CardFinancialTransactionListParamsStatusPending  CardFinancialTransactionListParamsStatus = "PENDING"
	CardFinancialTransactionListParamsStatusReturned CardFinancialTransactionListParamsStatus = "RETURNED"
	CardFinancialTransactionListParamsStatusSettled  CardFinancialTransactionListParamsStatus = "SETTLED"
	CardFinancialTransactionListParamsStatusVoided   CardFinancialTransactionListParamsStatus = "VOIDED"
)

func (CardFinancialTransactionListParamsStatus) IsKnown added in v0.27.0 

func (r CardFinancialTransactionListParamsStatus) IsKnown() bool

type CardFinancialTransactionService added in v0.9.0 

type CardFinancialTransactionService struct {
	Options []option.RequestOption
}

CardFinancialTransactionService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardFinancialTransactionService method instead.

func NewCardFinancialTransactionService added in v0.9.0 

func NewCardFinancialTransactionService(opts ...option.RequestOption) (r *CardFinancialTransactionService)

NewCardFinancialTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CardFinancialTransactionService) Get added in v0.9.0 

func (r *CardFinancialTransactionService) Get(ctx context.Context, cardToken string, financialTransactionToken string, opts ...option.RequestOption) (res *FinancialTransaction, err error)

Get the card financial transaction for the provided token.

func (*CardFinancialTransactionService) List added in v0.9.0 

func (r *CardFinancialTransactionService) List(ctx context.Context, cardToken string, query CardFinancialTransactionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[FinancialTransaction], err error)

List the financial transactions for a given card.

func (*CardFinancialTransactionService) ListAutoPaging added in v0.9.0 

func (r *CardFinancialTransactionService) ListAutoPaging(ctx context.Context, cardToken string, query CardFinancialTransactionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[FinancialTransaction]

List the financial transactions for a given card.

type CardFunding deprecated 

type CardFunding struct {
	// A globally unique identifier for this FundingAccount.
	Token string `json:"token,required" format:"uuid"`
	// An RFC 3339 string representing when this funding source was added to the Lithic
	// account. This may be `null`. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// The last 4 digits of the account (e.g. bank account, debit card) associated with
	// this FundingAccount. This may be null.
	LastFour string `json:"last_four,required"`
	// State of funding source.
	//
	// Funding source states:
	//
	//   - `ENABLED` - The funding account is available to use for card creation and
	//     transactions.
	//   - `PENDING` - The funding account is still being verified e.g. bank
	//     micro-deposits verification.
	//   - `DELETED` - The founding account has been deleted.
	State CardFundingState `json:"state,required"`
	// Types of funding source:
	//
	// - `DEPOSITORY_CHECKING` - Bank checking account.
	// - `DEPOSITORY_SAVINGS` - Bank savings account.
	Type CardFundingType `json:"type,required"`
	// Account name identifying the funding source. This may be `null`.
	AccountName string `json:"account_name"`
	// The nickname given to the `FundingAccount` or `null` if it has no nickname.
	Nickname string          `json:"nickname"`
	JSON     cardFundingJSON `json:"-"`
}

Deprecated: Funding account for the card.

func (*CardFunding) UnmarshalJSON 

func (r *CardFunding) UnmarshalJSON(data []byte) (err error)

type CardFundingState 

type CardFundingState string

State of funding source.

Funding source states:

  • `ENABLED` - The funding account is available to use for card creation and transactions.
  • `PENDING` - The funding account is still being verified e.g. bank micro-deposits verification.
  • `DELETED` - The founding account has been deleted.
const (
	CardFundingStateDeleted CardFundingState = "DELETED"
	CardFundingStateEnabled CardFundingState = "ENABLED"
	CardFundingStatePending CardFundingState = "PENDING"
)

func (CardFundingState) IsKnown added in v0.27.0 

func (r CardFundingState) IsKnown() bool

type CardFundingType 

type CardFundingType string

Types of funding source:

- `DEPOSITORY_CHECKING` - Bank checking account. - `DEPOSITORY_SAVINGS` - Bank savings account. 

const (
	CardFundingTypeDepositoryChecking CardFundingType = "DEPOSITORY_CHECKING"
	CardFundingTypeDepositorySavings  CardFundingType = "DEPOSITORY_SAVINGS"
)

func (CardFundingType) IsKnown added in v0.27.0 

func (r CardFundingType) IsKnown() bool

type CardGetEmbedHTMLParams added in v0.3.1 

type CardGetEmbedHTMLParams struct {
	// Globally unique identifier for the card to be displayed.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// A publicly available URI, so the white-labeled card element can be styled with
	// the client's branding.
	Css param.Field[string] `json:"css"`
	// An RFC 3339 timestamp for when the request should expire. UTC time zone.
	//
	// If no timezone is specified, UTC will be used. If payload does not contain an
	// expiration, the request will never expire.
	//
	// Using an `expiration` reduces the risk of a
	// [replay attack](https://en.wikipedia.org/wiki/Replay_attack). Without supplying
	// the `expiration`, in the event that a malicious user gets a copy of your request
	// in transit, they will be able to obtain the response data indefinitely.
	Expiration param.Field[time.Time] `json:"expiration" format:"date-time"`
	// Required if you want to post the element clicked to the parent iframe.
	//
	// If you supply this param, you can also capture click events in the parent iframe
	// by adding an event listener.
	TargetOrigin param.Field[string] `json:"target_origin"`
}

func (CardGetEmbedHTMLParams) MarshalJSON added in v0.3.1 

func (r CardGetEmbedHTMLParams) MarshalJSON() (data []byte, err error)

type CardGetEmbedURLParams added in v0.3.1 

type CardGetEmbedURLParams struct {
	// Globally unique identifier for the card to be displayed.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// A publicly available URI, so the white-labeled card element can be styled with
	// the client's branding.
	Css param.Field[string] `json:"css"`
	// An RFC 3339 timestamp for when the request should expire. UTC time zone.
	//
	// If no timezone is specified, UTC will be used. If payload does not contain an
	// expiration, the request will never expire.
	//
	// Using an `expiration` reduces the risk of a
	// [replay attack](https://en.wikipedia.org/wiki/Replay_attack). Without supplying
	// the `expiration`, in the event that a malicious user gets a copy of your request
	// in transit, they will be able to obtain the response data indefinitely.
	Expiration param.Field[time.Time] `json:"expiration" format:"date-time"`
	// Required if you want to post the element clicked to the parent iframe.
	//
	// If you supply this param, you can also capture click events in the parent iframe
	// by adding an event listener.
	TargetOrigin param.Field[string] `json:"target_origin"`
}

func (CardGetEmbedURLParams) MarshalJSON added in v0.3.1 

func (r CardGetEmbedURLParams) MarshalJSON() (data []byte, err error)

type CardListParams 

type CardListParams struct {
	// Returns cards associated with the specified account.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Returns cards with the specified state.
	State param.Field[CardListParamsState] `query:"state"`
}

func (CardListParams) URLQuery 

func (r CardListParams) URLQuery() (v url.Values)

URLQuery serializes CardListParams's query parameters as `url.Values`.

type CardListParamsState added in v0.6.0 

type CardListParamsState string

Returns cards with the specified state. 

const (
	CardListParamsStateClosed             CardListParamsState = "CLOSED"
	CardListParamsStateOpen               CardListParamsState = "OPEN"
	CardListParamsStatePaused             CardListParamsState = "PAUSED"
	CardListParamsStatePendingActivation  CardListParamsState = "PENDING_ACTIVATION"
	CardListParamsStatePendingFulfillment CardListParamsState = "PENDING_FULFILLMENT"
)

func (CardListParamsState) IsKnown added in v0.27.0 

func (r CardListParamsState) IsKnown() bool

type CardNewParams 

type CardNewParams struct {
	// Card types:
	//
	//   - `VIRTUAL` - Card will authorize at any merchant and can be added to a digital
	//     wallet like Apple Pay or Google Pay (if the card program is digital
	//     wallet-enabled).
	//   - `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label
	//     branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality.
	//     Reach out at [lithic.com/contact](https://lithic.com/contact) for more
	//     information.
	//   - `SINGLE_USE` - Card is closed upon first successful authorization.
	//   - `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that
	//     successfully authorizes the card.
	Type param.Field[CardNewParamsType] `json:"type,required"`
	// Globally unique identifier for the account that the card will be associated
	// with. Required for programs enrolling users using the
	// [/account_holders endpoint](https://docs.lithic.com/docs/account-holders-kyc).
	// See [Managing Your Program](doc:managing-your-program) for more information.
	AccountToken param.Field[string] `json:"account_token" format:"uuid"`
	// For card programs with more than one BIN range. This must be configured with
	// Lithic before use. Identifies the card program/BIN range under which to create
	// the card. If omitted, will utilize the program's default `card_program_token`.
	// In Sandbox, use 00000000-0000-0000-1000-000000000000 and
	// 00000000-0000-0000-2000-000000000000 to test creating cards on specific card
	// programs.
	CardProgramToken param.Field[string]              `json:"card_program_token" format:"uuid"`
	Carrier          param.Field[shared.CarrierParam] `json:"carrier"`
	// Specifies the digital card art to be displayed in the user’s digital wallet
	// after tokenization. This artwork must be approved by Mastercard and configured
	// by Lithic to use. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken param.Field[string] `json:"digital_card_art_token" format:"uuid"`
	// Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
	// an expiration date will be generated.
	ExpMonth param.Field[string] `json:"exp_month"`
	// Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
	// provided, an expiration date will be generated.
	ExpYear param.Field[string] `json:"exp_year"`
	// Friendly name to identify the card.
	Memo param.Field[string] `json:"memo"`
	// Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
	// `VIRTUAL`. See
	// [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
	Pin param.Field[string] `json:"pin"`
	// Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
	// before use. Specifies the configuration (i.e., physical card art) that the card
	// should be manufactured with.
	ProductID param.Field[string] `json:"product_id"`
	// Restricted field limited to select use cases. Lithic will reach out directly if
	// this field should be used. Globally unique identifier for the replacement card's
	// account. If this field is specified, `replacement_for` must also be specified.
	// If `replacement_for` is specified and this field is omitted, the replacement
	// card's account will be inferred from the card being replaced.
	ReplacementAccountToken param.Field[string] `json:"replacement_account_token" format:"uuid"`
	// Only applicable to cards of type `PHYSICAL`. Globally unique identifier for the
	// card that this physical card will replace.
	ReplacementFor  param.Field[string]                      `json:"replacement_for" format:"uuid"`
	ShippingAddress param.Field[shared.ShippingAddressParam] `json:"shipping_address"`
	// Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
	// options besides `STANDARD` require additional permissions.
	//
	//   - `STANDARD` - USPS regular mail or similar international option, with no
	//     tracking
	//   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
	//     with tracking
	//   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
	//   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
	//   - `2_DAY` - FedEx 2-day shipping, with tracking
	//   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
	//     tracking
	ShippingMethod param.Field[CardNewParamsShippingMethod] `json:"shipping_method"`
	// Amount (in cents) to limit approved authorizations. Transaction requests above
	// the spend limit will be declined. Note that a spend limit of 0 is effectively no
	// limit, and should only be used to reset or remove a prior limit. Only a limit of
	// 1 or above will result in declined transactions due to checks against the card
	// limit.
	SpendLimit param.Field[int64] `json:"spend_limit"`
	// Spend limit duration values:
	//
	//   - `ANNUALLY` - Card will authorize transactions up to spend limit for the
	//     trailing year.
	//   - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
	//     of the card.
	//   - `MONTHLY` - Card will authorize transactions up to spend limit for the
	//     trailing month. To support recurring monthly payments, which can occur on
	//     different day every month, the time window we consider for monthly velocity
	//     starts 6 days after the current calendar date one month prior.
	//   - `TRANSACTION` - Card will authorize multiple transactions if each individual
	//     transaction is under the spend limit.
	SpendLimitDuration param.Field[SpendLimitDuration] `json:"spend_limit_duration"`
	// Card state values:
	//
	//   - `OPEN` - Card will approve authorizations (if they match card and account
	//     parameters).
	//   - `PAUSED` - Card will decline authorizations, but can be resumed at a later
	//     time.
	State param.Field[CardNewParamsState] `json:"state"`
}

func (CardNewParams) MarshalJSON 

func (r CardNewParams) MarshalJSON() (data []byte, err error)

type CardNewParamsShippingMethod 

type CardNewParamsShippingMethod string

Shipping method for the card. Only applies to cards of type PHYSICAL. Use of options besides `STANDARD` require additional permissions.

  • `STANDARD` - USPS regular mail or similar international option, with no tracking
  • `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option, with tracking
  • `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
  • `EXPRESS` - FedEx Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx 2-day shipping, with tracking
  • `EXPEDITED` - FedEx Standard Overnight or similar international option, with tracking
const (
	CardNewParamsShippingMethod2Day                 CardNewParamsShippingMethod = "2_DAY"
	CardNewParamsShippingMethodExpedited            CardNewParamsShippingMethod = "EXPEDITED"
	CardNewParamsShippingMethodExpress              CardNewParamsShippingMethod = "EXPRESS"
	CardNewParamsShippingMethodPriority             CardNewParamsShippingMethod = "PRIORITY"
	CardNewParamsShippingMethodStandard             CardNewParamsShippingMethod = "STANDARD"
	CardNewParamsShippingMethodStandardWithTracking CardNewParamsShippingMethod = "STANDARD_WITH_TRACKING"
)

func (CardNewParamsShippingMethod) IsKnown added in v0.27.0 

func (r CardNewParamsShippingMethod) IsKnown() bool

type CardNewParamsState 

type CardNewParamsState string

Card state values:

  • `OPEN` - Card will approve authorizations (if they match card and account parameters).
  • `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
const (
	CardNewParamsStateOpen   CardNewParamsState = "OPEN"
	CardNewParamsStatePaused CardNewParamsState = "PAUSED"
)

func (CardNewParamsState) IsKnown added in v0.27.0 

func (r CardNewParamsState) IsKnown() bool

type CardNewParamsType 

type CardNewParamsType string

Card types:

  • `VIRTUAL` - Card will authorize at any merchant and can be added to a digital wallet like Apple Pay or Google Pay (if the card program is digital wallet-enabled).
  • `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.
  • `SINGLE_USE` - Card is closed upon first successful authorization.
  • `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that successfully authorizes the card.
const (
	CardNewParamsTypeMerchantLocked CardNewParamsType = "MERCHANT_LOCKED"
	CardNewParamsTypePhysical       CardNewParamsType = "PHYSICAL"
	CardNewParamsTypeSingleUse      CardNewParamsType = "SINGLE_USE"
	CardNewParamsTypeVirtual        CardNewParamsType = "VIRTUAL"
)

func (CardNewParamsType) IsKnown added in v0.27.0 

func (r CardNewParamsType) IsKnown() bool

type CardPinStatus added in v0.48.0 

type CardPinStatus string

Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). 

const (
	CardPinStatusOk      CardPinStatus = "OK"
	CardPinStatusBlocked CardPinStatus = "BLOCKED"
	CardPinStatusNotSet  CardPinStatus = "NOT_SET"
)

func (CardPinStatus) IsKnown added in v0.48.0 

func (r CardPinStatus) IsKnown() bool

type CardProgram added in v0.10.0 

type CardProgram struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when the card program was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// The name of the card program.
	Name string `json:"name,required"`
	// The first digits of the card number that this card program ends with.
	PanRangeEnd string `json:"pan_range_end,required"`
	// The first digits of the card number that this card program starts with.
	PanRangeStart string `json:"pan_range_start,required"`
	// 3-digit alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency string `json:"cardholder_currency"`
	// List of 3-digit alphabetic ISO 4217 codes for the currencies that the card
	// program supports for settlement.
	SettlementCurrencies []string        `json:"settlement_currencies"`
	JSON                 cardProgramJSON `json:"-"`
}

func (*CardProgram) UnmarshalJSON added in v0.10.0 

func (r *CardProgram) UnmarshalJSON(data []byte) (err error)

type CardProgramListParams added in v0.10.0 

type CardProgramListParams struct {
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (CardProgramListParams) URLQuery added in v0.10.0 

func (r CardProgramListParams) URLQuery() (v url.Values)

URLQuery serializes CardProgramListParams's query parameters as `url.Values`.

type CardProgramService added in v0.10.0 

type CardProgramService struct {
	Options []option.RequestOption
}

CardProgramService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardProgramService method instead.

func NewCardProgramService added in v0.10.0 

func NewCardProgramService(opts ...option.RequestOption) (r *CardProgramService)

NewCardProgramService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CardProgramService) Get added in v0.10.0 

func (r *CardProgramService) Get(ctx context.Context, cardProgramToken string, opts ...option.RequestOption) (res *CardProgram, err error)

Get card program.

func (*CardProgramService) List added in v0.10.0 

func (r *CardProgramService) List(ctx context.Context, query CardProgramListParams, opts ...option.RequestOption) (res *pagination.CursorPage[CardProgram], err error)

List card programs.

func (*CardProgramService) ListAutoPaging added in v0.10.0 

func (r *CardProgramService) ListAutoPaging(ctx context.Context, query CardProgramListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[CardProgram]

List card programs.

type CardProvisionParams 

type CardProvisionParams struct {
	// Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
	// `activationData` in the response. Apple's public leaf certificate. Base64
	// encoded in PEM format with headers `(-----BEGIN CERTIFICATE-----)` and trailers
	// omitted. Provided by the device's wallet.
	Certificate param.Field[string] `json:"certificate" format:"byte"`
	// Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
	// card is on the Visa network. Stable device identification set by the wallet
	// provider.
	ClientDeviceID param.Field[string] `json:"client_device_id"`
	// Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
	// card is on the Visa network. Consumer ID that identifies the wallet account
	// holder entity.
	ClientWalletAccountID param.Field[string] `json:"client_wallet_account_id"`
	// Name of digital wallet provider.
	DigitalWallet param.Field[CardProvisionParamsDigitalWallet] `json:"digital_wallet"`
	// Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
	// `activationData` in the response. Base64 cryptographic nonce provided by the
	// device's wallet.
	Nonce param.Field[string] `json:"nonce" format:"byte"`
	// Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
	// `activationData` in the response. Base64 cryptographic nonce provided by the
	// device's wallet.
	NonceSignature param.Field[string] `json:"nonce_signature" format:"byte"`
}

func (CardProvisionParams) MarshalJSON 

func (r CardProvisionParams) MarshalJSON() (data []byte, err error)

type CardProvisionParamsDigitalWallet 

type CardProvisionParamsDigitalWallet string

Name of digital wallet provider. 

const (
	CardProvisionParamsDigitalWalletApplePay   CardProvisionParamsDigitalWallet = "APPLE_PAY"
	CardProvisionParamsDigitalWalletGooglePay  CardProvisionParamsDigitalWallet = "GOOGLE_PAY"
	CardProvisionParamsDigitalWalletSamsungPay CardProvisionParamsDigitalWallet = "SAMSUNG_PAY"
)

func (CardProvisionParamsDigitalWallet) IsKnown added in v0.27.0 

func (r CardProvisionParamsDigitalWallet) IsKnown() bool

type CardProvisionResponse 

type CardProvisionResponse struct {
	ProvisioningPayload string                    `json:"provisioning_payload"`
	JSON                cardProvisionResponseJSON `json:"-"`
}

func (*CardProvisionResponse) UnmarshalJSON 

func (r *CardProvisionResponse) UnmarshalJSON(data []byte) (err error)

type CardReissueParams 

type CardReissueParams struct {
	// If omitted, the previous carrier will be used.
	Carrier param.Field[shared.CarrierParam] `json:"carrier"`
	// Specifies the configuration (e.g. physical card art) that the card should be
	// manufactured with, and only applies to cards of type `PHYSICAL`. This must be
	// configured with Lithic before use.
	ProductID param.Field[string] `json:"product_id"`
	// If omitted, the previous shipping address will be used.
	ShippingAddress param.Field[shared.ShippingAddressParam] `json:"shipping_address"`
	// Shipping method for the card. Use of options besides `STANDARD` require
	// additional permissions.
	//
	//   - `STANDARD` - USPS regular mail or similar international option, with no
	//     tracking
	//   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
	//     with tracking
	//   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
	//   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
	//   - `2_DAY` - FedEx 2-day shipping, with tracking
	//   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
	//     tracking
	ShippingMethod param.Field[CardReissueParamsShippingMethod] `json:"shipping_method"`
}

func (CardReissueParams) MarshalJSON 

func (r CardReissueParams) MarshalJSON() (data []byte, err error)

type CardReissueParamsShippingMethod 

type CardReissueParamsShippingMethod string

Shipping method for the card. Use of options besides `STANDARD` require additional permissions.

  • `STANDARD` - USPS regular mail or similar international option, with no tracking
  • `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option, with tracking
  • `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
  • `EXPRESS` - FedEx Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx 2-day shipping, with tracking
  • `EXPEDITED` - FedEx Standard Overnight or similar international option, with tracking
const (
	CardReissueParamsShippingMethod2Day                 CardReissueParamsShippingMethod = "2-DAY"
	CardReissueParamsShippingMethodExpedited            CardReissueParamsShippingMethod = "EXPEDITED"
	CardReissueParamsShippingMethodExpress              CardReissueParamsShippingMethod = "EXPRESS"
	CardReissueParamsShippingMethodPriority             CardReissueParamsShippingMethod = "PRIORITY"
	CardReissueParamsShippingMethodStandard             CardReissueParamsShippingMethod = "STANDARD"
	CardReissueParamsShippingMethodStandardWithTracking CardReissueParamsShippingMethod = "STANDARD_WITH_TRACKING"
)

func (CardReissueParamsShippingMethod) IsKnown added in v0.27.0 

func (r CardReissueParamsShippingMethod) IsKnown() bool

type CardRenewParams added in v0.19.0 

type CardRenewParams struct {
	// The shipping address this card will be sent to.
	ShippingAddress param.Field[shared.ShippingAddressParam] `json:"shipping_address,required"`
	// If omitted, the previous carrier will be used.
	Carrier param.Field[shared.CarrierParam] `json:"carrier"`
	// Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
	// an expiration date six years in the future will be generated.
	ExpMonth param.Field[string] `json:"exp_month"`
	// Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
	// provided, an expiration date six years in the future will be generated.
	ExpYear param.Field[string] `json:"exp_year"`
	// Specifies the configuration (e.g. physical card art) that the card should be
	// manufactured with, and only applies to cards of type `PHYSICAL`. This must be
	// configured with Lithic before use.
	ProductID param.Field[string] `json:"product_id"`
	// Shipping method for the card. Use of options besides `STANDARD` require
	// additional permissions.
	//
	//   - `STANDARD` - USPS regular mail or similar international option, with no
	//     tracking
	//   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
	//     with tracking
	//   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
	//   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
	//   - `2_DAY` - FedEx 2-day shipping, with tracking
	//   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
	//     tracking
	ShippingMethod param.Field[CardRenewParamsShippingMethod] `json:"shipping_method"`
}

func (CardRenewParams) MarshalJSON added in v0.19.0 

func (r CardRenewParams) MarshalJSON() (data []byte, err error)

type CardRenewParamsShippingMethod added in v0.19.0 

type CardRenewParamsShippingMethod string

Shipping method for the card. Use of options besides `STANDARD` require additional permissions.

  • `STANDARD` - USPS regular mail or similar international option, with no tracking
  • `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option, with tracking
  • `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
  • `EXPRESS` - FedEx Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx 2-day shipping, with tracking
  • `EXPEDITED` - FedEx Standard Overnight or similar international option, with tracking
const (
	CardRenewParamsShippingMethod2Day                 CardRenewParamsShippingMethod = "2-DAY"
	CardRenewParamsShippingMethodExpedited            CardRenewParamsShippingMethod = "EXPEDITED"
	CardRenewParamsShippingMethodExpress              CardRenewParamsShippingMethod = "EXPRESS"
	CardRenewParamsShippingMethodPriority             CardRenewParamsShippingMethod = "PRIORITY"
	CardRenewParamsShippingMethodStandard             CardRenewParamsShippingMethod = "STANDARD"
	CardRenewParamsShippingMethodStandardWithTracking CardRenewParamsShippingMethod = "STANDARD_WITH_TRACKING"
)

func (CardRenewParamsShippingMethod) IsKnown added in v0.27.0 

func (r CardRenewParamsShippingMethod) IsKnown() bool

type CardSearchByPanParams added in v0.21.0 

type CardSearchByPanParams struct {
	// The PAN for the card being retrieved.
	Pan param.Field[string] `json:"pan,required"`
}

func (CardSearchByPanParams) MarshalJSON added in v0.21.0 

func (r CardSearchByPanParams) MarshalJSON() (data []byte, err error)

type CardService 

type CardService struct {
	Options               []option.RequestOption
	AggregateBalances     *CardAggregateBalanceService
	Balances              *CardBalanceService
	FinancialTransactions *CardFinancialTransactionService
}

CardService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardService method instead.

func NewCardService 

func NewCardService(opts ...option.RequestOption) (r *CardService)

NewCardService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CardService) Embed 

func (r *CardService) Embed(ctx context.Context, query CardEmbedParams, opts ...option.RequestOption) (res *string, err error)

Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below.

In this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs and CVVs never touch the API customer's servers while full card data is displayed to their end-users. The response contains an HTML document. This means that the url for the request can be inserted straight into the `src` attribute of an iframe.

```html <iframe 

id="card-iframe"
src="https://sandbox.lithic.com/v1/embed/card?embed_request=eyJjc3MiO...;hmac=r8tx1..."
allow="clipboard-write"
class="content"

></iframe> ```

You should compute the request payload on the server side. You can render it (or the whole iframe) on the server or make an ajax call from your front end code, but **do not ever embed your API key into front end code, as doing so introduces a serious security vulnerability**.

func (*CardService) Get 

func (r *CardService) Get(ctx context.Context, cardToken string, opts ...option.RequestOption) (res *Card, err error)

Get card configuration such as spend limit and state.

func (*CardService) GetEmbedHTML 

func (r *CardService) GetEmbedHTML(ctx context.Context, params CardGetEmbedHTMLParams, opts ...option.RequestOption) (res []byte, err error)

func (*CardService) GetEmbedURL 

func (r *CardService) GetEmbedURL(ctx context.Context, params CardGetEmbedURLParams, opts ...option.RequestOption) (res *url.URL, err error)

Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below.

In this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs and CVVs never touch the API customer's servers while full card data is displayed to their end-users. The response contains an HTML document. This means that the url for the request can be inserted straight into the `src` attribute of an iframe.

```html <iframe 

id="card-iframe"
src="https://sandbox.lithic.com/v1/embed/card?embed_request=eyJjc3MiO...;hmac=r8tx1..."
allow="clipboard-write"
class="content"

></iframe> ```

You should compute the request payload on the server side. You can render it (or the whole iframe) on the server or make an ajax call from your front end code, but **do not ever embed your API key into front end code, as doing so introduces a serious security vulnerability**.

func (*CardService) GetSpendLimits added in v0.15.0 

func (r *CardService) GetSpendLimits(ctx context.Context, cardToken string, opts ...option.RequestOption) (res *CardSpendLimits, err error)

Get a Card's available spend limit, which is based on the spend limit configured on the Card and the amount already spent over the spend limit's duration. For example, if the Card has a monthly spend limit of $1000 configured, and has spent $600 in the last month, the available spend limit returned would be $400.

func (*CardService) List 

func (r *CardService) List(ctx context.Context, query CardListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Card], err error)

List cards.

func (*CardService) ListAutoPaging 

func (r *CardService) ListAutoPaging(ctx context.Context, query CardListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Card]

List cards.

func (*CardService) New 

func (r *CardService) New(ctx context.Context, body CardNewParams, opts ...option.RequestOption) (res *Card, err error)

Create a new virtual or physical card. Parameters `pin`, `shipping_address`, and `product_id` only apply to physical cards.

func (*CardService) Provision 

func (r *CardService) Provision(ctx context.Context, cardToken string, body CardProvisionParams, opts ...option.RequestOption) (res *CardProvisionResponse, err error)

Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app.

This requires some additional setup and configuration. Please [Contact Us](https://lithic.com/contact) or your Customer Success representative for more information.

func (*CardService) Reissue 

func (r *CardService) Reissue(ctx context.Context, cardToken string, body CardReissueParams, opts ...option.RequestOption) (res *Card, err error)

Initiate print and shipment of a duplicate physical card.

Only applies to cards of type `PHYSICAL`.

func (*CardService) Renew added in v0.19.0 

func (r *CardService) Renew(ctx context.Context, cardToken string, body CardRenewParams, opts ...option.RequestOption) (res *Card, err error)

Initiate print and shipment of a renewed physical card.

Only applies to cards of type `PHYSICAL`.

func (*CardService) SearchByPan added in v0.21.0 

func (r *CardService) SearchByPan(ctx context.Context, body CardSearchByPanParams, opts ...option.RequestOption) (res *Card, err error)

Get card configuration such as spend limit and state. Customers must be PCI compliant to use this endpoint. Please contact [support@lithic.com](mailto:support@lithic.com) for questions. _Note: this is a `POST` endpoint because it is more secure to send sensitive data in a request body than in a URL._

func (*CardService) Update 

func (r *CardService) Update(ctx context.Context, cardToken string, body CardUpdateParams, opts ...option.RequestOption) (res *Card, err error)

Update the specified properties of the card. Unsupplied properties will remain unchanged. `pin` parameter only applies to physical cards.

_Note: setting a card to a `CLOSED` state is a final action that cannot be undone._

type CardSpendLimits added in v0.15.0 

type CardSpendLimits struct {
	AvailableSpendLimit CardSpendLimitsAvailableSpendLimit `json:"available_spend_limit,required"`
	SpendLimit          CardSpendLimitsSpendLimit          `json:"spend_limit"`
	SpendVelocity       CardSpendLimitsSpendVelocity       `json:"spend_velocity"`
	JSON                cardSpendLimitsJSON                `json:"-"`
}

func (*CardSpendLimits) UnmarshalJSON added in v0.15.0 

func (r *CardSpendLimits) UnmarshalJSON(data []byte) (err error)

type CardSpendLimitsAvailableSpendLimit added in v0.15.0 

type CardSpendLimitsAvailableSpendLimit struct {
	// The available spend limit (in cents) relative to the annual limit configured on
	// the Card.
	Annually int64 `json:"annually"`
	// The available spend limit (in cents) relative to the forever limit configured on
	// the Card.
	Forever int64 `json:"forever"`
	// The available spend limit (in cents) relative to the monthly limit configured on
	// the Card.
	Monthly int64                                  `json:"monthly"`
	JSON    cardSpendLimitsAvailableSpendLimitJSON `json:"-"`
}

func (*CardSpendLimitsAvailableSpendLimit) UnmarshalJSON added in v0.15.0 

func (r *CardSpendLimitsAvailableSpendLimit) UnmarshalJSON(data []byte) (err error)

type CardSpendLimitsSpendLimit added in v0.28.0 

type CardSpendLimitsSpendLimit struct {
	// The configured annual spend limit (in cents) on the Card.
	Annually int64 `json:"annually"`
	// The configured forever spend limit (in cents) on the Card.
	Forever int64 `json:"forever"`
	// The configured monthly spend limit (in cents) on the Card.
	Monthly int64                         `json:"monthly"`
	JSON    cardSpendLimitsSpendLimitJSON `json:"-"`
}

func (*CardSpendLimitsSpendLimit) UnmarshalJSON added in v0.28.0 

func (r *CardSpendLimitsSpendLimit) UnmarshalJSON(data []byte) (err error)

type CardSpendLimitsSpendVelocity added in v0.28.0 

type CardSpendLimitsSpendVelocity struct {
	// Current annual spend velocity (in cents) on the Card. Present if annual spend
	// limit is set.
	Annually int64 `json:"annually"`
	// Current forever spend velocity (in cents) on the Card. Present if forever spend
	// limit is set.
	Forever int64 `json:"forever"`
	// Current monthly spend velocity (in cents) on the Card. Present if monthly spend
	// limit is set.
	Monthly int64                            `json:"monthly"`
	JSON    cardSpendLimitsSpendVelocityJSON `json:"-"`
}

func (*CardSpendLimitsSpendVelocity) UnmarshalJSON added in v0.28.0 

func (r *CardSpendLimitsSpendVelocity) UnmarshalJSON(data []byte) (err error)

type CardState 

type CardState string

Card state values:

  • `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.
  • `OPEN` - Card will approve authorizations (if they match card and account parameters).
  • `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
  • `PENDING_FULFILLMENT` - The initial state for cards of type `PHYSICAL`. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for "Card Present" purchases where the physical card itself is present.
  • `PENDING_ACTIVATION` - At regular intervals, cards of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to state `PENDING_ACTIVATION` . Similar to `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce transactions. API clients should update the card's state to `OPEN` only after the cardholder confirms receipt of the card.

In sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured. 

const (
	CardStateClosed             CardState = "CLOSED"
	CardStateOpen               CardState = "OPEN"
	CardStatePaused             CardState = "PAUSED"
	CardStatePendingActivation  CardState = "PENDING_ACTIVATION"
	CardStatePendingFulfillment CardState = "PENDING_FULFILLMENT"
)

func (CardState) IsKnown added in v0.27.0 

func (r CardState) IsKnown() bool

type CardType 

type CardType string

Card types:

  • `VIRTUAL` - Card will authorize at any merchant and can be added to a digital wallet like Apple Pay or Google Pay (if the card program is digital wallet-enabled).
  • `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.
  • `SINGLE_USE` - Card is closed upon first successful authorization.
  • `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that successfully authorizes the card.
const (
	CardTypeMerchantLocked CardType = "MERCHANT_LOCKED"
	CardTypePhysical       CardType = "PHYSICAL"
	CardTypeSingleUse      CardType = "SINGLE_USE"
	CardTypeVirtual        CardType = "VIRTUAL"
)

func (CardType) IsKnown added in v0.27.0 

func (r CardType) IsKnown() bool

type CardUpdateParams 

type CardUpdateParams struct {
	// Specifies the digital card art to be displayed in the user’s digital wallet
	// after tokenization. This artwork must be approved by Mastercard and configured
	// by Lithic to use. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken param.Field[string] `json:"digital_card_art_token" format:"uuid"`
	// Friendly name to identify the card.
	Memo param.Field[string] `json:"memo"`
	// Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
	// `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
	// [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
	Pin param.Field[string] `json:"pin"`
	// Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
	// attempts). Can only be set to `OK` to unblock a card.
	PinStatus param.Field[CardUpdateParamsPinStatus] `json:"pin_status"`
	// Amount (in cents) to limit approved authorizations. Transaction requests above
	// the spend limit will be declined. Note that a spend limit of 0 is effectively no
	// limit, and should only be used to reset or remove a prior limit. Only a limit of
	// 1 or above will result in declined transactions due to checks against the card
	// limit.
	SpendLimit param.Field[int64] `json:"spend_limit"`
	// Spend limit duration values:
	//
	//   - `ANNUALLY` - Card will authorize transactions up to spend limit for the
	//     trailing year.
	//   - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
	//     of the card.
	//   - `MONTHLY` - Card will authorize transactions up to spend limit for the
	//     trailing month. To support recurring monthly payments, which can occur on
	//     different day every month, the time window we consider for monthly velocity
	//     starts 6 days after the current calendar date one month prior.
	//   - `TRANSACTION` - Card will authorize multiple transactions if each individual
	//     transaction is under the spend limit.
	SpendLimitDuration param.Field[SpendLimitDuration] `json:"spend_limit_duration"`
	// Card state values:
	//
	//   - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
	//     be undone.
	//   - `OPEN` - Card will approve authorizations (if they match card and account
	//     parameters).
	//   - `PAUSED` - Card will decline authorizations, but can be resumed at a later
	//     time.
	State param.Field[CardUpdateParamsState] `json:"state"`
}

func (CardUpdateParams) MarshalJSON 

func (r CardUpdateParams) MarshalJSON() (data []byte, err error)

type CardUpdateParamsPinStatus added in v0.48.0 

type CardUpdateParamsPinStatus string

Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). Can only be set to `OK` to unblock a card. 

const (
	CardUpdateParamsPinStatusOk CardUpdateParamsPinStatus = "OK"
)

func (CardUpdateParamsPinStatus) IsKnown added in v0.48.0 

func (r CardUpdateParamsPinStatus) IsKnown() bool

type CardUpdateParamsState 

type CardUpdateParamsState string

Card state values:

  • `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.
  • `OPEN` - Card will approve authorizations (if they match card and account parameters).
  • `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
const (
	CardUpdateParamsStateClosed CardUpdateParamsState = "CLOSED"
	CardUpdateParamsStateOpen   CardUpdateParamsState = "OPEN"
	CardUpdateParamsStatePaused CardUpdateParamsState = "PAUSED"
)

func (CardUpdateParamsState) IsKnown added in v0.27.0 

func (r CardUpdateParamsState) IsKnown() bool

type CarrierParam added in v0.6.7 

type CarrierParam = shared.CarrierParam

This is an alias to an internal type.

type ChallengeResponseParam added in v0.58.0 

type ChallengeResponseParam struct {
	// Globally unique identifier for the 3DS authentication. This token is sent as
	// part of the initial 3DS Decisioning Request and as part of the 3DS Challenge
	// Event in the [ThreeDSAuthentication](#/components/schemas/ThreeDSAuthentication)
	// object
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Whether the Cardholder has Approved or Declined the issued Challenge
	ChallengeResponse param.Field[ChallengeResult] `json:"challenge_response,required"`
}

func (ChallengeResponseParam) MarshalJSON added in v0.58.0 

func (r ChallengeResponseParam) MarshalJSON() (data []byte, err error)

type ChallengeResult added in v0.58.0 

type ChallengeResult string

Whether the Cardholder has Approved or Declined the issued Challenge 

const (
	ChallengeResultApprove           ChallengeResult = "APPROVE"
	ChallengeResultDeclineByCustomer ChallengeResult = "DECLINE_BY_CUSTOMER"
)

func (ChallengeResult) IsKnown added in v0.58.0 

func (r ChallengeResult) IsKnown() bool

type Client 

type Client struct {
	Options                 []option.RequestOption
	Accounts                *AccountService
	AccountHolders          *AccountHolderService
	AuthRules               *AuthRuleService
	AuthStreamEnrollment    *AuthStreamEnrollmentService
	TokenizationDecisioning *TokenizationDecisioningService
	Tokenizations           *TokenizationService
	Cards                   *CardService
	Balances                *BalanceService
	AggregateBalances       *AggregateBalanceService
	Disputes                *DisputeService
	Events                  *EventService
	Transfers               *TransferService
	FinancialAccounts       *FinancialAccountService
	Transactions            *TransactionService
	ResponderEndpoints      *ResponderEndpointService
	Webhooks                *WebhookService
	ExternalBankAccounts    *ExternalBankAccountService
	Payments                *PaymentService
	ThreeDS                 *ThreeDSService
	Reports                 *ReportService
	CardPrograms            *CardProgramService
	DigitalCardArt          *DigitalCardArtService
	BookTransfers           *BookTransferService
	ExternalPayments        *ExternalPaymentService
	ManagementOperations    *ManagementOperationService
}

Client creates a struct with services and top level methods that help with interacting with the lithic API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (LITHIC_API_KEY, LITHIC_WEBHOOK_SECRET). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) APIStatus 

func (r *Client) APIStatus(ctx context.Context, opts ...option.RequestOption) (res *APIStatus, err error)

Status of api

func (*Client) Delete added in v0.28.0 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute added in v0.28.0 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get added in v0.28.0 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch added in v0.28.0 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post added in v0.28.0 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put added in v0.28.0 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CreditProductExtendedCreditService added in v0.50.1 

type CreditProductExtendedCreditService struct {
	Options []option.RequestOption
}

CreditProductExtendedCreditService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCreditProductExtendedCreditService method instead.

func NewCreditProductExtendedCreditService added in v0.50.1 

func NewCreditProductExtendedCreditService(opts ...option.RequestOption) (r *CreditProductExtendedCreditService)

NewCreditProductExtendedCreditService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CreditProductExtendedCreditService) Get added in v0.50.1 

func (r *CreditProductExtendedCreditService) Get(ctx context.Context, creditProductToken string, opts ...option.RequestOption) (res *ExtendedCredit, err error)

Get the extended credit for a given credit product under a program

type CreditProductPrimeRateGetParams added in v0.63.0 

type CreditProductPrimeRateGetParams struct {
	// The effective date that the prime rates ends before
	EndingBefore param.Field[time.Time] `query:"ending_before" format:"date"`
	// The effective date that the prime rate starts after
	StartingAfter param.Field[time.Time] `query:"starting_after" format:"date"`
}

func (CreditProductPrimeRateGetParams) URLQuery added in v0.63.0 

func (r CreditProductPrimeRateGetParams) URLQuery() (v url.Values)

URLQuery serializes CreditProductPrimeRateGetParams's query parameters as `url.Values`.

type CreditProductPrimeRateGetResponse added in v0.63.0 

type CreditProductPrimeRateGetResponse struct {
	// List of prime rates
	Data []CreditProductPrimeRateGetResponseData `json:"data,required"`
	// Whether there are more prime rates
	HasMore bool                                  `json:"has_more,required"`
	JSON    creditProductPrimeRateGetResponseJSON `json:"-"`
}

func (*CreditProductPrimeRateGetResponse) UnmarshalJSON added in v0.63.0 

func (r *CreditProductPrimeRateGetResponse) UnmarshalJSON(data []byte) (err error)

type CreditProductPrimeRateGetResponseData added in v0.63.0 

type CreditProductPrimeRateGetResponseData struct {
	// Date the rate goes into effect
	EffectiveDate time.Time `json:"effective_date,required" format:"date"`
	// The rate in decimal format
	Rate string                                    `json:"rate,required"`
	JSON creditProductPrimeRateGetResponseDataJSON `json:"-"`
}

func (*CreditProductPrimeRateGetResponseData) UnmarshalJSON added in v0.63.0 

func (r *CreditProductPrimeRateGetResponseData) UnmarshalJSON(data []byte) (err error)

type CreditProductPrimeRateNewParams added in v0.63.0 

type CreditProductPrimeRateNewParams struct {
	// Date the rate goes into effect
	EffectiveDate param.Field[time.Time] `json:"effective_date,required" format:"date"`
	// The rate in decimal format
	Rate param.Field[string] `json:"rate,required"`
}

func (CreditProductPrimeRateNewParams) MarshalJSON added in v0.63.0 

func (r CreditProductPrimeRateNewParams) MarshalJSON() (data []byte, err error)

type CreditProductPrimeRateService added in v0.63.0 

type CreditProductPrimeRateService struct {
	Options []option.RequestOption
}

CreditProductPrimeRateService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCreditProductPrimeRateService method instead.

func NewCreditProductPrimeRateService added in v0.63.0 

func NewCreditProductPrimeRateService(opts ...option.RequestOption) (r *CreditProductPrimeRateService)

NewCreditProductPrimeRateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CreditProductPrimeRateService) Get added in v0.63.0 

func (r *CreditProductPrimeRateService) Get(ctx context.Context, creditProductToken string, query CreditProductPrimeRateGetParams, opts ...option.RequestOption) (res *CreditProductPrimeRateGetResponse, err error)

Get Credit Product Prime Rates

func (*CreditProductPrimeRateService) New added in v0.63.0 

func (r *CreditProductPrimeRateService) New(ctx context.Context, creditProductToken string, body CreditProductPrimeRateNewParams, opts ...option.RequestOption) (err error)

Post Credit Product Prime Rate

type Currency added in v0.50.0 

type Currency = shared.Currency

ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some special currencies like `XXX`. Enumerants names are lowercase currency code e.g. `EUR`, `USD`.

This is an alias to an internal type.

type DigitalCardArt added in v0.10.0 

type DigitalCardArt struct {
	// Globally unique identifier for the card art.
	Token string `json:"token,required" format:"uuid"`
	// Globally unique identifier for the card program.
	CardProgramToken string `json:"card_program_token,required" format:"uuid"`
	// Timestamp of when card art was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Description of the card art.
	Description string `json:"description,required"`
	// Whether the card art is enabled.
	IsEnabled bool `json:"is_enabled,required"`
	// Card network.
	Network DigitalCardArtNetwork `json:"network,required"`
	// Whether the card art is the default card art to be added upon tokenization.
	IsCardProgramDefault bool               `json:"is_card_program_default"`
	JSON                 digitalCardArtJSON `json:"-"`
}

func (*DigitalCardArt) UnmarshalJSON added in v0.10.0 

func (r *DigitalCardArt) UnmarshalJSON(data []byte) (err error)

type DigitalCardArtListParams added in v0.10.0 

type DigitalCardArtListParams struct {
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (DigitalCardArtListParams) URLQuery added in v0.10.0 

func (r DigitalCardArtListParams) URLQuery() (v url.Values)

URLQuery serializes DigitalCardArtListParams's query parameters as `url.Values`.

type DigitalCardArtNetwork added in v0.10.0 

type DigitalCardArtNetwork string

Card network. 

const (
	DigitalCardArtNetworkMastercard DigitalCardArtNetwork = "MASTERCARD"
	DigitalCardArtNetworkVisa       DigitalCardArtNetwork = "VISA"
)

func (DigitalCardArtNetwork) IsKnown added in v0.27.0 

func (r DigitalCardArtNetwork) IsKnown() bool

type DigitalCardArtService added in v0.10.0 

type DigitalCardArtService struct {
	Options []option.RequestOption
}

DigitalCardArtService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDigitalCardArtService method instead.

func NewDigitalCardArtService added in v0.10.0 

func NewDigitalCardArtService(opts ...option.RequestOption) (r *DigitalCardArtService)

NewDigitalCardArtService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*DigitalCardArtService) Get added in v0.17.0 

func (r *DigitalCardArtService) Get(ctx context.Context, digitalCardArtToken string, opts ...option.RequestOption) (res *DigitalCardArt, err error)

Get digital card art by token.

func (*DigitalCardArtService) List added in v0.10.0 

func (r *DigitalCardArtService) List(ctx context.Context, query DigitalCardArtListParams, opts ...option.RequestOption) (res *pagination.CursorPage[DigitalCardArt], err error)

List digital card art.

func (*DigitalCardArtService) ListAutoPaging added in v0.10.0 

func (r *DigitalCardArtService) ListAutoPaging(ctx context.Context, query DigitalCardArtListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[DigitalCardArt]

List digital card art.

type Dispute 

type Dispute struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount under dispute. May be different from the original transaction amount.
	Amount int64 `json:"amount,required"`
	// Date dispute entered arbitration.
	ArbitrationDate time.Time `json:"arbitration_date,required,nullable" format:"date-time"`
	// Timestamp of when first Dispute was reported.
	Created time.Time `json:"created,required" format:"date-time"`
	// Date that the dispute was filed by the customer making the dispute.
	CustomerFiledDate time.Time `json:"customer_filed_date,required,nullable" format:"date-time"`
	// End customer description of the reason for the dispute.
	CustomerNote string `json:"customer_note,required,nullable"`
	// Unique identifiers for the dispute from the network.
	NetworkClaimIDs []string `json:"network_claim_ids,required,nullable"`
	// Date that the dispute was submitted to the network.
	NetworkFiledDate time.Time `json:"network_filed_date,required,nullable" format:"date-time"`
	// Network reason code used to file the dispute.
	NetworkReasonCode string `json:"network_reason_code,required,nullable"`
	// Date dispute entered pre-arbitration.
	PrearbitrationDate time.Time `json:"prearbitration_date,required,nullable" format:"date-time"`
	// Unique identifier for the dispute from the network. If there are multiple, this
	// will be the first claim id set by the network
	PrimaryClaimID string `json:"primary_claim_id,required,nullable"`
	// Dispute reason:
	//
	//   - `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
	//   - `CANCELLED`: Transaction was cancelled by the customer.
	//   - `DUPLICATED`: The transaction was a duplicate.
	//   - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
	//   - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
	//   - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable
	//     merchant activity.
	//   - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as
	//     described.
	//   - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
	//   - `INCORRECT_AMOUNT`: The transaction amount was incorrect.
	//   - `MISSING_AUTH`: The transaction was missing authorization.
	//   - `OTHER`: Other reason.
	//   - `PROCESSING_ERROR`: Processing error.
	//   - `REFUND_NOT_PROCESSED`: The refund was not processed.
	//   - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not
	//     cancelled.
	Reason DisputeReason `json:"reason,required"`
	// Date the representment was received.
	RepresentmentDate time.Time `json:"representment_date,required,nullable" format:"date-time"`
	// Resolution amount net of network fees.
	ResolutionAmount int64 `json:"resolution_amount,required,nullable"`
	// Date that the dispute was resolved.
	ResolutionDate time.Time `json:"resolution_date,required,nullable" format:"date-time"`
	// Note by Dispute team on the case resolution.
	ResolutionNote string `json:"resolution_note,required,nullable"`
	// Reason for the dispute resolution:
	//
	// - `CASE_LOST`: This case was lost at final arbitration.
	// - `NETWORK_REJECTED`: Network rejected.
	// - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS.
	// - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold.
	// - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless.
	// - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid.
	// - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks.
	// - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other.
	// - `PAST_FILING_DATE`: Past filing date.
	// - `PREARBITRATION_REJECTED`: Prearbitration rejected.
	// - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other.
	// - `REFUNDED`: Refunded.
	// - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback.
	// - `WITHDRAWN`: Withdrawn.
	// - `WON_ARBITRATION`: Won arbitration.
	// - `WON_FIRST_CHARGEBACK`: Won first chargeback.
	// - `WON_PREARBITRATION`: Won prearbitration.
	ResolutionReason DisputeResolutionReason `json:"resolution_reason,required,nullable"`
	// Status types:
	//
	//   - `NEW` - New dispute case is opened.
	//   - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more
	//     information.
	//   - `SUBMITTED` - Dispute is submitted to the card network.
	//   - `REPRESENTMENT` - Case has entered second presentment.
	//   - `PREARBITRATION` - Case has entered prearbitration.
	//   - `ARBITRATION` - Case has entered arbitration.
	//   - `CASE_WON` - Case was won and credit will be issued.
	//   - `CASE_CLOSED` - Case was lost or withdrawn.
	Status DisputeStatus `json:"status,required"`
	// The transaction that is being disputed. A transaction can only be disputed once
	// but may have multiple dispute cases.
	TransactionToken string      `json:"transaction_token,required" format:"uuid"`
	JSON             disputeJSON `json:"-"`
}

Dispute.

func (*Dispute) UnmarshalJSON 

func (r *Dispute) UnmarshalJSON(data []byte) (err error)

type DisputeEvidence 

type DisputeEvidence struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when dispute evidence was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Dispute token evidence is attached to.
	DisputeToken string `json:"dispute_token,required" format:"uuid"`
	// Upload status types:
	//
	// - `DELETED` - Evidence was deleted.
	// - `ERROR` - Evidence upload failed.
	// - `PENDING` - Evidence is pending upload.
	// - `REJECTED` - Evidence was rejected.
	// - `UPLOADED` - Evidence was uploaded.
	UploadStatus DisputeEvidenceUploadStatus `json:"upload_status,required"`
	// URL to download evidence. Only shown when `upload_status` is `UPLOADED`.
	DownloadURL string `json:"download_url"`
	// File name of evidence. Recommended to give the dispute evidence a human-readable
	// identifier.
	Filename string `json:"filename"`
	// URL to upload evidence. Only shown when `upload_status` is `PENDING`.
	UploadURL string              `json:"upload_url"`
	JSON      disputeEvidenceJSON `json:"-"`
}

Dispute evidence.

func (*DisputeEvidence) UnmarshalJSON 

func (r *DisputeEvidence) UnmarshalJSON(data []byte) (err error)

type DisputeEvidenceUploadStatus 

type DisputeEvidenceUploadStatus string

Upload status types:

- `DELETED` - Evidence was deleted. - `ERROR` - Evidence upload failed. - `PENDING` - Evidence is pending upload. - `REJECTED` - Evidence was rejected. - `UPLOADED` - Evidence was uploaded. 

const (
	DisputeEvidenceUploadStatusDeleted  DisputeEvidenceUploadStatus = "DELETED"
	DisputeEvidenceUploadStatusError    DisputeEvidenceUploadStatus = "ERROR"
	DisputeEvidenceUploadStatusPending  DisputeEvidenceUploadStatus = "PENDING"
	DisputeEvidenceUploadStatusRejected DisputeEvidenceUploadStatus = "REJECTED"
	DisputeEvidenceUploadStatusUploaded DisputeEvidenceUploadStatus = "UPLOADED"
)

func (DisputeEvidenceUploadStatus) IsKnown added in v0.27.0 

func (r DisputeEvidenceUploadStatus) IsKnown() bool

type DisputeInitiateEvidenceUploadParams added in v0.4.0 

type DisputeInitiateEvidenceUploadParams struct {
	// Filename of the evidence.
	Filename param.Field[string] `json:"filename"`
}

func (DisputeInitiateEvidenceUploadParams) MarshalJSON added in v0.4.0 

func (r DisputeInitiateEvidenceUploadParams) MarshalJSON() (data []byte, err error)

type DisputeListEvidencesParams 

type DisputeListEvidencesParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (DisputeListEvidencesParams) URLQuery 

func (r DisputeListEvidencesParams) URLQuery() (v url.Values)

URLQuery serializes DisputeListEvidencesParams's query parameters as `url.Values`.

type DisputeListParams 

type DisputeListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// List disputes of a specific status.
	Status param.Field[DisputeListParamsStatus] `query:"status"`
	// Transaction tokens to filter by.
	TransactionTokens param.Field[[]string] `query:"transaction_tokens" format:"uuid"`
}

func (DisputeListParams) URLQuery 

func (r DisputeListParams) URLQuery() (v url.Values)

URLQuery serializes DisputeListParams's query parameters as `url.Values`.

type DisputeListParamsStatus 

type DisputeListParamsStatus string

List disputes of a specific status. 

const (
	DisputeListParamsStatusArbitration     DisputeListParamsStatus = "ARBITRATION"
	DisputeListParamsStatusCaseClosed      DisputeListParamsStatus = "CASE_CLOSED"
	DisputeListParamsStatusCaseWon         DisputeListParamsStatus = "CASE_WON"
	DisputeListParamsStatusNew             DisputeListParamsStatus = "NEW"
	DisputeListParamsStatusPendingCustomer DisputeListParamsStatus = "PENDING_CUSTOMER"
	DisputeListParamsStatusPrearbitration  DisputeListParamsStatus = "PREARBITRATION"
	DisputeListParamsStatusRepresentment   DisputeListParamsStatus = "REPRESENTMENT"
	DisputeListParamsStatusSubmitted       DisputeListParamsStatus = "SUBMITTED"
)

func (DisputeListParamsStatus) IsKnown added in v0.27.0 

func (r DisputeListParamsStatus) IsKnown() bool

type DisputeNewParams 

type DisputeNewParams struct {
	// Amount to dispute
	Amount param.Field[int64] `json:"amount,required"`
	// Reason for dispute
	Reason param.Field[DisputeNewParamsReason] `json:"reason,required"`
	// Transaction to dispute
	TransactionToken param.Field[string] `json:"transaction_token,required" format:"uuid"`
	// Date the customer filed the dispute
	CustomerFiledDate param.Field[time.Time] `json:"customer_filed_date" format:"date-time"`
	// Customer description of dispute
	CustomerNote param.Field[string] `json:"customer_note"`
}

func (DisputeNewParams) MarshalJSON 

func (r DisputeNewParams) MarshalJSON() (data []byte, err error)

type DisputeNewParamsReason 

type DisputeNewParamsReason string

Reason for dispute 

const (
	DisputeNewParamsReasonAtmCashMisdispense               DisputeNewParamsReason = "ATM_CASH_MISDISPENSE"
	DisputeNewParamsReasonCancelled                        DisputeNewParamsReason = "CANCELLED"
	DisputeNewParamsReasonDuplicated                       DisputeNewParamsReason = "DUPLICATED"
	DisputeNewParamsReasonFraudCardNotPresent              DisputeNewParamsReason = "FRAUD_CARD_NOT_PRESENT"
	DisputeNewParamsReasonFraudCardPresent                 DisputeNewParamsReason = "FRAUD_CARD_PRESENT"
	DisputeNewParamsReasonFraudOther                       DisputeNewParamsReason = "FRAUD_OTHER"
	DisputeNewParamsReasonGoodsServicesNotAsDescribed      DisputeNewParamsReason = "GOODS_SERVICES_NOT_AS_DESCRIBED"
	DisputeNewParamsReasonGoodsServicesNotReceived         DisputeNewParamsReason = "GOODS_SERVICES_NOT_RECEIVED"
	DisputeNewParamsReasonIncorrectAmount                  DisputeNewParamsReason = "INCORRECT_AMOUNT"
	DisputeNewParamsReasonMissingAuth                      DisputeNewParamsReason = "MISSING_AUTH"
	DisputeNewParamsReasonOther                            DisputeNewParamsReason = "OTHER"
	DisputeNewParamsReasonProcessingError                  DisputeNewParamsReason = "PROCESSING_ERROR"
	DisputeNewParamsReasonRecurringTransactionNotCancelled DisputeNewParamsReason = "RECURRING_TRANSACTION_NOT_CANCELLED"
	DisputeNewParamsReasonRefundNotProcessed               DisputeNewParamsReason = "REFUND_NOT_PROCESSED"
)

func (DisputeNewParamsReason) IsKnown added in v0.27.0 

func (r DisputeNewParamsReason) IsKnown() bool

type DisputeReason 

type DisputeReason string

Dispute reason:

  • `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
  • `CANCELLED`: Transaction was cancelled by the customer.
  • `DUPLICATED`: The transaction was a duplicate.
  • `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
  • `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
  • `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable merchant activity.
  • `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as described.
  • `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
  • `INCORRECT_AMOUNT`: The transaction amount was incorrect.
  • `MISSING_AUTH`: The transaction was missing authorization.
  • `OTHER`: Other reason.
  • `PROCESSING_ERROR`: Processing error.
  • `REFUND_NOT_PROCESSED`: The refund was not processed.
  • `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not cancelled.
const (
	DisputeReasonAtmCashMisdispense               DisputeReason = "ATM_CASH_MISDISPENSE"
	DisputeReasonCancelled                        DisputeReason = "CANCELLED"
	DisputeReasonDuplicated                       DisputeReason = "DUPLICATED"
	DisputeReasonFraudCardNotPresent              DisputeReason = "FRAUD_CARD_NOT_PRESENT"
	DisputeReasonFraudCardPresent                 DisputeReason = "FRAUD_CARD_PRESENT"
	DisputeReasonFraudOther                       DisputeReason = "FRAUD_OTHER"
	DisputeReasonGoodsServicesNotAsDescribed      DisputeReason = "GOODS_SERVICES_NOT_AS_DESCRIBED"
	DisputeReasonGoodsServicesNotReceived         DisputeReason = "GOODS_SERVICES_NOT_RECEIVED"
	DisputeReasonIncorrectAmount                  DisputeReason = "INCORRECT_AMOUNT"
	DisputeReasonMissingAuth                      DisputeReason = "MISSING_AUTH"
	DisputeReasonOther                            DisputeReason = "OTHER"
	DisputeReasonProcessingError                  DisputeReason = "PROCESSING_ERROR"
	DisputeReasonRecurringTransactionNotCancelled DisputeReason = "RECURRING_TRANSACTION_NOT_CANCELLED"
	DisputeReasonRefundNotProcessed               DisputeReason = "REFUND_NOT_PROCESSED"
)

func (DisputeReason) IsKnown added in v0.27.0 

func (r DisputeReason) IsKnown() bool

type DisputeResolutionReason 

type DisputeResolutionReason string

Reason for the dispute resolution:

- `CASE_LOST`: This case was lost at final arbitration. - `NETWORK_REJECTED`: Network rejected. - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - `PAST_FILING_DATE`: Past filing date. - `PREARBITRATION_REJECTED`: Prearbitration rejected. - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - `REFUNDED`: Refunded. - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - `WITHDRAWN`: Withdrawn. - `WON_ARBITRATION`: Won arbitration. - `WON_FIRST_CHARGEBACK`: Won first chargeback. - `WON_PREARBITRATION`: Won prearbitration. 

const (
	DisputeResolutionReasonCaseLost                      DisputeResolutionReason = "CASE_LOST"
	DisputeResolutionReasonNetworkRejected               DisputeResolutionReason = "NETWORK_REJECTED"
	DisputeResolutionReasonNoDisputeRights3DS            DisputeResolutionReason = "NO_DISPUTE_RIGHTS_3DS"
	DisputeResolutionReasonNoDisputeRightsBelowThreshold DisputeResolutionReason = "NO_DISPUTE_RIGHTS_BELOW_THRESHOLD"
	DisputeResolutionReasonNoDisputeRightsContactless    DisputeResolutionReason = "NO_DISPUTE_RIGHTS_CONTACTLESS"
	DisputeResolutionReasonNoDisputeRightsHybrid         DisputeResolutionReason = "NO_DISPUTE_RIGHTS_HYBRID"
	DisputeResolutionReasonNoDisputeRightsMaxChargebacks DisputeResolutionReason = "NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS"
	DisputeResolutionReasonNoDisputeRightsOther          DisputeResolutionReason = "NO_DISPUTE_RIGHTS_OTHER"
	DisputeResolutionReasonPastFilingDate                DisputeResolutionReason = "PAST_FILING_DATE"
	DisputeResolutionReasonPrearbitrationRejected        DisputeResolutionReason = "PREARBITRATION_REJECTED"
	DisputeResolutionReasonProcessorRejectedOther        DisputeResolutionReason = "PROCESSOR_REJECTED_OTHER"
	DisputeResolutionReasonRefunded                      DisputeResolutionReason = "REFUNDED"
	DisputeResolutionReasonRefundedAfterChargeback       DisputeResolutionReason = "REFUNDED_AFTER_CHARGEBACK"
	DisputeResolutionReasonWithdrawn                     DisputeResolutionReason = "WITHDRAWN"
	DisputeResolutionReasonWonArbitration                DisputeResolutionReason = "WON_ARBITRATION"
	DisputeResolutionReasonWonFirstChargeback            DisputeResolutionReason = "WON_FIRST_CHARGEBACK"
	DisputeResolutionReasonWonPrearbitration             DisputeResolutionReason = "WON_PREARBITRATION"
)

func (DisputeResolutionReason) IsKnown added in v0.27.0 

func (r DisputeResolutionReason) IsKnown() bool

type DisputeService 

type DisputeService struct {
	Options []option.RequestOption
}

DisputeService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDisputeService method instead.

func NewDisputeService 

func NewDisputeService(opts ...option.RequestOption) (r *DisputeService)

NewDisputeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*DisputeService) Delete 

func (r *DisputeService) Delete(ctx context.Context, disputeToken string, opts ...option.RequestOption) (res *Dispute, err error)

Withdraw dispute.

func (*DisputeService) DeleteEvidence 

func (r *DisputeService) DeleteEvidence(ctx context.Context, disputeToken string, evidenceToken string, opts ...option.RequestOption) (res *DisputeEvidence, err error)

Soft delete evidence for a dispute. Evidence will not be reviewed or submitted by Lithic after it is withdrawn.

func (*DisputeService) Get 

func (r *DisputeService) Get(ctx context.Context, disputeToken string, opts ...option.RequestOption) (res *Dispute, err error)

Get dispute.

func (*DisputeService) GetEvidence 

func (r *DisputeService) GetEvidence(ctx context.Context, disputeToken string, evidenceToken string, opts ...option.RequestOption) (res *DisputeEvidence, err error)

Get a dispute's evidence metadata.

func (*DisputeService) InitiateEvidenceUpload 

func (r *DisputeService) InitiateEvidenceUpload(ctx context.Context, disputeToken string, body DisputeInitiateEvidenceUploadParams, opts ...option.RequestOption) (res *DisputeEvidence, err error)

Use this endpoint to upload evidences for the dispute. It will return a URL to upload your documents to. The URL will expire in 30 minutes.

Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be less than 5 GiB.

func (*DisputeService) List 

func (r *DisputeService) List(ctx context.Context, query DisputeListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Dispute], err error)

List disputes.

func (*DisputeService) ListAutoPaging 

func (r *DisputeService) ListAutoPaging(ctx context.Context, query DisputeListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Dispute]

List disputes.

func (*DisputeService) ListEvidences 

func (r *DisputeService) ListEvidences(ctx context.Context, disputeToken string, query DisputeListEvidencesParams, opts ...option.RequestOption) (res *pagination.CursorPage[DisputeEvidence], err error)

List evidence metadata for a dispute.

func (*DisputeService) ListEvidencesAutoPaging 

func (r *DisputeService) ListEvidencesAutoPaging(ctx context.Context, disputeToken string, query DisputeListEvidencesParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[DisputeEvidence]

List evidence metadata for a dispute.

func (*DisputeService) New 

func (r *DisputeService) New(ctx context.Context, body DisputeNewParams, opts ...option.RequestOption) (res *Dispute, err error)

Initiate a dispute.

func (*DisputeService) Update 

func (r *DisputeService) Update(ctx context.Context, disputeToken string, body DisputeUpdateParams, opts ...option.RequestOption) (res *Dispute, err error)

Update dispute. Can only be modified if status is `NEW`.

func (*DisputeService) UploadEvidence 

func (r *DisputeService) UploadEvidence(ctx context.Context, disputeToken string, file io.Reader, opts ...option.RequestOption) (err error)

type DisputeStatus 

type DisputeStatus string

Status types:

  • `NEW` - New dispute case is opened.
  • `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more information.
  • `SUBMITTED` - Dispute is submitted to the card network.
  • `REPRESENTMENT` - Case has entered second presentment.
  • `PREARBITRATION` - Case has entered prearbitration.
  • `ARBITRATION` - Case has entered arbitration.
  • `CASE_WON` - Case was won and credit will be issued.
  • `CASE_CLOSED` - Case was lost or withdrawn.
const (
	DisputeStatusArbitration     DisputeStatus = "ARBITRATION"
	DisputeStatusCaseClosed      DisputeStatus = "CASE_CLOSED"
	DisputeStatusCaseWon         DisputeStatus = "CASE_WON"
	DisputeStatusNew             DisputeStatus = "NEW"
	DisputeStatusPendingCustomer DisputeStatus = "PENDING_CUSTOMER"
	DisputeStatusPrearbitration  DisputeStatus = "PREARBITRATION"
	DisputeStatusRepresentment   DisputeStatus = "REPRESENTMENT"
	DisputeStatusSubmitted       DisputeStatus = "SUBMITTED"
)

func (DisputeStatus) IsKnown added in v0.27.0 

func (r DisputeStatus) IsKnown() bool

type DisputeUpdateParams 

type DisputeUpdateParams struct {
	// Amount to dispute
	Amount param.Field[int64] `json:"amount"`
	// Date the customer filed the dispute
	CustomerFiledDate param.Field[time.Time] `json:"customer_filed_date" format:"date-time"`
	// Customer description of dispute
	CustomerNote param.Field[string] `json:"customer_note"`
	// Reason for dispute
	Reason param.Field[DisputeUpdateParamsReason] `json:"reason"`
}

func (DisputeUpdateParams) MarshalJSON 

func (r DisputeUpdateParams) MarshalJSON() (data []byte, err error)

type DisputeUpdateParamsReason 

type DisputeUpdateParamsReason string

Reason for dispute 

const (
	DisputeUpdateParamsReasonAtmCashMisdispense               DisputeUpdateParamsReason = "ATM_CASH_MISDISPENSE"
	DisputeUpdateParamsReasonCancelled                        DisputeUpdateParamsReason = "CANCELLED"
	DisputeUpdateParamsReasonDuplicated                       DisputeUpdateParamsReason = "DUPLICATED"
	DisputeUpdateParamsReasonFraudCardNotPresent              DisputeUpdateParamsReason = "FRAUD_CARD_NOT_PRESENT"
	DisputeUpdateParamsReasonFraudCardPresent                 DisputeUpdateParamsReason = "FRAUD_CARD_PRESENT"
	DisputeUpdateParamsReasonFraudOther                       DisputeUpdateParamsReason = "FRAUD_OTHER"
	DisputeUpdateParamsReasonGoodsServicesNotAsDescribed      DisputeUpdateParamsReason = "GOODS_SERVICES_NOT_AS_DESCRIBED"
	DisputeUpdateParamsReasonGoodsServicesNotReceived         DisputeUpdateParamsReason = "GOODS_SERVICES_NOT_RECEIVED"
	DisputeUpdateParamsReasonIncorrectAmount                  DisputeUpdateParamsReason = "INCORRECT_AMOUNT"
	DisputeUpdateParamsReasonMissingAuth                      DisputeUpdateParamsReason = "MISSING_AUTH"
	DisputeUpdateParamsReasonOther                            DisputeUpdateParamsReason = "OTHER"
	DisputeUpdateParamsReasonProcessingError                  DisputeUpdateParamsReason = "PROCESSING_ERROR"
	DisputeUpdateParamsReasonRecurringTransactionNotCancelled DisputeUpdateParamsReason = "RECURRING_TRANSACTION_NOT_CANCELLED"
	DisputeUpdateParamsReasonRefundNotProcessed               DisputeUpdateParamsReason = "REFUND_NOT_PROCESSED"
)

func (DisputeUpdateParamsReason) IsKnown added in v0.27.0 

func (r DisputeUpdateParamsReason) IsKnown() bool

type DisputeUploadEvidenceParams added in v0.3.1 

type DisputeUploadEvidenceParams struct {
}

type Document added in v0.48.0 

type Document = shared.Document

Describes the document and the required document image uploads required to re-run KYC

This is an alias to an internal type.

type DocumentDocumentType added in v0.48.0 

type DocumentDocumentType = shared.DocumentDocumentType

Type of documentation to be submitted for verification of an account holder

This is an alias to an internal type.

type DocumentRequiredDocumentUpload added in v0.48.0 

type DocumentRequiredDocumentUpload = shared.DocumentRequiredDocumentUpload

Represents a single image of the document to upload.

This is an alias to an internal type.

type DocumentRequiredDocumentUploadsImageType added in v0.48.0 

type DocumentRequiredDocumentUploadsImageType = shared.DocumentRequiredDocumentUploadsImageType

Type of image to upload.

This is an alias to an internal type.

type DocumentRequiredDocumentUploadsStatus added in v0.48.0 

type DocumentRequiredDocumentUploadsStatus = shared.DocumentRequiredDocumentUploadsStatus

Status of an account holder's document upload.

This is an alias to an internal type.

type DocumentRequiredDocumentUploadsStatusReason added in v0.48.0 

type DocumentRequiredDocumentUploadsStatusReason = shared.DocumentRequiredDocumentUploadsStatusReason

The status reasons for an account holder document upload that is not ACCEPTED

This is an alias to an internal type.

type EnhancedData added in v0.39.0 

type EnhancedData struct {
	// A unique identifier for the enhanced commercial data.
	Token  string             `json:"token,required" format:"uuid"`
	Common EnhancedDataCommon `json:"common,required"`
	// The token of the event that the enhanced data is associated with.
	EventToken string              `json:"event_token,required" format:"uuid"`
	Fleet      []EnhancedDataFleet `json:"fleet,required"`
	// The token of the transaction that the enhanced data is associated with.
	TransactionToken string           `json:"transaction_token,required" format:"uuid"`
	JSON             enhancedDataJSON `json:"-"`
}

func (*EnhancedData) UnmarshalJSON added in v0.39.0 

func (r *EnhancedData) UnmarshalJSON(data []byte) (err error)

type EnhancedDataCommon added in v0.39.0 

type EnhancedDataCommon struct {
	LineItems []EnhancedDataCommonLineItem `json:"line_items,required"`
	Tax       EnhancedDataCommonTax        `json:"tax,required"`
	// An optional customer identifier.
	CustomerReferenceNumber string `json:"customer_reference_number"`
	// An optional merchant identifier.
	MerchantReferenceNumber string `json:"merchant_reference_number"`
	// The date of the order.
	OrderDate time.Time              `json:"order_date" format:"date"`
	JSON      enhancedDataCommonJSON `json:"-"`
}

func (*EnhancedDataCommon) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataCommon) UnmarshalJSON(data []byte) (err error)

type EnhancedDataCommonLineItem added in v0.39.0 

type EnhancedDataCommonLineItem struct {
	// The price of the item purchased in merchant currency.
	Amount float64 `json:"amount"`
	// A human-readable description of the item.
	Description string `json:"description"`
	// An identifier for the item purchased.
	ProductCode string `json:"product_code"`
	// The quantity of the item purchased.
	Quantity float64                        `json:"quantity"`
	JSON     enhancedDataCommonLineItemJSON `json:"-"`
}

An L2/L3 enhanced commercial data line item.

func (*EnhancedDataCommonLineItem) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataCommonLineItem) UnmarshalJSON(data []byte) (err error)

type EnhancedDataCommonTax added in v0.39.0 

type EnhancedDataCommonTax struct {
	// The amount of tax collected.
	Amount int64 `json:"amount"`
	// A flag indicating whether the transaction is tax exempt or not.
	Exempt EnhancedDataCommonTaxExempt `json:"exempt"`
	// The tax ID of the merchant.
	MerchantTaxID string                    `json:"merchant_tax_id"`
	JSON          enhancedDataCommonTaxJSON `json:"-"`
}

func (*EnhancedDataCommonTax) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataCommonTax) UnmarshalJSON(data []byte) (err error)

type EnhancedDataCommonTaxExempt added in v0.39.0 

type EnhancedDataCommonTaxExempt string

A flag indicating whether the transaction is tax exempt or not. 

const (
	EnhancedDataCommonTaxExemptTaxIncluded    EnhancedDataCommonTaxExempt = "TAX_INCLUDED"
	EnhancedDataCommonTaxExemptTaxNotIncluded EnhancedDataCommonTaxExempt = "TAX_NOT_INCLUDED"
	EnhancedDataCommonTaxExemptNotSupported   EnhancedDataCommonTaxExempt = "NOT_SUPPORTED"
)

func (EnhancedDataCommonTaxExempt) IsKnown added in v0.39.0 

func (r EnhancedDataCommonTaxExempt) IsKnown() bool

type EnhancedDataFleet added in v0.39.0 

type EnhancedDataFleet struct {
	AmountTotals EnhancedDataFleetAmountTotals `json:"amount_totals,required"`
	Fuel         EnhancedDataFleetFuel         `json:"fuel,required"`
	// The driver number entered into at the terminal at the time of sale, with leading
	// zeroes stripped.
	DriverNumber string `json:"driver_number"`
	// The odometer reading entered into at the terminal at the time of sale.
	Odometer int64 `json:"odometer"`
	// The type of fuel service.
	ServiceType EnhancedDataFleetServiceType `json:"service_type"`
	// The vehicle number entered into at the terminal at the time of sale, with
	// leading zeroes stripped.
	VehicleNumber string                `json:"vehicle_number"`
	JSON          enhancedDataFleetJSON `json:"-"`
}

func (*EnhancedDataFleet) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataFleet) UnmarshalJSON(data []byte) (err error)

type EnhancedDataFleetAmountTotals added in v0.39.0 

type EnhancedDataFleetAmountTotals struct {
	// The discount applied to the gross sale amount.
	Discount int64 `json:"discount"`
	// The gross sale amount.
	GrossSale int64 `json:"gross_sale"`
	// The amount after discount.
	NetSale int64                             `json:"net_sale"`
	JSON    enhancedDataFleetAmountTotalsJSON `json:"-"`
}

func (*EnhancedDataFleetAmountTotals) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataFleetAmountTotals) UnmarshalJSON(data []byte) (err error)

type EnhancedDataFleetFuel added in v0.39.0 

type EnhancedDataFleetFuel struct {
	// The quantity of fuel purchased.
	Quantity float64 `json:"quantity"`
	// The type of fuel purchased.
	Type EnhancedDataFleetFuelType `json:"type"`
	// Unit of measure for fuel disbursement.
	UnitOfMeasure EnhancedDataFleetFuelUnitOfMeasure `json:"unit_of_measure"`
	// The price per unit of fuel.
	UnitPrice int64                     `json:"unit_price"`
	JSON      enhancedDataFleetFuelJSON `json:"-"`
}

func (*EnhancedDataFleetFuel) UnmarshalJSON added in v0.39.0 

func (r *EnhancedDataFleetFuel) UnmarshalJSON(data []byte) (err error)

type EnhancedDataFleetFuelType added in v0.39.0 

type EnhancedDataFleetFuelType string

The type of fuel purchased. 

const (
	EnhancedDataFleetFuelTypeUnknown                                              EnhancedDataFleetFuelType = "UNKNOWN"
	EnhancedDataFleetFuelTypeRegular                                              EnhancedDataFleetFuelType = "REGULAR"
	EnhancedDataFleetFuelTypeMidPlus                                              EnhancedDataFleetFuelType = "MID_PLUS"
	EnhancedDataFleetFuelTypePremiumSuper                                         EnhancedDataFleetFuelType = "PREMIUM_SUPER"
	EnhancedDataFleetFuelTypeMidPlus2                                             EnhancedDataFleetFuelType = "MID_PLUS_2"
	EnhancedDataFleetFuelTypePremiumSuper2                                        EnhancedDataFleetFuelType = "PREMIUM_SUPER_2"
	EnhancedDataFleetFuelTypeEthanol5_7Blend                                      EnhancedDataFleetFuelType = "ETHANOL_5_7_BLEND"
	EnhancedDataFleetFuelTypeMidPlusEthanol5_7PercentBlend                        EnhancedDataFleetFuelType = "MID_PLUS_ETHANOL_5_7_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuperEthanol5_7PercentBlend                   EnhancedDataFleetFuelType = "PREMIUM_SUPER_ETHANOL_5_7_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeEthanol7_7PercentBlend                               EnhancedDataFleetFuelType = "ETHANOL_7_7_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeMidPlusEthanol7_7PercentBlend                        EnhancedDataFleetFuelType = "MID_PLUS_ETHANOL_7_7_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeGreenGasolineRegular                                 EnhancedDataFleetFuelType = "GREEN_GASOLINE_REGULAR"
	EnhancedDataFleetFuelTypeGreenGasolineMidPlus                                 EnhancedDataFleetFuelType = "GREEN_GASOLINE_MID_PLUS"
	EnhancedDataFleetFuelTypeGreenGasolinePremiumSuper                            EnhancedDataFleetFuelType = "GREEN_GASOLINE_PREMIUM_SUPER"
	EnhancedDataFleetFuelTypeRegularDiesel2                                       EnhancedDataFleetFuelType = "REGULAR_DIESEL_2"
	EnhancedDataFleetFuelTypePremiumDiesel2                                       EnhancedDataFleetFuelType = "PREMIUM_DIESEL_2"
	EnhancedDataFleetFuelTypeRegularDiesel1                                       EnhancedDataFleetFuelType = "REGULAR_DIESEL_1"
	EnhancedDataFleetFuelTypeCompressedNaturalGas                                 EnhancedDataFleetFuelType = "COMPRESSED_NATURAL_GAS"
	EnhancedDataFleetFuelTypeLiquidPropaneGas                                     EnhancedDataFleetFuelType = "LIQUID_PROPANE_GAS"
	EnhancedDataFleetFuelTypeLiquidNaturalGas                                     EnhancedDataFleetFuelType = "LIQUID_NATURAL_GAS"
	EnhancedDataFleetFuelTypeE85                                                  EnhancedDataFleetFuelType = "E_85"
	EnhancedDataFleetFuelTypeReformulated1                                        EnhancedDataFleetFuelType = "REFORMULATED_1"
	EnhancedDataFleetFuelTypeReformulated2                                        EnhancedDataFleetFuelType = "REFORMULATED_2"
	EnhancedDataFleetFuelTypeReformulated3                                        EnhancedDataFleetFuelType = "REFORMULATED_3"
	EnhancedDataFleetFuelTypeReformulated4                                        EnhancedDataFleetFuelType = "REFORMULATED_4"
	EnhancedDataFleetFuelTypeReformulated5                                        EnhancedDataFleetFuelType = "REFORMULATED_5"
	EnhancedDataFleetFuelTypeDieselOffRoad1And2NonTaxable                         EnhancedDataFleetFuelType = "DIESEL_OFF_ROAD_1_AND_2_NON_TAXABLE"
	EnhancedDataFleetFuelTypeDieselOffRoadNonTaxable                              EnhancedDataFleetFuelType = "DIESEL_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlendOffRoadNonTaxable                      EnhancedDataFleetFuelType = "BIODIESEL_BLEND_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeUndefinedFuel                                        EnhancedDataFleetFuelType = "UNDEFINED_FUEL"
	EnhancedDataFleetFuelTypeRacingFuel                                           EnhancedDataFleetFuelType = "RACING_FUEL"
	EnhancedDataFleetFuelTypeMidPlus2_10PercentBlend                              EnhancedDataFleetFuelType = "MID_PLUS_2_10_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuper2_10PercentBlend                         EnhancedDataFleetFuelType = "PREMIUM_SUPER_2_10_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeMidPlusEthanol2_15PercentBlend                       EnhancedDataFleetFuelType = "MID_PLUS_ETHANOL_2_15_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuperEthanol2_15PercentBlend                  EnhancedDataFleetFuelType = "PREMIUM_SUPER_ETHANOL_2_15_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuperEthanol7_7PercentBlend                   EnhancedDataFleetFuelType = "PREMIUM_SUPER_ETHANOL_7_7_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeRegularEthanol10PercentBlend                         EnhancedDataFleetFuelType = "REGULAR_ETHANOL_10_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeMidPlusEthanol10PercentBlend                         EnhancedDataFleetFuelType = "MID_PLUS_ETHANOL_10_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuperEthanol10PercentBlend                    EnhancedDataFleetFuelType = "PREMIUM_SUPER_ETHANOL_10_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeB2DieselBlend2PercentBiodiesel                       EnhancedDataFleetFuelType = "B2_DIESEL_BLEND_2_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB5DieselBlend5PercentBiodiesel                       EnhancedDataFleetFuelType = "B5_DIESEL_BLEND_5_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB10DieselBlend10PercentBiodiesel                     EnhancedDataFleetFuelType = "B10_DIESEL_BLEND_10_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB11DieselBlend11PercentBiodiesel                     EnhancedDataFleetFuelType = "B11_DIESEL_BLEND_11_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB15DieselBlend15PercentBiodiesel                     EnhancedDataFleetFuelType = "B15_DIESEL_BLEND_15_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB20DieselBlend20PercentBiodiesel                     EnhancedDataFleetFuelType = "B20_DIESEL_BLEND_20_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB100DieselBlend100PercentBiodiesel                   EnhancedDataFleetFuelType = "B100_DIESEL_BLEND_100_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB1DieselBlend1PercentBiodiesel                       EnhancedDataFleetFuelType = "B1_DIESEL_BLEND_1_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeAdditizedDiesel2                                     EnhancedDataFleetFuelType = "ADDITIZED_DIESEL_2"
	EnhancedDataFleetFuelTypeAdditizedDiesel3                                     EnhancedDataFleetFuelType = "ADDITIZED_DIESEL_3"
	EnhancedDataFleetFuelTypeRenewableDieselR95                                   EnhancedDataFleetFuelType = "RENEWABLE_DIESEL_R95"
	EnhancedDataFleetFuelTypeRenewableDieselBiodiesel6_20Percent                  EnhancedDataFleetFuelType = "RENEWABLE_DIESEL_BIODIESEL_6_20_PERCENT"
	EnhancedDataFleetFuelTypeDieselExhaustFluid                                   EnhancedDataFleetFuelType = "DIESEL_EXHAUST_FLUID"
	EnhancedDataFleetFuelTypePremiumDiesel1                                       EnhancedDataFleetFuelType = "PREMIUM_DIESEL_1"
	EnhancedDataFleetFuelTypeRegularEthanol15PercentBlend                         EnhancedDataFleetFuelType = "REGULAR_ETHANOL_15_PERCENT_BLEND"
	EnhancedDataFleetFuelTypeMidPlusEthanol15PercentBlend                         EnhancedDataFleetFuelType = "MID_PLUS_ETHANOL_15_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumSuperEthanol15PercentBlend                    EnhancedDataFleetFuelType = "PREMIUM_SUPER_ETHANOL_15_PERCENT_BLEND"
	EnhancedDataFleetFuelTypePremiumDieselBlendLessThan20PercentBiodiesel         EnhancedDataFleetFuelType = "PREMIUM_DIESEL_BLEND_LESS_THAN_20_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypePremiumDieselBlendGreaterThan20PercentBiodiesel      EnhancedDataFleetFuelType = "PREMIUM_DIESEL_BLEND_GREATER_THAN_20_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB75DieselBlend75PercentBiodiesel                     EnhancedDataFleetFuelType = "B75_DIESEL_BLEND_75_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeB99DieselBlend99PercentBiodiesel                     EnhancedDataFleetFuelType = "B99_DIESEL_BLEND_99_PERCENT_BIODIESEL"
	EnhancedDataFleetFuelTypeMiscellaneousFuel                                    EnhancedDataFleetFuelType = "MISCELLANEOUS_FUEL"
	EnhancedDataFleetFuelTypeJetFuel                                              EnhancedDataFleetFuelType = "JET_FUEL"
	EnhancedDataFleetFuelTypeAviationFuelRegular                                  EnhancedDataFleetFuelType = "AVIATION_FUEL_REGULAR"
	EnhancedDataFleetFuelTypeAviationFuelPremium                                  EnhancedDataFleetFuelType = "AVIATION_FUEL_PREMIUM"
	EnhancedDataFleetFuelTypeAviationFuelJp8                                      EnhancedDataFleetFuelType = "AVIATION_FUEL_JP8"
	EnhancedDataFleetFuelTypeAviationFuel4                                        EnhancedDataFleetFuelType = "AVIATION_FUEL_4"
	EnhancedDataFleetFuelTypeAviationFuel5                                        EnhancedDataFleetFuelType = "AVIATION_FUEL_5"
	EnhancedDataFleetFuelTypeBiojetDiesel                                         EnhancedDataFleetFuelType = "BIOJET_DIESEL"
	EnhancedDataFleetFuelTypeAviationBiofuelGasoline                              EnhancedDataFleetFuelType = "AVIATION_BIOFUEL_GASOLINE"
	EnhancedDataFleetFuelTypeMiscellaneousAviationFuel                            EnhancedDataFleetFuelType = "MISCELLANEOUS_AVIATION_FUEL"
	EnhancedDataFleetFuelTypeMarineFuel1                                          EnhancedDataFleetFuelType = "MARINE_FUEL_1"
	EnhancedDataFleetFuelTypeMarineFuel2                                          EnhancedDataFleetFuelType = "MARINE_FUEL_2"
	EnhancedDataFleetFuelTypeMarineFuel3                                          EnhancedDataFleetFuelType = "MARINE_FUEL_3"
	EnhancedDataFleetFuelTypeMarineFuel4                                          EnhancedDataFleetFuelType = "MARINE_FUEL_4"
	EnhancedDataFleetFuelTypeMarineFuel5                                          EnhancedDataFleetFuelType = "MARINE_FUEL_5"
	EnhancedDataFleetFuelTypeMarineOther                                          EnhancedDataFleetFuelType = "MARINE_OTHER"
	EnhancedDataFleetFuelTypeMarineDiesel                                         EnhancedDataFleetFuelType = "MARINE_DIESEL"
	EnhancedDataFleetFuelTypeMiscellaneousMarineFuel                              EnhancedDataFleetFuelType = "MISCELLANEOUS_MARINE_FUEL"
	EnhancedDataFleetFuelTypeKeroseneLowSulfur                                    EnhancedDataFleetFuelType = "KEROSENE_LOW_SULFUR"
	EnhancedDataFleetFuelTypeWhiteGas                                             EnhancedDataFleetFuelType = "WHITE_GAS"
	EnhancedDataFleetFuelTypeHeatingOil                                           EnhancedDataFleetFuelType = "HEATING_OIL"
	EnhancedDataFleetFuelTypeOtherFuelNonTaxable                                  EnhancedDataFleetFuelType = "OTHER_FUEL_NON_TAXABLE"
	EnhancedDataFleetFuelTypeKeroseneUltraLowSulfur                               EnhancedDataFleetFuelType = "KEROSENE_ULTRA_LOW_SULFUR"
	EnhancedDataFleetFuelTypeKeroseneLowSulfurNonTaxable                          EnhancedDataFleetFuelType = "KEROSENE_LOW_SULFUR_NON_TAXABLE"
	EnhancedDataFleetFuelTypeKeroseneUltraLowSulfurNonTaxable                     EnhancedDataFleetFuelType = "KEROSENE_ULTRA_LOW_SULFUR_NON_TAXABLE"
	EnhancedDataFleetFuelTypeEvc1Level1Charge110V15Amp                            EnhancedDataFleetFuelType = "EVC_1_LEVEL_1_CHARGE_110V_15_AMP"
	EnhancedDataFleetFuelTypeEvc2Level2Charge240V15_40Amp                         EnhancedDataFleetFuelType = "EVC_2_LEVEL_2_CHARGE_240V_15_40_AMP"
	EnhancedDataFleetFuelTypeEvc3Level3Charge480V3PhaseCharge                     EnhancedDataFleetFuelType = "EVC_3_LEVEL_3_CHARGE_480V_3_PHASE_CHARGE"
	EnhancedDataFleetFuelTypeBiodieselBlend2PercentOffRoadNonTaxable              EnhancedDataFleetFuelType = "BIODIESEL_BLEND_2_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend5PercentOffRoadNonTaxable              EnhancedDataFleetFuelType = "BIODIESEL_BLEND_5_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend10PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_10_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend11PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_11_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend15PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_15_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend20PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_20_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeDiesel1OffRoadNonTaxable                             EnhancedDataFleetFuelType = "DIESEL_1_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeDiesel2OffRoadNonTaxable                             EnhancedDataFleetFuelType = "DIESEL_2_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeDiesel1PremiumOffRoadNonTaxable                      EnhancedDataFleetFuelType = "DIESEL_1_PREMIUM_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeDiesel2PremiumOffRoadNonTaxable                      EnhancedDataFleetFuelType = "DIESEL_2_PREMIUM_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeAdditiveDosage                                       EnhancedDataFleetFuelType = "ADDITIVE_DOSAGE"
	EnhancedDataFleetFuelTypeEthanolBlendsE16E84                                  EnhancedDataFleetFuelType = "ETHANOL_BLENDS_E16_E84"
	EnhancedDataFleetFuelTypeLowOctaneUnl                                         EnhancedDataFleetFuelType = "LOW_OCTANE_UNL"
	EnhancedDataFleetFuelTypeBlendedDiesel1And2                                   EnhancedDataFleetFuelType = "BLENDED_DIESEL_1_AND_2"
	EnhancedDataFleetFuelTypeOffRoadRegularNonTaxable                             EnhancedDataFleetFuelType = "OFF_ROAD_REGULAR_NON_TAXABLE"
	EnhancedDataFleetFuelTypeOffRoadMidPlusNonTaxable                             EnhancedDataFleetFuelType = "OFF_ROAD_MID_PLUS_NON_TAXABLE"
	EnhancedDataFleetFuelTypeOffRoadPremiumSuperNonTaxable                        EnhancedDataFleetFuelType = "OFF_ROAD_PREMIUM_SUPER_NON_TAXABLE"
	EnhancedDataFleetFuelTypeOffRoadMidPlus2NonTaxable                            EnhancedDataFleetFuelType = "OFF_ROAD_MID_PLUS_2_NON_TAXABLE"
	EnhancedDataFleetFuelTypeOffRoadPremiumSuper2NonTaxable                       EnhancedDataFleetFuelType = "OFF_ROAD_PREMIUM_SUPER_2_NON_TAXABLE"
	EnhancedDataFleetFuelTypeRecreationalFuel90Octane                             EnhancedDataFleetFuelType = "RECREATIONAL_FUEL_90_OCTANE"
	EnhancedDataFleetFuelTypeHydrogenH35                                          EnhancedDataFleetFuelType = "HYDROGEN_H35"
	EnhancedDataFleetFuelTypeHydrogenH70                                          EnhancedDataFleetFuelType = "HYDROGEN_H70"
	EnhancedDataFleetFuelTypeRenewableDieselR95OffRoadNonTaxable                  EnhancedDataFleetFuelType = "RENEWABLE_DIESEL_R95_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend1PercentOffRoadNonTaxable              EnhancedDataFleetFuelType = "BIODIESEL_BLEND_1_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend75PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_75_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend99PercentOffRoadNonTaxable             EnhancedDataFleetFuelType = "BIODIESEL_BLEND_99_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeBiodieselBlend100PercentOffRoadNonTaxable            EnhancedDataFleetFuelType = "BIODIESEL_BLEND_100_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeRenewableDieselBiodiesel6_20PercentOffRoadNonTaxable EnhancedDataFleetFuelType = "RENEWABLE_DIESEL_BIODIESEL_6_20_PERCENT_OFF_ROAD_NON_TAXABLE"
	EnhancedDataFleetFuelTypeMiscellaneousOtherFuel                               EnhancedDataFleetFuelType = "MISCELLANEOUS_OTHER_FUEL"
)

func (EnhancedDataFleetFuelType) IsKnown added in v0.39.0 

func (r EnhancedDataFleetFuelType) IsKnown() bool

type EnhancedDataFleetFuelUnitOfMeasure added in v0.39.0 

type EnhancedDataFleetFuelUnitOfMeasure string

Unit of measure for fuel disbursement. 

const (
	EnhancedDataFleetFuelUnitOfMeasureGallons         EnhancedDataFleetFuelUnitOfMeasure = "GALLONS"
	EnhancedDataFleetFuelUnitOfMeasureLiters          EnhancedDataFleetFuelUnitOfMeasure = "LITERS"
	EnhancedDataFleetFuelUnitOfMeasurePounds          EnhancedDataFleetFuelUnitOfMeasure = "POUNDS"
	EnhancedDataFleetFuelUnitOfMeasureKilograms       EnhancedDataFleetFuelUnitOfMeasure = "KILOGRAMS"
	EnhancedDataFleetFuelUnitOfMeasureImperialGallons EnhancedDataFleetFuelUnitOfMeasure = "IMPERIAL_GALLONS"
	EnhancedDataFleetFuelUnitOfMeasureNotApplicable   EnhancedDataFleetFuelUnitOfMeasure = "NOT_APPLICABLE"
	EnhancedDataFleetFuelUnitOfMeasureUnknown         EnhancedDataFleetFuelUnitOfMeasure = "UNKNOWN"
)

func (EnhancedDataFleetFuelUnitOfMeasure) IsKnown added in v0.39.0 

func (r EnhancedDataFleetFuelUnitOfMeasure) IsKnown() bool

type EnhancedDataFleetServiceType added in v0.39.0 

type EnhancedDataFleetServiceType string

The type of fuel service. 

const (
	EnhancedDataFleetServiceTypeUnknown     EnhancedDataFleetServiceType = "UNKNOWN"
	EnhancedDataFleetServiceTypeUndefined   EnhancedDataFleetServiceType = "UNDEFINED"
	EnhancedDataFleetServiceTypeSelfService EnhancedDataFleetServiceType = "SELF_SERVICE"
	EnhancedDataFleetServiceTypeFullService EnhancedDataFleetServiceType = "FULL_SERVICE"
	EnhancedDataFleetServiceTypeNonFuelOnly EnhancedDataFleetServiceType = "NON_FUEL_ONLY"
)

func (EnhancedDataFleetServiceType) IsKnown added in v0.39.0 

func (r EnhancedDataFleetServiceType) IsKnown() bool

type Error 

type Error = apierror.Error

type Event 

type Event struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// An RFC 3339 timestamp for when the event was created. UTC time zone.
	//
	// If no timezone is specified, UTC will be used.
	Created time.Time `json:"created,required" format:"date-time"`
	// Event types:
	//
	//   - `account_holder.created` - Notification that a new account holder has been
	//     created and was not rejected.
	//   - `account_holder.updated` - Notification that an account holder was updated.
	//   - `account_holder.verification` - Notification than an account holder's identity
	//     verification is complete.
	//   - `card.created` - Notification that a card has been created.
	//   - `card.renewed` - Notification that a card has been renewed.
	//   - `card.reissued` - Notification that a card has been reissued.
	//   - `card.shipped` - Physical card shipment notification. See
	//     https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
	//   - `card_transaction.updated` - Transaction Lifecycle webhook. See
	//     https://docs.lithic.com/docs/transaction-webhooks.
	//   - `dispute.updated` - A dispute has been updated.
	//   - `digital_wallet.tokenization_approval_request` - Card network's request to
	//     Lithic to activate a digital wallet token.
	//   - `digital_wallet.tokenization_result` - Notification of the end result of a
	//     tokenization, whether successful or failed.
	//   - `digital_wallet.tokenization_two_factor_authentication_code` - A code to be
	//     passed to an end user to complete digital wallet authentication. See
	//     https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
	//   - `digital_wallet.tokenization_two_factor_authentication_code_sent` -
	//     Notification that a two factor authentication code for activating a digital
	//     wallet has been sent to the end user.
	//   - `digital_wallet.tokenization_updated` - Notification that a digital wallet
	//     tokenization's status has changed.
	EventType EventEventType         `json:"event_type,required"`
	Payload   map[string]interface{} `json:"payload,required"`
	JSON      eventJSON              `json:"-"`
}

A single event that affects the transaction state and lifecycle.

func (*Event) UnmarshalJSON 

func (r *Event) UnmarshalJSON(data []byte) (err error)

type EventEventType 

type EventEventType string

Event types:

  • `account_holder.created` - Notification that a new account holder has been created and was not rejected.
  • `account_holder.updated` - Notification that an account holder was updated.
  • `account_holder.verification` - Notification than an account holder's identity verification is complete.
  • `card.created` - Notification that a card has been created.
  • `card.renewed` - Notification that a card has been renewed.
  • `card.reissued` - Notification that a card has been reissued.
  • `card.shipped` - Physical card shipment notification. See https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
  • `card_transaction.updated` - Transaction Lifecycle webhook. See https://docs.lithic.com/docs/transaction-webhooks.
  • `dispute.updated` - A dispute has been updated.
  • `digital_wallet.tokenization_approval_request` - Card network's request to Lithic to activate a digital wallet token.
  • `digital_wallet.tokenization_result` - Notification of the end result of a tokenization, whether successful or failed.
  • `digital_wallet.tokenization_two_factor_authentication_code` - A code to be passed to an end user to complete digital wallet authentication. See https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
  • `digital_wallet.tokenization_two_factor_authentication_code_sent` - Notification that a two factor authentication code for activating a digital wallet has been sent to the end user.
  • `digital_wallet.tokenization_updated` - Notification that a digital wallet tokenization's status has changed.
const (
	EventEventTypeAccountHolderCreated                                     EventEventType = "account_holder.created"
	EventEventTypeAccountHolderUpdated                                     EventEventType = "account_holder.updated"
	EventEventTypeAccountHolderVerification                                EventEventType = "account_holder.verification"
	EventEventTypeAuthRulesPerformanceReportCreated                        EventEventType = "auth_rules.performance_report.created"
	EventEventTypeBalanceUpdated                                           EventEventType = "balance.updated"
	EventEventTypeBookTransferTransactionCreated                           EventEventType = "book_transfer_transaction.created"
	EventEventTypeCardCreated                                              EventEventType = "card.created"
	EventEventTypeCardRenewed                                              EventEventType = "card.renewed"
	EventEventTypeCardReissued                                             EventEventType = "card.reissued"
	EventEventTypeCardShipped                                              EventEventType = "card.shipped"
	EventEventTypeCardTransactionUpdated                                   EventEventType = "card_transaction.updated"
	EventEventTypeDigitalWalletTokenizationApprovalRequest                 EventEventType = "digital_wallet.tokenization_approval_request"
	EventEventTypeDigitalWalletTokenizationResult                          EventEventType = "digital_wallet.tokenization_result"
	EventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventEventTypeDigitalWalletTokenizationUpdated                         EventEventType = "digital_wallet.tokenization_updated"
	EventEventTypeDisputeUpdated                                           EventEventType = "dispute.updated"
	EventEventTypeDisputeEvidenceUploadFailed                              EventEventType = "dispute_evidence.upload_failed"
	EventEventTypeExternalBankAccountCreated                               EventEventType = "external_bank_account.created"
	EventEventTypeExternalBankAccountUpdated                               EventEventType = "external_bank_account.updated"
	EventEventTypeExternalPaymentCreated                                   EventEventType = "external_payment.created"
	EventEventTypeExternalPaymentUpdated                                   EventEventType = "external_payment.updated"
	EventEventTypeFinancialAccountCreated                                  EventEventType = "financial_account.created"
	EventEventTypeFinancialAccountUpdated                                  EventEventType = "financial_account.updated"
	EventEventTypeLoanTapeCreated                                          EventEventType = "loan_tape.created"
	EventEventTypeLoanTapeUpdated                                          EventEventType = "loan_tape.updated"
	EventEventTypeManagementOperationCreated                               EventEventType = "management_operation.created"
	EventEventTypeManagementOperationUpdated                               EventEventType = "management_operation.updated"
	EventEventTypePaymentTransactionCreated                                EventEventType = "payment_transaction.created"
	EventEventTypePaymentTransactionUpdated                                EventEventType = "payment_transaction.updated"
	EventEventTypeSettlementReportUpdated                                  EventEventType = "settlement_report.updated"
	EventEventTypeStatementsCreated                                        EventEventType = "statements.created"
	EventEventTypeThreeDSAuthenticationCreated                             EventEventType = "three_ds_authentication.created"
	EventEventTypeTokenizationApprovalRequest                              EventEventType = "tokenization.approval_request"
	EventEventTypeTokenizationResult                                       EventEventType = "tokenization.result"
	EventEventTypeTokenizationTwoFactorAuthenticationCode                  EventEventType = "tokenization.two_factor_authentication_code"
	EventEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventEventType = "tokenization.two_factor_authentication_code_sent"
	EventEventTypeTokenizationUpdated                                      EventEventType = "tokenization.updated"
)

func (EventEventType) IsKnown added in v0.27.0 

func (r EventEventType) IsKnown() bool

type EventListAttemptsParams added in v0.6.3 

type EventListAttemptsParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string]                        `query:"starting_after"`
	Status        param.Field[EventListAttemptsParamsStatus] `query:"status"`
}

func (EventListAttemptsParams) URLQuery added in v0.6.3 

func (r EventListAttemptsParams) URLQuery() (v url.Values)

URLQuery serializes EventListAttemptsParams's query parameters as `url.Values`.

type EventListAttemptsParamsStatus added in v0.6.3 

type EventListAttemptsParamsStatus string
const (
	EventListAttemptsParamsStatusFailed  EventListAttemptsParamsStatus = "FAILED"
	EventListAttemptsParamsStatusPending EventListAttemptsParamsStatus = "PENDING"
	EventListAttemptsParamsStatusSending EventListAttemptsParamsStatus = "SENDING"
	EventListAttemptsParamsStatusSuccess EventListAttemptsParamsStatus = "SUCCESS"
)

func (EventListAttemptsParamsStatus) IsKnown added in v0.27.0 

func (r EventListAttemptsParamsStatus) IsKnown() bool

type EventListParams 

type EventListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Event types to filter events by.
	EventTypes param.Field[[]EventListParamsEventType] `query:"event_types"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Whether to include the event payload content in the response.
	WithContent param.Field[bool] `query:"with_content"`
}

func (EventListParams) URLQuery 

func (r EventListParams) URLQuery() (v url.Values)

URLQuery serializes EventListParams's query parameters as `url.Values`.

type EventListParamsEventType added in v0.5.0 

type EventListParamsEventType string
const (
	EventListParamsEventTypeAccountHolderCreated                                     EventListParamsEventType = "account_holder.created"
	EventListParamsEventTypeAccountHolderUpdated                                     EventListParamsEventType = "account_holder.updated"
	EventListParamsEventTypeAccountHolderVerification                                EventListParamsEventType = "account_holder.verification"
	EventListParamsEventTypeAuthRulesPerformanceReportCreated                        EventListParamsEventType = "auth_rules.performance_report.created"
	EventListParamsEventTypeBalanceUpdated                                           EventListParamsEventType = "balance.updated"
	EventListParamsEventTypeBookTransferTransactionCreated                           EventListParamsEventType = "book_transfer_transaction.created"
	EventListParamsEventTypeCardCreated                                              EventListParamsEventType = "card.created"
	EventListParamsEventTypeCardRenewed                                              EventListParamsEventType = "card.renewed"
	EventListParamsEventTypeCardReissued                                             EventListParamsEventType = "card.reissued"
	EventListParamsEventTypeCardShipped                                              EventListParamsEventType = "card.shipped"
	EventListParamsEventTypeCardTransactionUpdated                                   EventListParamsEventType = "card_transaction.updated"
	EventListParamsEventTypeDigitalWalletTokenizationApprovalRequest                 EventListParamsEventType = "digital_wallet.tokenization_approval_request"
	EventListParamsEventTypeDigitalWalletTokenizationResult                          EventListParamsEventType = "digital_wallet.tokenization_result"
	EventListParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventListParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventListParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventListParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventListParamsEventTypeDigitalWalletTokenizationUpdated                         EventListParamsEventType = "digital_wallet.tokenization_updated"
	EventListParamsEventTypeDisputeUpdated                                           EventListParamsEventType = "dispute.updated"
	EventListParamsEventTypeDisputeEvidenceUploadFailed                              EventListParamsEventType = "dispute_evidence.upload_failed"
	EventListParamsEventTypeExternalBankAccountCreated                               EventListParamsEventType = "external_bank_account.created"
	EventListParamsEventTypeExternalBankAccountUpdated                               EventListParamsEventType = "external_bank_account.updated"
	EventListParamsEventTypeExternalPaymentCreated                                   EventListParamsEventType = "external_payment.created"
	EventListParamsEventTypeExternalPaymentUpdated                                   EventListParamsEventType = "external_payment.updated"
	EventListParamsEventTypeFinancialAccountCreated                                  EventListParamsEventType = "financial_account.created"
	EventListParamsEventTypeFinancialAccountUpdated                                  EventListParamsEventType = "financial_account.updated"
	EventListParamsEventTypeLoanTapeCreated                                          EventListParamsEventType = "loan_tape.created"
	EventListParamsEventTypeLoanTapeUpdated                                          EventListParamsEventType = "loan_tape.updated"
	EventListParamsEventTypeManagementOperationCreated                               EventListParamsEventType = "management_operation.created"
	EventListParamsEventTypeManagementOperationUpdated                               EventListParamsEventType = "management_operation.updated"
	EventListParamsEventTypePaymentTransactionCreated                                EventListParamsEventType = "payment_transaction.created"
	EventListParamsEventTypePaymentTransactionUpdated                                EventListParamsEventType = "payment_transaction.updated"
	EventListParamsEventTypeSettlementReportUpdated                                  EventListParamsEventType = "settlement_report.updated"
	EventListParamsEventTypeStatementsCreated                                        EventListParamsEventType = "statements.created"
	EventListParamsEventTypeThreeDSAuthenticationCreated                             EventListParamsEventType = "three_ds_authentication.created"
	EventListParamsEventTypeTokenizationApprovalRequest                              EventListParamsEventType = "tokenization.approval_request"
	EventListParamsEventTypeTokenizationResult                                       EventListParamsEventType = "tokenization.result"
	EventListParamsEventTypeTokenizationTwoFactorAuthenticationCode                  EventListParamsEventType = "tokenization.two_factor_authentication_code"
	EventListParamsEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventListParamsEventType = "tokenization.two_factor_authentication_code_sent"
	EventListParamsEventTypeTokenizationUpdated                                      EventListParamsEventType = "tokenization.updated"
)

func (EventListParamsEventType) IsKnown added in v0.27.0 

func (r EventListParamsEventType) IsKnown() bool

type EventService 

type EventService struct {
	Options       []option.RequestOption
	Subscriptions *EventSubscriptionService
}

EventService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEventService method instead.

func NewEventService 

func NewEventService(opts ...option.RequestOption) (r *EventService)

NewEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EventService) Get 

func (r *EventService) Get(ctx context.Context, eventToken string, opts ...option.RequestOption) (res *Event, err error)

Get an event.

func (*EventService) List 

func (r *EventService) List(ctx context.Context, query EventListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Event], err error)

List all events.

func (*EventService) ListAttempts added in v0.6.3 

func (r *EventService) ListAttempts(ctx context.Context, eventToken string, query EventListAttemptsParams, opts ...option.RequestOption) (res *pagination.CursorPage[MessageAttempt], err error)

List all the message attempts for a given event.

func (*EventService) ListAttemptsAutoPaging added in v0.6.3 

func (r *EventService) ListAttemptsAutoPaging(ctx context.Context, eventToken string, query EventListAttemptsParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[MessageAttempt]

List all the message attempts for a given event.

func (*EventService) ListAutoPaging 

func (r *EventService) ListAutoPaging(ctx context.Context, query EventListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Event]

List all events.

type EventSubscription 

type EventSubscription struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// A description of the subscription.
	Description string `json:"description,required"`
	// Whether the subscription is disabled.
	Disabled   bool                         `json:"disabled,required"`
	URL        string                       `json:"url,required" format:"uri"`
	EventTypes []EventSubscriptionEventType `json:"event_types,nullable"`
	JSON       eventSubscriptionJSON        `json:"-"`
}

A subscription to specific event types.

func (*EventSubscription) UnmarshalJSON 

func (r *EventSubscription) UnmarshalJSON(data []byte) (err error)

type EventSubscriptionEventType added in v0.5.0 

type EventSubscriptionEventType string
const (
	EventSubscriptionEventTypeAccountHolderCreated                                     EventSubscriptionEventType = "account_holder.created"
	EventSubscriptionEventTypeAccountHolderUpdated                                     EventSubscriptionEventType = "account_holder.updated"
	EventSubscriptionEventTypeAccountHolderVerification                                EventSubscriptionEventType = "account_holder.verification"
	EventSubscriptionEventTypeAuthRulesPerformanceReportCreated                        EventSubscriptionEventType = "auth_rules.performance_report.created"
	EventSubscriptionEventTypeBalanceUpdated                                           EventSubscriptionEventType = "balance.updated"
	EventSubscriptionEventTypeBookTransferTransactionCreated                           EventSubscriptionEventType = "book_transfer_transaction.created"
	EventSubscriptionEventTypeCardCreated                                              EventSubscriptionEventType = "card.created"
	EventSubscriptionEventTypeCardRenewed                                              EventSubscriptionEventType = "card.renewed"
	EventSubscriptionEventTypeCardReissued                                             EventSubscriptionEventType = "card.reissued"
	EventSubscriptionEventTypeCardShipped                                              EventSubscriptionEventType = "card.shipped"
	EventSubscriptionEventTypeCardTransactionUpdated                                   EventSubscriptionEventType = "card_transaction.updated"
	EventSubscriptionEventTypeDigitalWalletTokenizationApprovalRequest                 EventSubscriptionEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionEventTypeDigitalWalletTokenizationResult                          EventSubscriptionEventType = "digital_wallet.tokenization_result"
	EventSubscriptionEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventSubscriptionEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventSubscriptionEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventSubscriptionEventTypeDigitalWalletTokenizationUpdated                         EventSubscriptionEventType = "digital_wallet.tokenization_updated"
	EventSubscriptionEventTypeDisputeUpdated                                           EventSubscriptionEventType = "dispute.updated"
	EventSubscriptionEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionEventType = "dispute_evidence.upload_failed"
	EventSubscriptionEventTypeExternalBankAccountCreated                               EventSubscriptionEventType = "external_bank_account.created"
	EventSubscriptionEventTypeExternalBankAccountUpdated                               EventSubscriptionEventType = "external_bank_account.updated"
	EventSubscriptionEventTypeExternalPaymentCreated                                   EventSubscriptionEventType = "external_payment.created"
	EventSubscriptionEventTypeExternalPaymentUpdated                                   EventSubscriptionEventType = "external_payment.updated"
	EventSubscriptionEventTypeFinancialAccountCreated                                  EventSubscriptionEventType = "financial_account.created"
	EventSubscriptionEventTypeFinancialAccountUpdated                                  EventSubscriptionEventType = "financial_account.updated"
	EventSubscriptionEventTypeLoanTapeCreated                                          EventSubscriptionEventType = "loan_tape.created"
	EventSubscriptionEventTypeLoanTapeUpdated                                          EventSubscriptionEventType = "loan_tape.updated"
	EventSubscriptionEventTypeManagementOperationCreated                               EventSubscriptionEventType = "management_operation.created"
	EventSubscriptionEventTypeManagementOperationUpdated                               EventSubscriptionEventType = "management_operation.updated"
	EventSubscriptionEventTypePaymentTransactionCreated                                EventSubscriptionEventType = "payment_transaction.created"
	EventSubscriptionEventTypePaymentTransactionUpdated                                EventSubscriptionEventType = "payment_transaction.updated"
	EventSubscriptionEventTypeSettlementReportUpdated                                  EventSubscriptionEventType = "settlement_report.updated"
	EventSubscriptionEventTypeStatementsCreated                                        EventSubscriptionEventType = "statements.created"
	EventSubscriptionEventTypeThreeDSAuthenticationCreated                             EventSubscriptionEventType = "three_ds_authentication.created"
	EventSubscriptionEventTypeTokenizationApprovalRequest                              EventSubscriptionEventType = "tokenization.approval_request"
	EventSubscriptionEventTypeTokenizationResult                                       EventSubscriptionEventType = "tokenization.result"
	EventSubscriptionEventTypeTokenizationTwoFactorAuthenticationCode                  EventSubscriptionEventType = "tokenization.two_factor_authentication_code"
	EventSubscriptionEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventSubscriptionEventType = "tokenization.two_factor_authentication_code_sent"
	EventSubscriptionEventTypeTokenizationUpdated                                      EventSubscriptionEventType = "tokenization.updated"
)

func (EventSubscriptionEventType) IsKnown added in v0.27.0 

func (r EventSubscriptionEventType) IsKnown() bool

type EventSubscriptionGetSecretResponse added in v0.5.0 

type EventSubscriptionGetSecretResponse struct {
	// The secret for the event subscription.
	Secret string                                 `json:"secret"`
	JSON   eventSubscriptionGetSecretResponseJSON `json:"-"`
}

func (*EventSubscriptionGetSecretResponse) UnmarshalJSON added in v0.5.0 

func (r *EventSubscriptionGetSecretResponse) UnmarshalJSON(data []byte) (err error)

type EventSubscriptionListAttemptsParams added in v0.6.3 

type EventSubscriptionListAttemptsParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string]                                    `query:"starting_after"`
	Status        param.Field[EventSubscriptionListAttemptsParamsStatus] `query:"status"`
}

func (EventSubscriptionListAttemptsParams) URLQuery added in v0.6.3 

func (r EventSubscriptionListAttemptsParams) URLQuery() (v url.Values)

URLQuery serializes EventSubscriptionListAttemptsParams's query parameters as `url.Values`.

type EventSubscriptionListAttemptsParamsStatus added in v0.6.3 

type EventSubscriptionListAttemptsParamsStatus string
const (
	EventSubscriptionListAttemptsParamsStatusFailed  EventSubscriptionListAttemptsParamsStatus = "FAILED"
	EventSubscriptionListAttemptsParamsStatusPending EventSubscriptionListAttemptsParamsStatus = "PENDING"
	EventSubscriptionListAttemptsParamsStatusSending EventSubscriptionListAttemptsParamsStatus = "SENDING"
	EventSubscriptionListAttemptsParamsStatusSuccess EventSubscriptionListAttemptsParamsStatus = "SUCCESS"
)

func (EventSubscriptionListAttemptsParamsStatus) IsKnown added in v0.27.0 

func (r EventSubscriptionListAttemptsParamsStatus) IsKnown() bool

type EventSubscriptionListParams 

type EventSubscriptionListParams struct {
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (EventSubscriptionListParams) URLQuery 

func (r EventSubscriptionListParams) URLQuery() (v url.Values)

URLQuery serializes EventSubscriptionListParams's query parameters as `url.Values`.

type EventSubscriptionNewParams 

type EventSubscriptionNewParams struct {
	// URL to which event webhooks will be sent. URL must be a valid HTTPS address.
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Event subscription description.
	Description param.Field[string] `json:"description"`
	// Whether the event subscription is active (false) or inactive (true).
	Disabled param.Field[bool] `json:"disabled"`
	// Indicates types of events that will be sent to this subscription. If left blank,
	// all types will be sent.
	EventTypes param.Field[[]EventSubscriptionNewParamsEventType] `json:"event_types"`
}

func (EventSubscriptionNewParams) MarshalJSON 

func (r EventSubscriptionNewParams) MarshalJSON() (data []byte, err error)

type EventSubscriptionNewParamsEventType added in v0.5.0 

type EventSubscriptionNewParamsEventType string
const (
	EventSubscriptionNewParamsEventTypeAccountHolderCreated                                     EventSubscriptionNewParamsEventType = "account_holder.created"
	EventSubscriptionNewParamsEventTypeAccountHolderUpdated                                     EventSubscriptionNewParamsEventType = "account_holder.updated"
	EventSubscriptionNewParamsEventTypeAccountHolderVerification                                EventSubscriptionNewParamsEventType = "account_holder.verification"
	EventSubscriptionNewParamsEventTypeAuthRulesPerformanceReportCreated                        EventSubscriptionNewParamsEventType = "auth_rules.performance_report.created"
	EventSubscriptionNewParamsEventTypeBalanceUpdated                                           EventSubscriptionNewParamsEventType = "balance.updated"
	EventSubscriptionNewParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionNewParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionNewParamsEventTypeCardCreated                                              EventSubscriptionNewParamsEventType = "card.created"
	EventSubscriptionNewParamsEventTypeCardRenewed                                              EventSubscriptionNewParamsEventType = "card.renewed"
	EventSubscriptionNewParamsEventTypeCardReissued                                             EventSubscriptionNewParamsEventType = "card.reissued"
	EventSubscriptionNewParamsEventTypeCardShipped                                              EventSubscriptionNewParamsEventType = "card.shipped"
	EventSubscriptionNewParamsEventTypeCardTransactionUpdated                                   EventSubscriptionNewParamsEventType = "card_transaction.updated"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationApprovalRequest                 EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationResult                          EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationUpdated                         EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_updated"
	EventSubscriptionNewParamsEventTypeDisputeUpdated                                           EventSubscriptionNewParamsEventType = "dispute.updated"
	EventSubscriptionNewParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionNewParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionNewParamsEventTypeExternalBankAccountCreated                               EventSubscriptionNewParamsEventType = "external_bank_account.created"
	EventSubscriptionNewParamsEventTypeExternalBankAccountUpdated                               EventSubscriptionNewParamsEventType = "external_bank_account.updated"
	EventSubscriptionNewParamsEventTypeExternalPaymentCreated                                   EventSubscriptionNewParamsEventType = "external_payment.created"
	EventSubscriptionNewParamsEventTypeExternalPaymentUpdated                                   EventSubscriptionNewParamsEventType = "external_payment.updated"
	EventSubscriptionNewParamsEventTypeFinancialAccountCreated                                  EventSubscriptionNewParamsEventType = "financial_account.created"
	EventSubscriptionNewParamsEventTypeFinancialAccountUpdated                                  EventSubscriptionNewParamsEventType = "financial_account.updated"
	EventSubscriptionNewParamsEventTypeLoanTapeCreated                                          EventSubscriptionNewParamsEventType = "loan_tape.created"
	EventSubscriptionNewParamsEventTypeLoanTapeUpdated                                          EventSubscriptionNewParamsEventType = "loan_tape.updated"
	EventSubscriptionNewParamsEventTypeManagementOperationCreated                               EventSubscriptionNewParamsEventType = "management_operation.created"
	EventSubscriptionNewParamsEventTypeManagementOperationUpdated                               EventSubscriptionNewParamsEventType = "management_operation.updated"
	EventSubscriptionNewParamsEventTypePaymentTransactionCreated                                EventSubscriptionNewParamsEventType = "payment_transaction.created"
	EventSubscriptionNewParamsEventTypePaymentTransactionUpdated                                EventSubscriptionNewParamsEventType = "payment_transaction.updated"
	EventSubscriptionNewParamsEventTypeSettlementReportUpdated                                  EventSubscriptionNewParamsEventType = "settlement_report.updated"
	EventSubscriptionNewParamsEventTypeStatementsCreated                                        EventSubscriptionNewParamsEventType = "statements.created"
	EventSubscriptionNewParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionNewParamsEventType = "three_ds_authentication.created"
	EventSubscriptionNewParamsEventTypeTokenizationApprovalRequest                              EventSubscriptionNewParamsEventType = "tokenization.approval_request"
	EventSubscriptionNewParamsEventTypeTokenizationResult                                       EventSubscriptionNewParamsEventType = "tokenization.result"
	EventSubscriptionNewParamsEventTypeTokenizationTwoFactorAuthenticationCode                  EventSubscriptionNewParamsEventType = "tokenization.two_factor_authentication_code"
	EventSubscriptionNewParamsEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventSubscriptionNewParamsEventType = "tokenization.two_factor_authentication_code_sent"
	EventSubscriptionNewParamsEventTypeTokenizationUpdated                                      EventSubscriptionNewParamsEventType = "tokenization.updated"
)

func (EventSubscriptionNewParamsEventType) IsKnown added in v0.27.0 

func (r EventSubscriptionNewParamsEventType) IsKnown() bool

type EventSubscriptionRecoverParams 

type EventSubscriptionRecoverParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
}

func (EventSubscriptionRecoverParams) URLQuery 

func (r EventSubscriptionRecoverParams) URLQuery() (v url.Values)

URLQuery serializes EventSubscriptionRecoverParams's query parameters as `url.Values`.

type EventSubscriptionReplayMissingParams 

type EventSubscriptionReplayMissingParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
}

func (EventSubscriptionReplayMissingParams) URLQuery 

func (r EventSubscriptionReplayMissingParams) URLQuery() (v url.Values)

URLQuery serializes EventSubscriptionReplayMissingParams's query parameters as `url.Values`.

type EventSubscriptionSendSimulatedExampleParams added in v0.7.4 

type EventSubscriptionSendSimulatedExampleParams struct {
	// Event type to send example message for.
	EventType param.Field[EventSubscriptionSendSimulatedExampleParamsEventType] `json:"event_type"`
}

func (EventSubscriptionSendSimulatedExampleParams) MarshalJSON added in v0.7.4 

func (r EventSubscriptionSendSimulatedExampleParams) MarshalJSON() (data []byte, err error)

type EventSubscriptionSendSimulatedExampleParamsEventType added in v0.7.4 

type EventSubscriptionSendSimulatedExampleParamsEventType string

Event type to send example message for. 

const (
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderCreated                                     EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderUpdated                                     EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderVerification                                EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.verification"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAuthRulesPerformanceReportCreated                        EventSubscriptionSendSimulatedExampleParamsEventType = "auth_rules.performance_report.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBalanceUpdated                                           EventSubscriptionSendSimulatedExampleParamsEventType = "balance.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionSendSimulatedExampleParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardCreated                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardRenewed                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.renewed"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardReissued                                             EventSubscriptionSendSimulatedExampleParamsEventType = "card.reissued"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardShipped                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.shipped"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardTransactionUpdated                                   EventSubscriptionSendSimulatedExampleParamsEventType = "card_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationApprovalRequest                 EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationResult                          EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationUpdated                         EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeUpdated                                           EventSubscriptionSendSimulatedExampleParamsEventType = "dispute.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionSendSimulatedExampleParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionSendSimulatedExampleParamsEventTypeExternalBankAccountCreated                               EventSubscriptionSendSimulatedExampleParamsEventType = "external_bank_account.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeExternalBankAccountUpdated                               EventSubscriptionSendSimulatedExampleParamsEventType = "external_bank_account.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeExternalPaymentCreated                                   EventSubscriptionSendSimulatedExampleParamsEventType = "external_payment.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeExternalPaymentUpdated                                   EventSubscriptionSendSimulatedExampleParamsEventType = "external_payment.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeFinancialAccountCreated                                  EventSubscriptionSendSimulatedExampleParamsEventType = "financial_account.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeFinancialAccountUpdated                                  EventSubscriptionSendSimulatedExampleParamsEventType = "financial_account.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeLoanTapeCreated                                          EventSubscriptionSendSimulatedExampleParamsEventType = "loan_tape.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeLoanTapeUpdated                                          EventSubscriptionSendSimulatedExampleParamsEventType = "loan_tape.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeManagementOperationCreated                               EventSubscriptionSendSimulatedExampleParamsEventType = "management_operation.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeManagementOperationUpdated                               EventSubscriptionSendSimulatedExampleParamsEventType = "management_operation.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionCreated                                EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionUpdated                                EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeSettlementReportUpdated                                  EventSubscriptionSendSimulatedExampleParamsEventType = "settlement_report.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeStatementsCreated                                        EventSubscriptionSendSimulatedExampleParamsEventType = "statements.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionSendSimulatedExampleParamsEventType = "three_ds_authentication.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTokenizationApprovalRequest                              EventSubscriptionSendSimulatedExampleParamsEventType = "tokenization.approval_request"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTokenizationResult                                       EventSubscriptionSendSimulatedExampleParamsEventType = "tokenization.result"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTokenizationTwoFactorAuthenticationCode                  EventSubscriptionSendSimulatedExampleParamsEventType = "tokenization.two_factor_authentication_code"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventSubscriptionSendSimulatedExampleParamsEventType = "tokenization.two_factor_authentication_code_sent"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTokenizationUpdated                                      EventSubscriptionSendSimulatedExampleParamsEventType = "tokenization.updated"
)

func (EventSubscriptionSendSimulatedExampleParamsEventType) IsKnown added in v0.27.0 

func (r EventSubscriptionSendSimulatedExampleParamsEventType) IsKnown() bool

type EventSubscriptionService 

type EventSubscriptionService struct {
	Options []option.RequestOption
}

EventSubscriptionService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEventSubscriptionService method instead.

func NewEventSubscriptionService 

func NewEventSubscriptionService(opts ...option.RequestOption) (r *EventSubscriptionService)

NewEventSubscriptionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EventSubscriptionService) Delete 

func (r *EventSubscriptionService) Delete(ctx context.Context, eventSubscriptionToken string, opts ...option.RequestOption) (err error)

Delete an event subscription.

func (*EventSubscriptionService) Get 

func (r *EventSubscriptionService) Get(ctx context.Context, eventSubscriptionToken string, opts ...option.RequestOption) (res *EventSubscription, err error)

Get an event subscription.

func (*EventSubscriptionService) GetSecret 

func (r *EventSubscriptionService) GetSecret(ctx context.Context, eventSubscriptionToken string, opts ...option.RequestOption) (res *EventSubscriptionGetSecretResponse, err error)

Get the secret for an event subscription.

func (*EventSubscriptionService) List 

func (r *EventSubscriptionService) List(ctx context.Context, query EventSubscriptionListParams, opts ...option.RequestOption) (res *pagination.CursorPage[EventSubscription], err error)

List all the event subscriptions.

func (*EventSubscriptionService) ListAttempts added in v0.6.3 

func (r *EventSubscriptionService) ListAttempts(ctx context.Context, eventSubscriptionToken string, query EventSubscriptionListAttemptsParams, opts ...option.RequestOption) (res *pagination.CursorPage[MessageAttempt], err error)

List all the message attempts for a given event subscription.

func (*EventSubscriptionService) ListAttemptsAutoPaging added in v0.6.3 

func (r *EventSubscriptionService) ListAttemptsAutoPaging(ctx context.Context, eventSubscriptionToken string, query EventSubscriptionListAttemptsParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[MessageAttempt]

List all the message attempts for a given event subscription.

func (*EventSubscriptionService) ListAutoPaging 

func (r *EventSubscriptionService) ListAutoPaging(ctx context.Context, query EventSubscriptionListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[EventSubscription]

List all the event subscriptions.

func (*EventSubscriptionService) New 

func (r *EventSubscriptionService) New(ctx context.Context, body EventSubscriptionNewParams, opts ...option.RequestOption) (res *EventSubscription, err error)

Create a new event subscription.

func (*EventSubscriptionService) Recover 

func (r *EventSubscriptionService) Recover(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionRecoverParams, opts ...option.RequestOption) (err error)

Resend all failed messages since a given time.

func (*EventSubscriptionService) ReplayMissing 

func (r *EventSubscriptionService) ReplayMissing(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionReplayMissingParams, opts ...option.RequestOption) (err error)

Replays messages to the endpoint. Only messages that were created after `begin` will be sent. Messages that were previously sent to the endpoint are not resent. Message will be retried if endpoint responds with a non-2xx status code. See [Retry Schedule](https://docs.lithic.com/docs/events-api#retry-schedule) for details.

func (*EventSubscriptionService) RotateSecret 

func (r *EventSubscriptionService) RotateSecret(ctx context.Context, eventSubscriptionToken string, opts ...option.RequestOption) (err error)

Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.

func (*EventSubscriptionService) SendSimulatedExample added in v0.7.4 

func (r *EventSubscriptionService) SendSimulatedExample(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionSendSimulatedExampleParams, opts ...option.RequestOption) (err error)

Send an example message for event.

func (*EventSubscriptionService) Update 

func (r *EventSubscriptionService) Update(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionUpdateParams, opts ...option.RequestOption) (res *EventSubscription, err error)

Update an event subscription.

type EventSubscriptionUpdateParams 

type EventSubscriptionUpdateParams struct {
	// URL to which event webhooks will be sent. URL must be a valid HTTPS address.
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Event subscription description.
	Description param.Field[string] `json:"description"`
	// Whether the event subscription is active (false) or inactive (true).
	Disabled param.Field[bool] `json:"disabled"`
	// Indicates types of events that will be sent to this subscription. If left blank,
	// all types will be sent.
	EventTypes param.Field[[]EventSubscriptionUpdateParamsEventType] `json:"event_types"`
}

func (EventSubscriptionUpdateParams) MarshalJSON 

func (r EventSubscriptionUpdateParams) MarshalJSON() (data []byte, err error)

type EventSubscriptionUpdateParamsEventType added in v0.5.0 

type EventSubscriptionUpdateParamsEventType string
const (
	EventSubscriptionUpdateParamsEventTypeAccountHolderCreated                                     EventSubscriptionUpdateParamsEventType = "account_holder.created"
	EventSubscriptionUpdateParamsEventTypeAccountHolderUpdated                                     EventSubscriptionUpdateParamsEventType = "account_holder.updated"
	EventSubscriptionUpdateParamsEventTypeAccountHolderVerification                                EventSubscriptionUpdateParamsEventType = "account_holder.verification"
	EventSubscriptionUpdateParamsEventTypeAuthRulesPerformanceReportCreated                        EventSubscriptionUpdateParamsEventType = "auth_rules.performance_report.created"
	EventSubscriptionUpdateParamsEventTypeBalanceUpdated                                           EventSubscriptionUpdateParamsEventType = "balance.updated"
	EventSubscriptionUpdateParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionUpdateParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionUpdateParamsEventTypeCardCreated                                              EventSubscriptionUpdateParamsEventType = "card.created"
	EventSubscriptionUpdateParamsEventTypeCardRenewed                                              EventSubscriptionUpdateParamsEventType = "card.renewed"
	EventSubscriptionUpdateParamsEventTypeCardReissued                                             EventSubscriptionUpdateParamsEventType = "card.reissued"
	EventSubscriptionUpdateParamsEventTypeCardShipped                                              EventSubscriptionUpdateParamsEventType = "card.shipped"
	EventSubscriptionUpdateParamsEventTypeCardTransactionUpdated                                   EventSubscriptionUpdateParamsEventType = "card_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationApprovalRequest                 EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationResult                          EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationUpdated                         EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_updated"
	EventSubscriptionUpdateParamsEventTypeDisputeUpdated                                           EventSubscriptionUpdateParamsEventType = "dispute.updated"
	EventSubscriptionUpdateParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionUpdateParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionUpdateParamsEventTypeExternalBankAccountCreated                               EventSubscriptionUpdateParamsEventType = "external_bank_account.created"
	EventSubscriptionUpdateParamsEventTypeExternalBankAccountUpdated                               EventSubscriptionUpdateParamsEventType = "external_bank_account.updated"
	EventSubscriptionUpdateParamsEventTypeExternalPaymentCreated                                   EventSubscriptionUpdateParamsEventType = "external_payment.created"
	EventSubscriptionUpdateParamsEventTypeExternalPaymentUpdated                                   EventSubscriptionUpdateParamsEventType = "external_payment.updated"
	EventSubscriptionUpdateParamsEventTypeFinancialAccountCreated                                  EventSubscriptionUpdateParamsEventType = "financial_account.created"
	EventSubscriptionUpdateParamsEventTypeFinancialAccountUpdated                                  EventSubscriptionUpdateParamsEventType = "financial_account.updated"
	EventSubscriptionUpdateParamsEventTypeLoanTapeCreated                                          EventSubscriptionUpdateParamsEventType = "loan_tape.created"
	EventSubscriptionUpdateParamsEventTypeLoanTapeUpdated                                          EventSubscriptionUpdateParamsEventType = "loan_tape.updated"
	EventSubscriptionUpdateParamsEventTypeManagementOperationCreated                               EventSubscriptionUpdateParamsEventType = "management_operation.created"
	EventSubscriptionUpdateParamsEventTypeManagementOperationUpdated                               EventSubscriptionUpdateParamsEventType = "management_operation.updated"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionCreated                                EventSubscriptionUpdateParamsEventType = "payment_transaction.created"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionUpdated                                EventSubscriptionUpdateParamsEventType = "payment_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeSettlementReportUpdated                                  EventSubscriptionUpdateParamsEventType = "settlement_report.updated"
	EventSubscriptionUpdateParamsEventTypeStatementsCreated                                        EventSubscriptionUpdateParamsEventType = "statements.created"
	EventSubscriptionUpdateParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionUpdateParamsEventType = "three_ds_authentication.created"
	EventSubscriptionUpdateParamsEventTypeTokenizationApprovalRequest                              EventSubscriptionUpdateParamsEventType = "tokenization.approval_request"
	EventSubscriptionUpdateParamsEventTypeTokenizationResult                                       EventSubscriptionUpdateParamsEventType = "tokenization.result"
	EventSubscriptionUpdateParamsEventTypeTokenizationTwoFactorAuthenticationCode                  EventSubscriptionUpdateParamsEventType = "tokenization.two_factor_authentication_code"
	EventSubscriptionUpdateParamsEventTypeTokenizationTwoFactorAuthenticationCodeSent              EventSubscriptionUpdateParamsEventType = "tokenization.two_factor_authentication_code_sent"
	EventSubscriptionUpdateParamsEventTypeTokenizationUpdated                                      EventSubscriptionUpdateParamsEventType = "tokenization.updated"
)

func (EventSubscriptionUpdateParamsEventType) IsKnown added in v0.27.0 

func (r EventSubscriptionUpdateParamsEventType) IsKnown() bool

type ExtendedCredit added in v0.50.1 

type ExtendedCredit struct {
	CreditExtended int64              `json:"credit_extended,required"`
	JSON           extendedCreditJSON `json:"-"`
}

func (*ExtendedCredit) UnmarshalJSON added in v0.50.1 

func (r *ExtendedCredit) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountAddress added in v0.6.5 

type ExternalBankAccountAddress struct {
	Address1   string                         `json:"address1,required"`
	City       string                         `json:"city,required"`
	Country    string                         `json:"country,required"`
	PostalCode string                         `json:"postal_code,required"`
	State      string                         `json:"state,required"`
	Address2   string                         `json:"address2"`
	JSON       externalBankAccountAddressJSON `json:"-"`
}

func (*ExternalBankAccountAddress) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountAddress) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountAddressParam added in v0.6.5 

type ExternalBankAccountAddressParam struct {
	Address1   param.Field[string] `json:"address1,required"`
	City       param.Field[string] `json:"city,required"`
	Country    param.Field[string] `json:"country,required"`
	PostalCode param.Field[string] `json:"postal_code,required"`
	State      param.Field[string] `json:"state,required"`
	Address2   param.Field[string] `json:"address2"`
}

func (ExternalBankAccountAddressParam) MarshalJSON added in v0.6.5 

func (r ExternalBankAccountAddressParam) MarshalJSON() (data []byte, err error)

type ExternalBankAccountGetResponse added in v0.6.5 

type ExternalBankAccountGetResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountGetResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountGetResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountGetResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountGetResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountGetResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                             `json:"verification_failed_reason"`
	JSON                     externalBankAccountGetResponseJSON `json:"-"`
}

func (*ExternalBankAccountGetResponse) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountGetResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountGetResponseOwnerType added in v0.6.5 

type ExternalBankAccountGetResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountGetResponseOwnerTypeBusiness   ExternalBankAccountGetResponseOwnerType = "BUSINESS"
	ExternalBankAccountGetResponseOwnerTypeIndividual ExternalBankAccountGetResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountGetResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountGetResponseOwnerType) IsKnown() bool

type ExternalBankAccountGetResponseState added in v0.6.5 

type ExternalBankAccountGetResponseState string

Account State 

const (
	ExternalBankAccountGetResponseStateEnabled ExternalBankAccountGetResponseState = "ENABLED"
	ExternalBankAccountGetResponseStateClosed  ExternalBankAccountGetResponseState = "CLOSED"
	ExternalBankAccountGetResponseStatePaused  ExternalBankAccountGetResponseState = "PAUSED"
)

func (ExternalBankAccountGetResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountGetResponseState) IsKnown() bool

type ExternalBankAccountGetResponseType added in v0.6.5 

type ExternalBankAccountGetResponseType string

Account Type 

const (
	ExternalBankAccountGetResponseTypeChecking ExternalBankAccountGetResponseType = "CHECKING"
	ExternalBankAccountGetResponseTypeSavings  ExternalBankAccountGetResponseType = "SAVINGS"
)

func (ExternalBankAccountGetResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountGetResponseType) IsKnown() bool

type ExternalBankAccountGetResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountGetResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountGetResponseVerificationMethodManual       ExternalBankAccountGetResponseVerificationMethod = "MANUAL"
	ExternalBankAccountGetResponseVerificationMethodMicroDeposit ExternalBankAccountGetResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountGetResponseVerificationMethodPlaid        ExternalBankAccountGetResponseVerificationMethod = "PLAID"
	ExternalBankAccountGetResponseVerificationMethodPrenote      ExternalBankAccountGetResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountGetResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountGetResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountGetResponseVerificationState added in v0.6.5 

type ExternalBankAccountGetResponseVerificationState string

Verification State 

const (
	ExternalBankAccountGetResponseVerificationStatePending            ExternalBankAccountGetResponseVerificationState = "PENDING"
	ExternalBankAccountGetResponseVerificationStateEnabled            ExternalBankAccountGetResponseVerificationState = "ENABLED"
	ExternalBankAccountGetResponseVerificationStateFailedVerification ExternalBankAccountGetResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountGetResponseVerificationStateInsufficientFunds  ExternalBankAccountGetResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountGetResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountGetResponseVerificationState) IsKnown() bool

type ExternalBankAccountListParams added in v0.6.5 

type ExternalBankAccountListParams struct {
	AccountToken param.Field[string]                                     `query:"account_token" format:"uuid"`
	AccountTypes param.Field[[]ExternalBankAccountListParamsAccountType] `query:"account_types"`
	Countries    param.Field[[]string]                                   `query:"countries"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string]      `query:"ending_before"`
	OwnerTypes   param.Field[[]OwnerType] `query:"owner_types"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter      param.Field[string]                                           `query:"starting_after"`
	States             param.Field[[]ExternalBankAccountListParamsState]             `query:"states"`
	VerificationStates param.Field[[]ExternalBankAccountListParamsVerificationState] `query:"verification_states"`
}

func (ExternalBankAccountListParams) URLQuery added in v0.6.5 

func (r ExternalBankAccountListParams) URLQuery() (v url.Values)

URLQuery serializes ExternalBankAccountListParams's query parameters as `url.Values`.

type ExternalBankAccountListParamsAccountType added in v0.6.5 

type ExternalBankAccountListParamsAccountType string
const (
	ExternalBankAccountListParamsAccountTypeChecking ExternalBankAccountListParamsAccountType = "CHECKING"
	ExternalBankAccountListParamsAccountTypeSavings  ExternalBankAccountListParamsAccountType = "SAVINGS"
)

func (ExternalBankAccountListParamsAccountType) IsKnown added in v0.27.0 

func (r ExternalBankAccountListParamsAccountType) IsKnown() bool

type ExternalBankAccountListParamsState added in v0.6.5 

type ExternalBankAccountListParamsState string
const (
	ExternalBankAccountListParamsStateEnabled ExternalBankAccountListParamsState = "ENABLED"
	ExternalBankAccountListParamsStateClosed  ExternalBankAccountListParamsState = "CLOSED"
	ExternalBankAccountListParamsStatePaused  ExternalBankAccountListParamsState = "PAUSED"
)

func (ExternalBankAccountListParamsState) IsKnown added in v0.27.0 

func (r ExternalBankAccountListParamsState) IsKnown() bool

type ExternalBankAccountListParamsVerificationState added in v0.6.5 

type ExternalBankAccountListParamsVerificationState string
const (
	ExternalBankAccountListParamsVerificationStatePending            ExternalBankAccountListParamsVerificationState = "PENDING"
	ExternalBankAccountListParamsVerificationStateEnabled            ExternalBankAccountListParamsVerificationState = "ENABLED"
	ExternalBankAccountListParamsVerificationStateFailedVerification ExternalBankAccountListParamsVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountListParamsVerificationStateInsufficientFunds  ExternalBankAccountListParamsVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountListParamsVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountListParamsVerificationState) IsKnown() bool

type ExternalBankAccountListResponse added in v0.6.5 

type ExternalBankAccountListResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountListResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountListResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountListResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountListResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountListResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                              `json:"verification_failed_reason"`
	JSON                     externalBankAccountListResponseJSON `json:"-"`
}

func (*ExternalBankAccountListResponse) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountListResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountListResponseOwnerType added in v0.6.5 

type ExternalBankAccountListResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountListResponseOwnerTypeBusiness   ExternalBankAccountListResponseOwnerType = "BUSINESS"
	ExternalBankAccountListResponseOwnerTypeIndividual ExternalBankAccountListResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountListResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountListResponseOwnerType) IsKnown() bool

type ExternalBankAccountListResponseState added in v0.6.5 

type ExternalBankAccountListResponseState string

Account State 

const (
	ExternalBankAccountListResponseStateEnabled ExternalBankAccountListResponseState = "ENABLED"
	ExternalBankAccountListResponseStateClosed  ExternalBankAccountListResponseState = "CLOSED"
	ExternalBankAccountListResponseStatePaused  ExternalBankAccountListResponseState = "PAUSED"
)

func (ExternalBankAccountListResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountListResponseState) IsKnown() bool

type ExternalBankAccountListResponseType added in v0.6.5 

type ExternalBankAccountListResponseType string

Account Type 

const (
	ExternalBankAccountListResponseTypeChecking ExternalBankAccountListResponseType = "CHECKING"
	ExternalBankAccountListResponseTypeSavings  ExternalBankAccountListResponseType = "SAVINGS"
)

func (ExternalBankAccountListResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountListResponseType) IsKnown() bool

type ExternalBankAccountListResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountListResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountListResponseVerificationMethodManual       ExternalBankAccountListResponseVerificationMethod = "MANUAL"
	ExternalBankAccountListResponseVerificationMethodMicroDeposit ExternalBankAccountListResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountListResponseVerificationMethodPlaid        ExternalBankAccountListResponseVerificationMethod = "PLAID"
	ExternalBankAccountListResponseVerificationMethodPrenote      ExternalBankAccountListResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountListResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountListResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountListResponseVerificationState added in v0.6.5 

type ExternalBankAccountListResponseVerificationState string

Verification State 

const (
	ExternalBankAccountListResponseVerificationStatePending            ExternalBankAccountListResponseVerificationState = "PENDING"
	ExternalBankAccountListResponseVerificationStateEnabled            ExternalBankAccountListResponseVerificationState = "ENABLED"
	ExternalBankAccountListResponseVerificationStateFailedVerification ExternalBankAccountListResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountListResponseVerificationStateInsufficientFunds  ExternalBankAccountListResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountListResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountListResponseVerificationState) IsKnown() bool

type ExternalBankAccountMicroDepositNewParams added in v0.6.5 

type ExternalBankAccountMicroDepositNewParams struct {
	MicroDeposits param.Field[[]int64] `json:"micro_deposits,required"`
}

func (ExternalBankAccountMicroDepositNewParams) MarshalJSON added in v0.6.5 

func (r ExternalBankAccountMicroDepositNewParams) MarshalJSON() (data []byte, err error)

type ExternalBankAccountMicroDepositNewResponse added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountMicroDepositNewResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountMicroDepositNewResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountMicroDepositNewResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountMicroDepositNewResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountMicroDepositNewResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                         `json:"verification_failed_reason"`
	JSON                     externalBankAccountMicroDepositNewResponseJSON `json:"-"`
}

func (*ExternalBankAccountMicroDepositNewResponse) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountMicroDepositNewResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountMicroDepositNewResponseOwnerType added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountMicroDepositNewResponseOwnerTypeBusiness   ExternalBankAccountMicroDepositNewResponseOwnerType = "BUSINESS"
	ExternalBankAccountMicroDepositNewResponseOwnerTypeIndividual ExternalBankAccountMicroDepositNewResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountMicroDepositNewResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountMicroDepositNewResponseOwnerType) IsKnown() bool

type ExternalBankAccountMicroDepositNewResponseState added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseState string

Account State 

const (
	ExternalBankAccountMicroDepositNewResponseStateEnabled ExternalBankAccountMicroDepositNewResponseState = "ENABLED"
	ExternalBankAccountMicroDepositNewResponseStateClosed  ExternalBankAccountMicroDepositNewResponseState = "CLOSED"
	ExternalBankAccountMicroDepositNewResponseStatePaused  ExternalBankAccountMicroDepositNewResponseState = "PAUSED"
)

func (ExternalBankAccountMicroDepositNewResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountMicroDepositNewResponseState) IsKnown() bool

type ExternalBankAccountMicroDepositNewResponseType added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseType string

Account Type 

const (
	ExternalBankAccountMicroDepositNewResponseTypeChecking ExternalBankAccountMicroDepositNewResponseType = "CHECKING"
	ExternalBankAccountMicroDepositNewResponseTypeSavings  ExternalBankAccountMicroDepositNewResponseType = "SAVINGS"
)

func (ExternalBankAccountMicroDepositNewResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountMicroDepositNewResponseType) IsKnown() bool

type ExternalBankAccountMicroDepositNewResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountMicroDepositNewResponseVerificationMethodManual       ExternalBankAccountMicroDepositNewResponseVerificationMethod = "MANUAL"
	ExternalBankAccountMicroDepositNewResponseVerificationMethodMicroDeposit ExternalBankAccountMicroDepositNewResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountMicroDepositNewResponseVerificationMethodPlaid        ExternalBankAccountMicroDepositNewResponseVerificationMethod = "PLAID"
	ExternalBankAccountMicroDepositNewResponseVerificationMethodPrenote      ExternalBankAccountMicroDepositNewResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountMicroDepositNewResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountMicroDepositNewResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountMicroDepositNewResponseVerificationState added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseVerificationState string

Verification State 

const (
	ExternalBankAccountMicroDepositNewResponseVerificationStatePending            ExternalBankAccountMicroDepositNewResponseVerificationState = "PENDING"
	ExternalBankAccountMicroDepositNewResponseVerificationStateEnabled            ExternalBankAccountMicroDepositNewResponseVerificationState = "ENABLED"
	ExternalBankAccountMicroDepositNewResponseVerificationStateFailedVerification ExternalBankAccountMicroDepositNewResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountMicroDepositNewResponseVerificationStateInsufficientFunds  ExternalBankAccountMicroDepositNewResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountMicroDepositNewResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountMicroDepositNewResponseVerificationState) IsKnown() bool

type ExternalBankAccountMicroDepositService added in v0.6.5 

type ExternalBankAccountMicroDepositService struct {
	Options []option.RequestOption
}

ExternalBankAccountMicroDepositService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewExternalBankAccountMicroDepositService method instead.

func NewExternalBankAccountMicroDepositService added in v0.6.5 

func NewExternalBankAccountMicroDepositService(opts ...option.RequestOption) (r *ExternalBankAccountMicroDepositService)

NewExternalBankAccountMicroDepositService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ExternalBankAccountMicroDepositService) New added in v0.6.5 

func (r *ExternalBankAccountMicroDepositService) New(ctx context.Context, externalBankAccountToken string, body ExternalBankAccountMicroDepositNewParams, opts ...option.RequestOption) (res *ExternalBankAccountMicroDepositNewResponse, err error)

Verify the external bank account by providing the micro deposit amounts.

type ExternalBankAccountNewParams added in v0.6.5 

type ExternalBankAccountNewParams struct {
	Body ExternalBankAccountNewParamsBodyUnion `json:"body,required"`
}

func (ExternalBankAccountNewParams) MarshalJSON added in v0.29.0 

func (r ExternalBankAccountNewParams) MarshalJSON() (data []byte, err error)

type ExternalBankAccountNewParamsBody added in v0.29.0 

type ExternalBankAccountNewParamsBody struct {
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner param.Field[string] `json:"owner,required"`
	// Owner Type
	OwnerType param.Field[OwnerType] `json:"owner_type,required"`
	// Verification Method
	VerificationMethod param.Field[VerificationMethod] `json:"verification_method,required"`
	// Account Number
	AccountNumber param.Field[string] `json:"account_number"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken param.Field[string] `json:"account_token" format:"uuid"`
	// Address
	Address param.Field[ExternalBankAccountAddressParam] `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID param.Field[string] `json:"company_id"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country param.Field[string] `json:"country"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency param.Field[string] `json:"currency"`
	// Date of Birth of the Individual that owns the external bank account
	Dob param.Field[time.Time] `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs param.Field[string] `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken param.Field[string] `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name           param.Field[string] `json:"name"`
	ProcessorToken param.Field[string] `json:"processor_token"`
	// Routing Number
	RoutingNumber param.Field[string] `json:"routing_number"`
	// Account Type
	Type param.Field[ExternalBankAccountNewParamsBodyType] `json:"type"`
	// User Defined ID
	UserDefinedID           param.Field[string] `json:"user_defined_id"`
	VerificationEnforcement param.Field[bool]   `json:"verification_enforcement"`
}

func (ExternalBankAccountNewParamsBody) MarshalJSON added in v0.29.0 

func (r ExternalBankAccountNewParamsBody) MarshalJSON() (data []byte, err error)

type ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequest added in v0.29.0 

type ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequest struct {
	// Account Number
	AccountNumber param.Field[string] `json:"account_number,required"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country param.Field[string] `json:"country,required"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency param.Field[string] `json:"currency,required"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken param.Field[string] `json:"financial_account_token,required" format:"uuid"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner param.Field[string] `json:"owner,required"`
	// Owner Type
	OwnerType param.Field[OwnerType] `json:"owner_type,required"`
	// Routing Number
	RoutingNumber param.Field[string] `json:"routing_number,required"`
	// Account Type
	Type param.Field[ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType] `json:"type,required"`
	// Verification Method
	VerificationMethod param.Field[VerificationMethod] `json:"verification_method,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken param.Field[string] `json:"account_token" format:"uuid"`
	// Address
	Address param.Field[ExternalBankAccountAddressParam] `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID param.Field[string] `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob param.Field[time.Time] `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs param.Field[string] `json:"doing_business_as"`
	// The nickname for this External Bank Account
	Name param.Field[string] `json:"name"`
	// User Defined ID
	UserDefinedID           param.Field[string] `json:"user_defined_id"`
	VerificationEnforcement param.Field[bool]   `json:"verification_enforcement"`
}

func (ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequest) MarshalJSON added in v0.29.0 

func (r ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequest) MarshalJSON() (data []byte, err error)

type ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType added in v0.29.0 

type ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType string

Account Type 

const (
	ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestTypeChecking ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType = "CHECKING"
	ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestTypeSavings  ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType = "SAVINGS"
)

func (ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType) IsKnown added in v0.29.0 

func (r ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequestType) IsKnown() bool

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest added in v0.35.0 

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest struct {
	// Account Number
	AccountNumber param.Field[string] `json:"account_number,required"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country param.Field[string] `json:"country,required"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency param.Field[string] `json:"currency,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner param.Field[string] `json:"owner,required"`
	// Owner Type
	OwnerType param.Field[OwnerType] `json:"owner_type,required"`
	// Routing Number
	RoutingNumber param.Field[string] `json:"routing_number,required"`
	// Account Type
	Type param.Field[ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType] `json:"type,required"`
	// Verification Method
	VerificationMethod param.Field[ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod] `json:"verification_method,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken param.Field[string] `json:"account_token" format:"uuid"`
	// Address
	Address param.Field[ExternalBankAccountAddressParam] `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID param.Field[string] `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob param.Field[time.Time] `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs param.Field[string] `json:"doing_business_as"`
	// The nickname for this External Bank Account
	Name param.Field[string] `json:"name"`
	// User Defined ID
	UserDefinedID param.Field[string] `json:"user_defined_id"`
}

func (ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest) MarshalJSON added in v0.35.0 

func (r ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest) MarshalJSON() (data []byte, err error)

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType added in v0.35.0 

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType string

Account Type 

const (
	ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestTypeChecking ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType = "CHECKING"
	ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestTypeSavings  ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType = "SAVINGS"
)

func (ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType) IsKnown added in v0.35.0 

func (r ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestType) IsKnown() bool

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod added in v0.35.0 

type ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod string

Verification Method 

const (
	ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethodExternallyVerified ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod = "EXTERNALLY_VERIFIED"
)

func (ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod) IsKnown added in v0.35.0 

func (r ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequestVerificationMethod) IsKnown() bool

type ExternalBankAccountNewParamsBodyPlaidCreateBankAccountAPIRequest added in v0.29.0 

type ExternalBankAccountNewParamsBodyPlaidCreateBankAccountAPIRequest struct {
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner param.Field[string] `json:"owner,required"`
	// Owner Type
	OwnerType      param.Field[OwnerType] `json:"owner_type,required"`
	ProcessorToken param.Field[string]    `json:"processor_token,required"`
	// Verification Method
	VerificationMethod param.Field[VerificationMethod] `json:"verification_method,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken param.Field[string] `json:"account_token" format:"uuid"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID param.Field[string] `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob param.Field[time.Time] `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs param.Field[string] `json:"doing_business_as"`
	// User Defined ID
	UserDefinedID param.Field[string] `json:"user_defined_id"`
}

func (ExternalBankAccountNewParamsBodyPlaidCreateBankAccountAPIRequest) MarshalJSON added in v0.29.0 

func (r ExternalBankAccountNewParamsBodyPlaidCreateBankAccountAPIRequest) MarshalJSON() (data []byte, err error)

type ExternalBankAccountNewParamsBodyType added in v0.29.0 

type ExternalBankAccountNewParamsBodyType string

Account Type 

const (
	ExternalBankAccountNewParamsBodyTypeChecking ExternalBankAccountNewParamsBodyType = "CHECKING"
	ExternalBankAccountNewParamsBodyTypeSavings  ExternalBankAccountNewParamsBodyType = "SAVINGS"
)

func (ExternalBankAccountNewParamsBodyType) IsKnown added in v0.29.0 

func (r ExternalBankAccountNewParamsBodyType) IsKnown() bool

type ExternalBankAccountNewParamsBodyUnion added in v0.29.0 

type ExternalBankAccountNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by ExternalBankAccountNewParamsBodyBankVerifiedCreateBankAccountAPIRequest, ExternalBankAccountNewParamsBodyPlaidCreateBankAccountAPIRequest, ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest, ExternalBankAccountNewParamsBody.

type ExternalBankAccountNewResponse added in v0.6.5 

type ExternalBankAccountNewResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountNewResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountNewResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountNewResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountNewResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountNewResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                             `json:"verification_failed_reason"`
	JSON                     externalBankAccountNewResponseJSON `json:"-"`
}

func (*ExternalBankAccountNewResponse) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountNewResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountNewResponseOwnerType added in v0.6.5 

type ExternalBankAccountNewResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountNewResponseOwnerTypeBusiness   ExternalBankAccountNewResponseOwnerType = "BUSINESS"
	ExternalBankAccountNewResponseOwnerTypeIndividual ExternalBankAccountNewResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountNewResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountNewResponseOwnerType) IsKnown() bool

type ExternalBankAccountNewResponseState added in v0.6.5 

type ExternalBankAccountNewResponseState string

Account State 

const (
	ExternalBankAccountNewResponseStateEnabled ExternalBankAccountNewResponseState = "ENABLED"
	ExternalBankAccountNewResponseStateClosed  ExternalBankAccountNewResponseState = "CLOSED"
	ExternalBankAccountNewResponseStatePaused  ExternalBankAccountNewResponseState = "PAUSED"
)

func (ExternalBankAccountNewResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountNewResponseState) IsKnown() bool

type ExternalBankAccountNewResponseType added in v0.6.5 

type ExternalBankAccountNewResponseType string

Account Type 

const (
	ExternalBankAccountNewResponseTypeChecking ExternalBankAccountNewResponseType = "CHECKING"
	ExternalBankAccountNewResponseTypeSavings  ExternalBankAccountNewResponseType = "SAVINGS"
)

func (ExternalBankAccountNewResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountNewResponseType) IsKnown() bool

type ExternalBankAccountNewResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountNewResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountNewResponseVerificationMethodManual       ExternalBankAccountNewResponseVerificationMethod = "MANUAL"
	ExternalBankAccountNewResponseVerificationMethodMicroDeposit ExternalBankAccountNewResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountNewResponseVerificationMethodPlaid        ExternalBankAccountNewResponseVerificationMethod = "PLAID"
	ExternalBankAccountNewResponseVerificationMethodPrenote      ExternalBankAccountNewResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountNewResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountNewResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountNewResponseVerificationState added in v0.6.5 

type ExternalBankAccountNewResponseVerificationState string

Verification State 

const (
	ExternalBankAccountNewResponseVerificationStatePending            ExternalBankAccountNewResponseVerificationState = "PENDING"
	ExternalBankAccountNewResponseVerificationStateEnabled            ExternalBankAccountNewResponseVerificationState = "ENABLED"
	ExternalBankAccountNewResponseVerificationStateFailedVerification ExternalBankAccountNewResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountNewResponseVerificationStateInsufficientFunds  ExternalBankAccountNewResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountNewResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountNewResponseVerificationState) IsKnown() bool

type ExternalBankAccountRetryMicroDepositsParams added in v0.29.0 

type ExternalBankAccountRetryMicroDepositsParams struct {
	FinancialAccountToken param.Field[string] `json:"financial_account_token" format:"uuid"`
}

func (ExternalBankAccountRetryMicroDepositsParams) MarshalJSON added in v0.29.0 

func (r ExternalBankAccountRetryMicroDepositsParams) MarshalJSON() (data []byte, err error)

type ExternalBankAccountRetryMicroDepositsResponse added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountRetryMicroDepositsResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountRetryMicroDepositsResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountRetryMicroDepositsResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountRetryMicroDepositsResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountRetryMicroDepositsResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                            `json:"verification_failed_reason"`
	JSON                     externalBankAccountRetryMicroDepositsResponseJSON `json:"-"`
}

func (*ExternalBankAccountRetryMicroDepositsResponse) UnmarshalJSON added in v0.25.0 

func (r *ExternalBankAccountRetryMicroDepositsResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountRetryMicroDepositsResponseOwnerType added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountRetryMicroDepositsResponseOwnerTypeBusiness   ExternalBankAccountRetryMicroDepositsResponseOwnerType = "BUSINESS"
	ExternalBankAccountRetryMicroDepositsResponseOwnerTypeIndividual ExternalBankAccountRetryMicroDepositsResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountRetryMicroDepositsResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountRetryMicroDepositsResponseOwnerType) IsKnown() bool

type ExternalBankAccountRetryMicroDepositsResponseState added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponseState string

Account State 

const (
	ExternalBankAccountRetryMicroDepositsResponseStateEnabled ExternalBankAccountRetryMicroDepositsResponseState = "ENABLED"
	ExternalBankAccountRetryMicroDepositsResponseStateClosed  ExternalBankAccountRetryMicroDepositsResponseState = "CLOSED"
	ExternalBankAccountRetryMicroDepositsResponseStatePaused  ExternalBankAccountRetryMicroDepositsResponseState = "PAUSED"
)

func (ExternalBankAccountRetryMicroDepositsResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountRetryMicroDepositsResponseState) IsKnown() bool

type ExternalBankAccountRetryMicroDepositsResponseType added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponseType string

Account Type 

const (
	ExternalBankAccountRetryMicroDepositsResponseTypeChecking ExternalBankAccountRetryMicroDepositsResponseType = "CHECKING"
	ExternalBankAccountRetryMicroDepositsResponseTypeSavings  ExternalBankAccountRetryMicroDepositsResponseType = "SAVINGS"
)

func (ExternalBankAccountRetryMicroDepositsResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountRetryMicroDepositsResponseType) IsKnown() bool

type ExternalBankAccountRetryMicroDepositsResponseVerificationMethod added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountRetryMicroDepositsResponseVerificationMethodManual       ExternalBankAccountRetryMicroDepositsResponseVerificationMethod = "MANUAL"
	ExternalBankAccountRetryMicroDepositsResponseVerificationMethodMicroDeposit ExternalBankAccountRetryMicroDepositsResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountRetryMicroDepositsResponseVerificationMethodPlaid        ExternalBankAccountRetryMicroDepositsResponseVerificationMethod = "PLAID"
	ExternalBankAccountRetryMicroDepositsResponseVerificationMethodPrenote      ExternalBankAccountRetryMicroDepositsResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountRetryMicroDepositsResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountRetryMicroDepositsResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountRetryMicroDepositsResponseVerificationState added in v0.25.0 

type ExternalBankAccountRetryMicroDepositsResponseVerificationState string

Verification State 

const (
	ExternalBankAccountRetryMicroDepositsResponseVerificationStatePending            ExternalBankAccountRetryMicroDepositsResponseVerificationState = "PENDING"
	ExternalBankAccountRetryMicroDepositsResponseVerificationStateEnabled            ExternalBankAccountRetryMicroDepositsResponseVerificationState = "ENABLED"
	ExternalBankAccountRetryMicroDepositsResponseVerificationStateFailedVerification ExternalBankAccountRetryMicroDepositsResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountRetryMicroDepositsResponseVerificationStateInsufficientFunds  ExternalBankAccountRetryMicroDepositsResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountRetryMicroDepositsResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountRetryMicroDepositsResponseVerificationState) IsKnown() bool

type ExternalBankAccountRetryPrenoteParams added in v0.34.0 

type ExternalBankAccountRetryPrenoteParams struct {
	FinancialAccountToken param.Field[string] `json:"financial_account_token" format:"uuid"`
}

func (ExternalBankAccountRetryPrenoteParams) MarshalJSON added in v0.34.0 

func (r ExternalBankAccountRetryPrenoteParams) MarshalJSON() (data []byte, err error)

type ExternalBankAccountRetryPrenoteResponse added in v0.34.0 

type ExternalBankAccountRetryPrenoteResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType OwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountRetryPrenoteResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountRetryPrenoteResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod VerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountRetryPrenoteResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                      `json:"verification_failed_reason"`
	JSON                     externalBankAccountRetryPrenoteResponseJSON `json:"-"`
}

func (*ExternalBankAccountRetryPrenoteResponse) UnmarshalJSON added in v0.34.0 

func (r *ExternalBankAccountRetryPrenoteResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountRetryPrenoteResponseState added in v0.34.0 

type ExternalBankAccountRetryPrenoteResponseState string

Account State 

const (
	ExternalBankAccountRetryPrenoteResponseStateEnabled ExternalBankAccountRetryPrenoteResponseState = "ENABLED"
	ExternalBankAccountRetryPrenoteResponseStateClosed  ExternalBankAccountRetryPrenoteResponseState = "CLOSED"
	ExternalBankAccountRetryPrenoteResponseStatePaused  ExternalBankAccountRetryPrenoteResponseState = "PAUSED"
)

func (ExternalBankAccountRetryPrenoteResponseState) IsKnown added in v0.34.0 

func (r ExternalBankAccountRetryPrenoteResponseState) IsKnown() bool

type ExternalBankAccountRetryPrenoteResponseType added in v0.34.0 

type ExternalBankAccountRetryPrenoteResponseType string

Account Type 

const (
	ExternalBankAccountRetryPrenoteResponseTypeChecking ExternalBankAccountRetryPrenoteResponseType = "CHECKING"
	ExternalBankAccountRetryPrenoteResponseTypeSavings  ExternalBankAccountRetryPrenoteResponseType = "SAVINGS"
)

func (ExternalBankAccountRetryPrenoteResponseType) IsKnown added in v0.34.0 

func (r ExternalBankAccountRetryPrenoteResponseType) IsKnown() bool

type ExternalBankAccountRetryPrenoteResponseVerificationState added in v0.34.0 

type ExternalBankAccountRetryPrenoteResponseVerificationState string

Verification State 

const (
	ExternalBankAccountRetryPrenoteResponseVerificationStatePending            ExternalBankAccountRetryPrenoteResponseVerificationState = "PENDING"
	ExternalBankAccountRetryPrenoteResponseVerificationStateEnabled            ExternalBankAccountRetryPrenoteResponseVerificationState = "ENABLED"
	ExternalBankAccountRetryPrenoteResponseVerificationStateFailedVerification ExternalBankAccountRetryPrenoteResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountRetryPrenoteResponseVerificationStateInsufficientFunds  ExternalBankAccountRetryPrenoteResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountRetryPrenoteResponseVerificationState) IsKnown added in v0.34.0 

func (r ExternalBankAccountRetryPrenoteResponseVerificationState) IsKnown() bool

type ExternalBankAccountService added in v0.6.5 

type ExternalBankAccountService struct {
	Options       []option.RequestOption
	MicroDeposits *ExternalBankAccountMicroDepositService
}

ExternalBankAccountService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewExternalBankAccountService method instead.

func NewExternalBankAccountService added in v0.6.5 

func NewExternalBankAccountService(opts ...option.RequestOption) (r *ExternalBankAccountService)

NewExternalBankAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ExternalBankAccountService) Get added in v0.6.5 

func (r *ExternalBankAccountService) Get(ctx context.Context, externalBankAccountToken string, opts ...option.RequestOption) (res *ExternalBankAccountGetResponse, err error)

Get the external bank account by token.

func (*ExternalBankAccountService) List added in v0.6.5 

func (r *ExternalBankAccountService) List(ctx context.Context, query ExternalBankAccountListParams, opts ...option.RequestOption) (res *pagination.CursorPage[ExternalBankAccountListResponse], err error)

List all the external bank accounts for the provided search criteria.

func (*ExternalBankAccountService) ListAutoPaging added in v0.6.5 

func (r *ExternalBankAccountService) ListAutoPaging(ctx context.Context, query ExternalBankAccountListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[ExternalBankAccountListResponse]

List all the external bank accounts for the provided search criteria.

func (*ExternalBankAccountService) New added in v0.6.5 

func (r *ExternalBankAccountService) New(ctx context.Context, body ExternalBankAccountNewParams, opts ...option.RequestOption) (res *ExternalBankAccountNewResponse, err error)

Creates an external bank account within a program or Lithic account.

func (*ExternalBankAccountService) RetryMicroDeposits added in v0.25.0 

func (r *ExternalBankAccountService) RetryMicroDeposits(ctx context.Context, externalBankAccountToken string, body ExternalBankAccountRetryMicroDepositsParams, opts ...option.RequestOption) (res *ExternalBankAccountRetryMicroDepositsResponse, err error)

Retry external bank account micro deposit verification.

func (*ExternalBankAccountService) RetryPrenote added in v0.34.0 

func (r *ExternalBankAccountService) RetryPrenote(ctx context.Context, externalBankAccountToken string, body ExternalBankAccountRetryPrenoteParams, opts ...option.RequestOption) (res *ExternalBankAccountRetryPrenoteResponse, err error)

Retry external bank account prenote verification.

func (*ExternalBankAccountService) Update added in v0.6.5 

func (r *ExternalBankAccountService) Update(ctx context.Context, externalBankAccountToken string, body ExternalBankAccountUpdateParams, opts ...option.RequestOption) (res *ExternalBankAccountUpdateResponse, err error)

Update the external bank account by token.

type ExternalBankAccountUpdateParams added in v0.6.5 

type ExternalBankAccountUpdateParams struct {
	// Address
	Address param.Field[ExternalBankAccountAddressParam] `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID param.Field[string] `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob param.Field[time.Time] `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs param.Field[string] `json:"doing_business_as"`
	// The nickname for this External Bank Account
	Name param.Field[string] `json:"name"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner param.Field[string] `json:"owner"`
	// Owner Type
	OwnerType param.Field[OwnerType] `json:"owner_type"`
	// User Defined ID
	UserDefinedID param.Field[string] `json:"user_defined_id"`
}

func (ExternalBankAccountUpdateParams) MarshalJSON added in v0.6.5 

func (r ExternalBankAccountUpdateParams) MarshalJSON() (data []byte, err error)

type ExternalBankAccountUpdateResponse added in v0.6.5 

type ExternalBankAccountUpdateResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner,required"`
	// Owner Type
	OwnerType ExternalBankAccountUpdateResponseOwnerType `json:"owner_type,required"`
	// Routing Number
	RoutingNumber string `json:"routing_number,required"`
	// Account State
	State ExternalBankAccountUpdateResponseState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountUpdateResponseType `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts,required"`
	// Verification Method
	VerificationMethod ExternalBankAccountUpdateResponseVerificationMethod `json:"verification_method,required"`
	// Verification State
	VerificationState ExternalBankAccountUpdateResponseVerificationState `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                `json:"verification_failed_reason"`
	JSON                     externalBankAccountUpdateResponseJSON `json:"-"`
}

func (*ExternalBankAccountUpdateResponse) UnmarshalJSON added in v0.6.5 

func (r *ExternalBankAccountUpdateResponse) UnmarshalJSON(data []byte) (err error)

type ExternalBankAccountUpdateResponseOwnerType added in v0.6.5 

type ExternalBankAccountUpdateResponseOwnerType string

Owner Type 

const (
	ExternalBankAccountUpdateResponseOwnerTypeBusiness   ExternalBankAccountUpdateResponseOwnerType = "BUSINESS"
	ExternalBankAccountUpdateResponseOwnerTypeIndividual ExternalBankAccountUpdateResponseOwnerType = "INDIVIDUAL"
)

func (ExternalBankAccountUpdateResponseOwnerType) IsKnown added in v0.27.0 

func (r ExternalBankAccountUpdateResponseOwnerType) IsKnown() bool

type ExternalBankAccountUpdateResponseState added in v0.6.5 

type ExternalBankAccountUpdateResponseState string

Account State 

const (
	ExternalBankAccountUpdateResponseStateEnabled ExternalBankAccountUpdateResponseState = "ENABLED"
	ExternalBankAccountUpdateResponseStateClosed  ExternalBankAccountUpdateResponseState = "CLOSED"
	ExternalBankAccountUpdateResponseStatePaused  ExternalBankAccountUpdateResponseState = "PAUSED"
)

func (ExternalBankAccountUpdateResponseState) IsKnown added in v0.27.0 

func (r ExternalBankAccountUpdateResponseState) IsKnown() bool

type ExternalBankAccountUpdateResponseType added in v0.6.5 

type ExternalBankAccountUpdateResponseType string

Account Type 

const (
	ExternalBankAccountUpdateResponseTypeChecking ExternalBankAccountUpdateResponseType = "CHECKING"
	ExternalBankAccountUpdateResponseTypeSavings  ExternalBankAccountUpdateResponseType = "SAVINGS"
)

func (ExternalBankAccountUpdateResponseType) IsKnown added in v0.27.0 

func (r ExternalBankAccountUpdateResponseType) IsKnown() bool

type ExternalBankAccountUpdateResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountUpdateResponseVerificationMethod string

Verification Method 

const (
	ExternalBankAccountUpdateResponseVerificationMethodManual       ExternalBankAccountUpdateResponseVerificationMethod = "MANUAL"
	ExternalBankAccountUpdateResponseVerificationMethodMicroDeposit ExternalBankAccountUpdateResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountUpdateResponseVerificationMethodPlaid        ExternalBankAccountUpdateResponseVerificationMethod = "PLAID"
	ExternalBankAccountUpdateResponseVerificationMethodPrenote      ExternalBankAccountUpdateResponseVerificationMethod = "PRENOTE"
)

func (ExternalBankAccountUpdateResponseVerificationMethod) IsKnown added in v0.27.0 

func (r ExternalBankAccountUpdateResponseVerificationMethod) IsKnown() bool

type ExternalBankAccountUpdateResponseVerificationState added in v0.6.5 

type ExternalBankAccountUpdateResponseVerificationState string

Verification State 

const (
	ExternalBankAccountUpdateResponseVerificationStatePending            ExternalBankAccountUpdateResponseVerificationState = "PENDING"
	ExternalBankAccountUpdateResponseVerificationStateEnabled            ExternalBankAccountUpdateResponseVerificationState = "ENABLED"
	ExternalBankAccountUpdateResponseVerificationStateFailedVerification ExternalBankAccountUpdateResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountUpdateResponseVerificationStateInsufficientFunds  ExternalBankAccountUpdateResponseVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountUpdateResponseVerificationState) IsKnown added in v0.27.0 

func (r ExternalBankAccountUpdateResponseVerificationState) IsKnown() bool

type ExternalPayment added in v0.51.0 

type ExternalPayment struct {
	Token                 string                     `json:"token,required" format:"uuid"`
	Category              ExternalPaymentCategory    `json:"category,required"`
	Created               time.Time                  `json:"created,required" format:"date-time"`
	Currency              string                     `json:"currency,required"`
	Events                []ExternalPaymentEvent     `json:"events,required"`
	FinancialAccountToken string                     `json:"financial_account_token,required" format:"uuid"`
	PaymentType           ExternalPaymentPaymentType `json:"payment_type,required"`
	PendingAmount         int64                      `json:"pending_amount,required"`
	Result                ExternalPaymentResult      `json:"result,required"`
	SettledAmount         int64                      `json:"settled_amount,required"`
	Status                ExternalPaymentStatus      `json:"status,required"`
	Updated               time.Time                  `json:"updated,required" format:"date-time"`
	UserDefinedID         string                     `json:"user_defined_id"`
	JSON                  externalPaymentJSON        `json:"-"`
}

func (*ExternalPayment) UnmarshalJSON added in v0.51.0 

func (r *ExternalPayment) UnmarshalJSON(data []byte) (err error)

type ExternalPaymentCancelParams added in v0.51.0 

type ExternalPaymentCancelParams struct {
	EffectiveDate param.Field[time.Time] `json:"effective_date,required" format:"date"`
	Memo          param.Field[string]    `json:"memo"`
}

func (ExternalPaymentCancelParams) MarshalJSON added in v0.51.0 

func (r ExternalPaymentCancelParams) MarshalJSON() (data []byte, err error)

type ExternalPaymentCategory added in v0.51.0 

type ExternalPaymentCategory string
const (
	ExternalPaymentCategoryExternalWire     ExternalPaymentCategory = "EXTERNAL_WIRE"
	ExternalPaymentCategoryExternalACH      ExternalPaymentCategory = "EXTERNAL_ACH"
	ExternalPaymentCategoryExternalCheck    ExternalPaymentCategory = "EXTERNAL_CHECK"
	ExternalPaymentCategoryExternalTransfer ExternalPaymentCategory = "EXTERNAL_TRANSFER"
)

func (ExternalPaymentCategory) IsKnown added in v0.51.0 

func (r ExternalPaymentCategory) IsKnown() bool

type ExternalPaymentEvent added in v0.51.0 

type ExternalPaymentEvent struct {
	Token           string                                `json:"token,required" format:"uuid"`
	Amount          int64                                 `json:"amount,required"`
	Created         time.Time                             `json:"created,required" format:"date-time"`
	DetailedResults []ExternalPaymentEventsDetailedResult `json:"detailed_results,required"`
	EffectiveDate   time.Time                             `json:"effective_date,required" format:"date"`
	Memo            string                                `json:"memo,required"`
	Result          ExternalPaymentEventsResult           `json:"result,required"`
	Type            ExternalPaymentEventsType             `json:"type,required"`
	JSON            externalPaymentEventJSON              `json:"-"`
}

func (*ExternalPaymentEvent) UnmarshalJSON added in v0.51.0 

func (r *ExternalPaymentEvent) UnmarshalJSON(data []byte) (err error)

type ExternalPaymentEventsDetailedResult added in v0.51.0 

type ExternalPaymentEventsDetailedResult string
const (
	ExternalPaymentEventsDetailedResultApproved ExternalPaymentEventsDetailedResult = "APPROVED"
)

func (ExternalPaymentEventsDetailedResult) IsKnown added in v0.51.0 

func (r ExternalPaymentEventsDetailedResult) IsKnown() bool

type ExternalPaymentEventsResult added in v0.51.0 

type ExternalPaymentEventsResult string
const (
	ExternalPaymentEventsResultApproved ExternalPaymentEventsResult = "APPROVED"
	ExternalPaymentEventsResultDeclined ExternalPaymentEventsResult = "DECLINED"
)

func (ExternalPaymentEventsResult) IsKnown added in v0.51.0 

func (r ExternalPaymentEventsResult) IsKnown() bool

type ExternalPaymentEventsType added in v0.51.0 

type ExternalPaymentEventsType string
const (
	ExternalPaymentEventsTypeExternalWireInitiated     ExternalPaymentEventsType = "EXTERNAL_WIRE_INITIATED"
	ExternalPaymentEventsTypeExternalWireCanceled      ExternalPaymentEventsType = "EXTERNAL_WIRE_CANCELED"
	ExternalPaymentEventsTypeExternalWireSettled       ExternalPaymentEventsType = "EXTERNAL_WIRE_SETTLED"
	ExternalPaymentEventsTypeExternalWireReversed      ExternalPaymentEventsType = "EXTERNAL_WIRE_REVERSED"
	ExternalPaymentEventsTypeExternalWireReleased      ExternalPaymentEventsType = "EXTERNAL_WIRE_RELEASED"
	ExternalPaymentEventsTypeExternalACHInitiated      ExternalPaymentEventsType = "EXTERNAL_ACH_INITIATED"
	ExternalPaymentEventsTypeExternalACHCanceled       ExternalPaymentEventsType = "EXTERNAL_ACH_CANCELED"
	ExternalPaymentEventsTypeExternalACHSettled        ExternalPaymentEventsType = "EXTERNAL_ACH_SETTLED"
	ExternalPaymentEventsTypeExternalACHReversed       ExternalPaymentEventsType = "EXTERNAL_ACH_REVERSED"
	ExternalPaymentEventsTypeExternalACHReleased       ExternalPaymentEventsType = "EXTERNAL_ACH_RELEASED"
	ExternalPaymentEventsTypeExternalTransferInitiated ExternalPaymentEventsType = "EXTERNAL_TRANSFER_INITIATED"
	ExternalPaymentEventsTypeExternalTransferCanceled  ExternalPaymentEventsType = "EXTERNAL_TRANSFER_CANCELED"
	ExternalPaymentEventsTypeExternalTransferSettled   ExternalPaymentEventsType = "EXTERNAL_TRANSFER_SETTLED"
	ExternalPaymentEventsTypeExternalTransferReversed  ExternalPaymentEventsType = "EXTERNAL_TRANSFER_REVERSED"
	ExternalPaymentEventsTypeExternalTransferReleased  ExternalPaymentEventsType = "EXTERNAL_TRANSFER_RELEASED"
	ExternalPaymentEventsTypeExternalCheckInitiated    ExternalPaymentEventsType = "EXTERNAL_CHECK_INITIATED"
	ExternalPaymentEventsTypeExternalCheckCanceled     ExternalPaymentEventsType = "EXTERNAL_CHECK_CANCELED"
	ExternalPaymentEventsTypeExternalCheckSettled      ExternalPaymentEventsType = "EXTERNAL_CHECK_SETTLED"
	ExternalPaymentEventsTypeExternalCheckReversed     ExternalPaymentEventsType = "EXTERNAL_CHECK_REVERSED"
	ExternalPaymentEventsTypeExternalCheckReleased     ExternalPaymentEventsType = "EXTERNAL_CHECK_RELEASED"
)

func (ExternalPaymentEventsType) IsKnown added in v0.51.0 

func (r ExternalPaymentEventsType) IsKnown() bool

type ExternalPaymentListParams added in v0.51.0 

type ExternalPaymentListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin                param.Field[time.Time] `query:"begin" format:"date-time"`
	BusinessAccountToken param.Field[string]    `query:"business_account_token" format:"uuid"`
	// External Payment category to be returned.
	Category param.Field[ExternalPaymentListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Globally unique identifier for the financial account or card that will send the
	// funds. Accepted type dependent on the program's use case.
	FinancialAccountToken param.Field[string] `query:"financial_account_token" format:"uuid"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// External Payment result to be returned.
	Result param.Field[ExternalPaymentListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Book transfer status to be returned.
	Status param.Field[ExternalPaymentListParamsStatus] `query:"status"`
}

func (ExternalPaymentListParams) URLQuery added in v0.51.0 

func (r ExternalPaymentListParams) URLQuery() (v url.Values)

URLQuery serializes ExternalPaymentListParams's query parameters as `url.Values`.

type ExternalPaymentListParamsCategory added in v0.51.0 

type ExternalPaymentListParamsCategory string

External Payment category to be returned. 

const (
	ExternalPaymentListParamsCategoryExternalWire     ExternalPaymentListParamsCategory = "EXTERNAL_WIRE"
	ExternalPaymentListParamsCategoryExternalACH      ExternalPaymentListParamsCategory = "EXTERNAL_ACH"
	ExternalPaymentListParamsCategoryExternalCheck    ExternalPaymentListParamsCategory = "EXTERNAL_CHECK"
	ExternalPaymentListParamsCategoryExternalTransfer ExternalPaymentListParamsCategory = "EXTERNAL_TRANSFER"
)

func (ExternalPaymentListParamsCategory) IsKnown added in v0.51.0 

func (r ExternalPaymentListParamsCategory) IsKnown() bool

type ExternalPaymentListParamsResult added in v0.51.0 

type ExternalPaymentListParamsResult string

External Payment result to be returned. 

const (
	ExternalPaymentListParamsResultApproved ExternalPaymentListParamsResult = "APPROVED"
	ExternalPaymentListParamsResultDeclined ExternalPaymentListParamsResult = "DECLINED"
)

func (ExternalPaymentListParamsResult) IsKnown added in v0.51.0 

func (r ExternalPaymentListParamsResult) IsKnown() bool

type ExternalPaymentListParamsStatus added in v0.51.0 

type ExternalPaymentListParamsStatus string

Book transfer status to be returned. 

const (
	ExternalPaymentListParamsStatusPending  ExternalPaymentListParamsStatus = "PENDING"
	ExternalPaymentListParamsStatusSettled  ExternalPaymentListParamsStatus = "SETTLED"
	ExternalPaymentListParamsStatusDeclined ExternalPaymentListParamsStatus = "DECLINED"
	ExternalPaymentListParamsStatusReversed ExternalPaymentListParamsStatus = "REVERSED"
	ExternalPaymentListParamsStatusCanceled ExternalPaymentListParamsStatus = "CANCELED"
)

func (ExternalPaymentListParamsStatus) IsKnown added in v0.51.0 

func (r ExternalPaymentListParamsStatus) IsKnown() bool

type ExternalPaymentNewParams added in v0.51.0 

type ExternalPaymentNewParams struct {
	Amount                param.Field[int64]                               `json:"amount,required"`
	Category              param.Field[ExternalPaymentNewParamsCategory]    `json:"category,required"`
	EffectiveDate         param.Field[time.Time]                           `json:"effective_date,required" format:"date"`
	FinancialAccountToken param.Field[string]                              `json:"financial_account_token,required" format:"uuid"`
	PaymentType           param.Field[ExternalPaymentNewParamsPaymentType] `json:"payment_type,required"`
	Token                 param.Field[string]                              `json:"token" format:"uuid"`
	Memo                  param.Field[string]                              `json:"memo"`
	ProgressTo            param.Field[ExternalPaymentNewParamsProgressTo]  `json:"progress_to"`
	UserDefinedID         param.Field[string]                              `json:"user_defined_id"`
}

func (ExternalPaymentNewParams) MarshalJSON added in v0.51.0 

func (r ExternalPaymentNewParams) MarshalJSON() (data []byte, err error)

type ExternalPaymentNewParamsCategory added in v0.51.0 

type ExternalPaymentNewParamsCategory string
const (
	ExternalPaymentNewParamsCategoryExternalWire     ExternalPaymentNewParamsCategory = "EXTERNAL_WIRE"
	ExternalPaymentNewParamsCategoryExternalACH      ExternalPaymentNewParamsCategory = "EXTERNAL_ACH"
	ExternalPaymentNewParamsCategoryExternalCheck    ExternalPaymentNewParamsCategory = "EXTERNAL_CHECK"
	ExternalPaymentNewParamsCategoryExternalTransfer ExternalPaymentNewParamsCategory = "EXTERNAL_TRANSFER"
)

func (ExternalPaymentNewParamsCategory) IsKnown added in v0.51.0 

func (r ExternalPaymentNewParamsCategory) IsKnown() bool

type ExternalPaymentNewParamsPaymentType added in v0.51.0 

type ExternalPaymentNewParamsPaymentType string
const (
	ExternalPaymentNewParamsPaymentTypeDeposit    ExternalPaymentNewParamsPaymentType = "DEPOSIT"
	ExternalPaymentNewParamsPaymentTypeWithdrawal ExternalPaymentNewParamsPaymentType = "WITHDRAWAL"
)

func (ExternalPaymentNewParamsPaymentType) IsKnown added in v0.51.0 

func (r ExternalPaymentNewParamsPaymentType) IsKnown() bool

type ExternalPaymentNewParamsProgressTo added in v0.51.0 

type ExternalPaymentNewParamsProgressTo string
const (
	ExternalPaymentNewParamsProgressToSettled  ExternalPaymentNewParamsProgressTo = "SETTLED"
	ExternalPaymentNewParamsProgressToReleased ExternalPaymentNewParamsProgressTo = "RELEASED"
)

func (ExternalPaymentNewParamsProgressTo) IsKnown added in v0.51.0 

func (r ExternalPaymentNewParamsProgressTo) IsKnown() bool

type ExternalPaymentPaymentType added in v0.51.0 

type ExternalPaymentPaymentType string
const (
	ExternalPaymentPaymentTypeDeposit    ExternalPaymentPaymentType = "DEPOSIT"
	ExternalPaymentPaymentTypeWithdrawal ExternalPaymentPaymentType = "WITHDRAWAL"
)

func (ExternalPaymentPaymentType) IsKnown added in v0.51.0 

func (r ExternalPaymentPaymentType) IsKnown() bool

type ExternalPaymentReleaseParams added in v0.51.0 

type ExternalPaymentReleaseParams struct {
	EffectiveDate param.Field[time.Time] `json:"effective_date,required" format:"date"`
	Memo          param.Field[string]    `json:"memo"`
}

func (ExternalPaymentReleaseParams) MarshalJSON added in v0.51.0 

func (r ExternalPaymentReleaseParams) MarshalJSON() (data []byte, err error)

type ExternalPaymentResult added in v0.51.0 

type ExternalPaymentResult string
const (
	ExternalPaymentResultApproved ExternalPaymentResult = "APPROVED"
	ExternalPaymentResultDeclined ExternalPaymentResult = "DECLINED"
)

func (ExternalPaymentResult) IsKnown added in v0.51.0 

func (r ExternalPaymentResult) IsKnown() bool

type ExternalPaymentReverseParams added in v0.51.0 

type ExternalPaymentReverseParams struct {
	EffectiveDate param.Field[time.Time] `json:"effective_date,required" format:"date"`
	Memo          param.Field[string]    `json:"memo"`
}

func (ExternalPaymentReverseParams) MarshalJSON added in v0.51.0 

func (r ExternalPaymentReverseParams) MarshalJSON() (data []byte, err error)

type ExternalPaymentService added in v0.51.0 

type ExternalPaymentService struct {
	Options []option.RequestOption
}

ExternalPaymentService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewExternalPaymentService method instead.

func NewExternalPaymentService added in v0.51.0 

func NewExternalPaymentService(opts ...option.RequestOption) (r *ExternalPaymentService)

NewExternalPaymentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ExternalPaymentService) Cancel added in v0.51.0 

func (r *ExternalPaymentService) Cancel(ctx context.Context, externalPaymentToken string, body ExternalPaymentCancelParams, opts ...option.RequestOption) (res *ExternalPayment, err error)

Cancel external payment

func (*ExternalPaymentService) Get added in v0.51.0 

func (r *ExternalPaymentService) Get(ctx context.Context, externalPaymentToken string, opts ...option.RequestOption) (res *ExternalPayment, err error)

Get external payment

func (*ExternalPaymentService) List added in v0.51.0 

func (r *ExternalPaymentService) List(ctx context.Context, query ExternalPaymentListParams, opts ...option.RequestOption) (res *pagination.CursorPage[ExternalPayment], err error)

List external payments

func (*ExternalPaymentService) ListAutoPaging added in v0.51.0 

func (r *ExternalPaymentService) ListAutoPaging(ctx context.Context, query ExternalPaymentListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[ExternalPayment]

List external payments

func (*ExternalPaymentService) New added in v0.51.0 

func (r *ExternalPaymentService) New(ctx context.Context, body ExternalPaymentNewParams, opts ...option.RequestOption) (res *ExternalPayment, err error)

Create external payment

func (*ExternalPaymentService) Release added in v0.51.0 

func (r *ExternalPaymentService) Release(ctx context.Context, externalPaymentToken string, body ExternalPaymentReleaseParams, opts ...option.RequestOption) (res *ExternalPayment, err error)

Release external payment

func (*ExternalPaymentService) Reverse added in v0.51.0 

func (r *ExternalPaymentService) Reverse(ctx context.Context, externalPaymentToken string, body ExternalPaymentReverseParams, opts ...option.RequestOption) (res *ExternalPayment, err error)

Reverse external payment

func (*ExternalPaymentService) Settle added in v0.51.0 

func (r *ExternalPaymentService) Settle(ctx context.Context, externalPaymentToken string, body ExternalPaymentSettleParams, opts ...option.RequestOption) (res *ExternalPayment, err error)

Settle external payment

type ExternalPaymentSettleParams added in v0.51.0 

type ExternalPaymentSettleParams struct {
	EffectiveDate param.Field[time.Time]                             `json:"effective_date,required" format:"date"`
	Memo          param.Field[string]                                `json:"memo"`
	ProgressTo    param.Field[ExternalPaymentSettleParamsProgressTo] `json:"progress_to"`
}

func (ExternalPaymentSettleParams) MarshalJSON added in v0.51.0 

func (r ExternalPaymentSettleParams) MarshalJSON() (data []byte, err error)

type ExternalPaymentSettleParamsProgressTo added in v0.51.0 

type ExternalPaymentSettleParamsProgressTo string
const (
	ExternalPaymentSettleParamsProgressToSettled  ExternalPaymentSettleParamsProgressTo = "SETTLED"
	ExternalPaymentSettleParamsProgressToReleased ExternalPaymentSettleParamsProgressTo = "RELEASED"
)

func (ExternalPaymentSettleParamsProgressTo) IsKnown added in v0.51.0 

func (r ExternalPaymentSettleParamsProgressTo) IsKnown() bool

type ExternalPaymentStatus added in v0.51.0 

type ExternalPaymentStatus string
const (
	ExternalPaymentStatusPending  ExternalPaymentStatus = "PENDING"
	ExternalPaymentStatusSettled  ExternalPaymentStatus = "SETTLED"
	ExternalPaymentStatusDeclined ExternalPaymentStatus = "DECLINED"
	ExternalPaymentStatusReversed ExternalPaymentStatus = "REVERSED"
	ExternalPaymentStatusCanceled ExternalPaymentStatus = "CANCELED"
)

func (ExternalPaymentStatus) IsKnown added in v0.51.0 

func (r ExternalPaymentStatus) IsKnown() bool

type FinancialAccount 

type FinancialAccount struct {
	// Globally unique identifier for the account
	Token               string                              `json:"token,required" format:"uuid"`
	AccountToken        string                              `json:"account_token,required,nullable" format:"uuid"`
	Created             time.Time                           `json:"created,required" format:"date-time"`
	CreditConfiguration FinancialAccountCreditConfiguration `json:"credit_configuration,required,nullable"`
	// Whether financial account is for the benefit of another entity
	IsForBenefitOf bool                 `json:"is_for_benefit_of,required"`
	Nickname       string               `json:"nickname,required,nullable"`
	Type           FinancialAccountType `json:"type,required"`
	Updated        time.Time            `json:"updated,required" format:"date-time"`
	AccountNumber  string               `json:"account_number,nullable"`
	RoutingNumber  string               `json:"routing_number,nullable"`
	JSON           financialAccountJSON `json:"-"`
}

func (*FinancialAccount) UnmarshalJSON 

func (r *FinancialAccount) UnmarshalJSON(data []byte) (err error)

type FinancialAccountBalanceListParams 

type FinancialAccountBalanceListParams struct {
	// UTC date of the balance to retrieve. Defaults to latest available balance
	BalanceDate param.Field[time.Time] `query:"balance_date" format:"date-time"`
	// Balance after a given financial event occured. For example, passing the
	// event_token of a $5 CARD_CLEARING financial event will return a balance
	// decreased by $5
	LastTransactionEventToken param.Field[string] `query:"last_transaction_event_token" format:"uuid"`
}

func (FinancialAccountBalanceListParams) URLQuery 

func (r FinancialAccountBalanceListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialAccountBalanceListParams's query parameters as `url.Values`.

type FinancialAccountBalanceListResponse 

type FinancialAccountBalanceListResponse struct {
	// Globally unique identifier for the financial account that holds this balance.
	Token string `json:"token,required" format:"uuid"`
	// Funds available for spend in the currency's smallest unit (e.g., cents for USD)
	AvailableAmount int64 `json:"available_amount,required"`
	// Date and time for when the balance was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the balance.
	Currency string `json:"currency,required"`
	// Globally unique identifier for the last financial transaction event that
	// impacted this balance.
	LastTransactionEventToken string `json:"last_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for the last financial transaction that impacted this
	// balance.
	LastTransactionToken string `json:"last_transaction_token,required" format:"uuid"`
	// Funds not available for spend due to card authorizations or pending ACH release.
	// Shown in the currency's smallest unit (e.g., cents for USD).
	PendingAmount int64 `json:"pending_amount,required"`
	// The sum of available and pending balance in the currency's smallest unit (e.g.,
	// cents for USD).
	TotalAmount int64 `json:"total_amount,required"`
	// Type of financial account.
	Type FinancialAccountBalanceListResponseType `json:"type,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time                               `json:"updated,required" format:"date-time"`
	JSON    financialAccountBalanceListResponseJSON `json:"-"`
}

Balance of a Financial Account

func (*FinancialAccountBalanceListResponse) UnmarshalJSON 

func (r *FinancialAccountBalanceListResponse) UnmarshalJSON(data []byte) (err error)

type FinancialAccountBalanceListResponseType added in v0.29.0 

type FinancialAccountBalanceListResponseType string

Type of financial account. 

const (
	FinancialAccountBalanceListResponseTypeIssuing   FinancialAccountBalanceListResponseType = "ISSUING"
	FinancialAccountBalanceListResponseTypeOperating FinancialAccountBalanceListResponseType = "OPERATING"
	FinancialAccountBalanceListResponseTypeReserve   FinancialAccountBalanceListResponseType = "RESERVE"
)

func (FinancialAccountBalanceListResponseType) IsKnown added in v0.29.0 

func (r FinancialAccountBalanceListResponseType) IsKnown() bool

type FinancialAccountBalanceService 

type FinancialAccountBalanceService struct {
	Options []option.RequestOption
}

FinancialAccountBalanceService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountBalanceService method instead.

func NewFinancialAccountBalanceService 

func NewFinancialAccountBalanceService(opts ...option.RequestOption) (r *FinancialAccountBalanceService)

NewFinancialAccountBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountBalanceService) List 

func (r *FinancialAccountBalanceService) List(ctx context.Context, financialAccountToken string, query FinancialAccountBalanceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[FinancialAccountBalanceListResponse], err error)

Get the balances for a given financial account.

func (*FinancialAccountBalanceService) ListAutoPaging 

func (r *FinancialAccountBalanceService) ListAutoPaging(ctx context.Context, financialAccountToken string, query FinancialAccountBalanceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[FinancialAccountBalanceListResponse]

Get the balances for a given financial account.

type FinancialAccountChargeOffParams added in v0.62.0 

type FinancialAccountChargeOffParams struct {
	// Reason for the financial account being marked as Charged Off
	Reason param.Field[FinancialAccountChargeOffParamsReason] `json:"reason,required"`
}

func (FinancialAccountChargeOffParams) MarshalJSON added in v0.62.0 

func (r FinancialAccountChargeOffParams) MarshalJSON() (data []byte, err error)

type FinancialAccountChargeOffParamsReason added in v0.62.0 

type FinancialAccountChargeOffParamsReason string

Reason for the financial account being marked as Charged Off 

const (
	FinancialAccountChargeOffParamsReasonDelinquent FinancialAccountChargeOffParamsReason = "DELINQUENT"
	FinancialAccountChargeOffParamsReasonFraud      FinancialAccountChargeOffParamsReason = "FRAUD"
)

func (FinancialAccountChargeOffParamsReason) IsKnown added in v0.62.0 

func (r FinancialAccountChargeOffParamsReason) IsKnown() bool

type FinancialAccountCreditConfig added in v0.40.0 

type FinancialAccountCreditConfig struct {
	// Globally unique identifier for the account
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Reason for the financial account being marked as Charged Off
	ChargedOffReason FinancialAccountCreditConfigChargedOffReason `json:"charged_off_reason,required,nullable"`
	CreditLimit      int64                                        `json:"credit_limit,required,nullable"`
	// Globally unique identifier for the credit product
	CreditProductToken       string `json:"credit_product_token,required,nullable"`
	ExternalBankAccountToken string `json:"external_bank_account_token,required,nullable" format:"uuid"`
	// State of the financial account
	FinancialAccountState FinancialAccountCreditConfigFinancialAccountState `json:"financial_account_state,required"`
	IsSpendBlocked        bool                                              `json:"is_spend_blocked,required"`
	// Tier assigned to the financial account
	Tier string                           `json:"tier,required,nullable"`
	JSON financialAccountCreditConfigJSON `json:"-"`
}

func (*FinancialAccountCreditConfig) UnmarshalJSON added in v0.40.0 

func (r *FinancialAccountCreditConfig) UnmarshalJSON(data []byte) (err error)

type FinancialAccountCreditConfigChargedOffReason added in v0.62.0 

type FinancialAccountCreditConfigChargedOffReason string

Reason for the financial account being marked as Charged Off 

const (
	FinancialAccountCreditConfigChargedOffReasonDelinquent FinancialAccountCreditConfigChargedOffReason = "DELINQUENT"
	FinancialAccountCreditConfigChargedOffReasonFraud      FinancialAccountCreditConfigChargedOffReason = "FRAUD"
)

func (FinancialAccountCreditConfigChargedOffReason) IsKnown added in v0.62.0 

func (r FinancialAccountCreditConfigChargedOffReason) IsKnown() bool

type FinancialAccountCreditConfigFinancialAccountState added in v0.51.0 

type FinancialAccountCreditConfigFinancialAccountState string

State of the financial account 

const (
	FinancialAccountCreditConfigFinancialAccountStatePending    FinancialAccountCreditConfigFinancialAccountState = "PENDING"
	FinancialAccountCreditConfigFinancialAccountStateCurrent    FinancialAccountCreditConfigFinancialAccountState = "CURRENT"
	FinancialAccountCreditConfigFinancialAccountStateDelinquent FinancialAccountCreditConfigFinancialAccountState = "DELINQUENT"
	FinancialAccountCreditConfigFinancialAccountStateChargedOff FinancialAccountCreditConfigFinancialAccountState = "CHARGED_OFF"
)

func (FinancialAccountCreditConfigFinancialAccountState) IsKnown added in v0.51.0 

func (r FinancialAccountCreditConfigFinancialAccountState) IsKnown() bool

type FinancialAccountCreditConfiguration added in v0.51.0 

type FinancialAccountCreditConfiguration struct {
	// Reason for the financial account being marked as Charged Off
	ChargedOffReason FinancialAccountCreditConfigurationChargedOffReason `json:"charged_off_reason,required,nullable"`
	CreditLimit      int64                                               `json:"credit_limit,required,nullable"`
	// Globally unique identifier for the credit product
	CreditProductToken       string `json:"credit_product_token,required,nullable"`
	ExternalBankAccountToken string `json:"external_bank_account_token,required,nullable" format:"uuid"`
	// State of the financial account
	FinancialAccountState FinancialAccountCreditConfigurationFinancialAccountState `json:"financial_account_state,required,nullable"`
	IsSpendBlocked        bool                                                     `json:"is_spend_blocked,required"`
	// Tier assigned to the financial account
	Tier string                                  `json:"tier,required,nullable"`
	JSON financialAccountCreditConfigurationJSON `json:"-"`
}

func (*FinancialAccountCreditConfiguration) UnmarshalJSON added in v0.51.0 

func (r *FinancialAccountCreditConfiguration) UnmarshalJSON(data []byte) (err error)

type FinancialAccountCreditConfigurationChargedOffReason added in v0.62.0 

type FinancialAccountCreditConfigurationChargedOffReason string

Reason for the financial account being marked as Charged Off 

const (
	FinancialAccountCreditConfigurationChargedOffReasonDelinquent FinancialAccountCreditConfigurationChargedOffReason = "DELINQUENT"
	FinancialAccountCreditConfigurationChargedOffReasonFraud      FinancialAccountCreditConfigurationChargedOffReason = "FRAUD"
)

func (FinancialAccountCreditConfigurationChargedOffReason) IsKnown added in v0.62.0 

func (r FinancialAccountCreditConfigurationChargedOffReason) IsKnown() bool

type FinancialAccountCreditConfigurationFinancialAccountState added in v0.51.0 

type FinancialAccountCreditConfigurationFinancialAccountState string

State of the financial account 

const (
	FinancialAccountCreditConfigurationFinancialAccountStatePending    FinancialAccountCreditConfigurationFinancialAccountState = "PENDING"
	FinancialAccountCreditConfigurationFinancialAccountStateCurrent    FinancialAccountCreditConfigurationFinancialAccountState = "CURRENT"
	FinancialAccountCreditConfigurationFinancialAccountStateDelinquent FinancialAccountCreditConfigurationFinancialAccountState = "DELINQUENT"
	FinancialAccountCreditConfigurationFinancialAccountStateChargedOff FinancialAccountCreditConfigurationFinancialAccountState = "CHARGED_OFF"
)

func (FinancialAccountCreditConfigurationFinancialAccountState) IsKnown added in v0.51.0 

func (r FinancialAccountCreditConfigurationFinancialAccountState) IsKnown() bool

type FinancialAccountCreditConfigurationService added in v0.40.0 

type FinancialAccountCreditConfigurationService struct {
	Options []option.RequestOption
}

FinancialAccountCreditConfigurationService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountCreditConfigurationService method instead.

func NewFinancialAccountCreditConfigurationService added in v0.40.0 

func NewFinancialAccountCreditConfigurationService(opts ...option.RequestOption) (r *FinancialAccountCreditConfigurationService)

NewFinancialAccountCreditConfigurationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountCreditConfigurationService) Get added in v0.40.0 

func (r *FinancialAccountCreditConfigurationService) Get(ctx context.Context, financialAccountToken string, opts ...option.RequestOption) (res *FinancialAccountCreditConfig, err error)

Get an Account's credit configuration

func (*FinancialAccountCreditConfigurationService) Update added in v0.40.0 

func (r *FinancialAccountCreditConfigurationService) Update(ctx context.Context, financialAccountToken string, body FinancialAccountCreditConfigurationUpdateParams, opts ...option.RequestOption) (res *FinancialAccountCreditConfig, err error)

Update an account's credit configuration

type FinancialAccountCreditConfigurationUpdateParams added in v0.40.0 

type FinancialAccountCreditConfigurationUpdateParams struct {
	CreditLimit param.Field[int64] `json:"credit_limit"`
	// Globally unique identifier for the credit product
	CreditProductToken       param.Field[string] `json:"credit_product_token"`
	ExternalBankAccountToken param.Field[string] `json:"external_bank_account_token" format:"uuid"`
	// Tier to assign to a financial account
	Tier param.Field[string] `json:"tier"`
}

func (FinancialAccountCreditConfigurationUpdateParams) MarshalJSON added in v0.40.0 

func (r FinancialAccountCreditConfigurationUpdateParams) MarshalJSON() (data []byte, err error)

type FinancialAccountFinancialTransactionService 

type FinancialAccountFinancialTransactionService struct {
	Options []option.RequestOption
}

FinancialAccountFinancialTransactionService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountFinancialTransactionService method instead.

func NewFinancialAccountFinancialTransactionService 

func NewFinancialAccountFinancialTransactionService(opts ...option.RequestOption) (r *FinancialAccountFinancialTransactionService)

NewFinancialAccountFinancialTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountFinancialTransactionService) Get 

func (r *FinancialAccountFinancialTransactionService) Get(ctx context.Context, financialAccountToken string, financialTransactionToken string, opts ...option.RequestOption) (res *FinancialTransaction, err error)

Get the financial transaction for the provided token.

func (*FinancialAccountFinancialTransactionService) List 

func (r *FinancialAccountFinancialTransactionService) List(ctx context.Context, financialAccountToken string, query FinancialTransactionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[FinancialTransaction], err error)

List the financial transactions for a given financial account.

func (*FinancialAccountFinancialTransactionService) ListAutoPaging 

func (r *FinancialAccountFinancialTransactionService) ListAutoPaging(ctx context.Context, financialAccountToken string, query FinancialTransactionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[FinancialTransaction]

List the financial transactions for a given financial account.

type FinancialAccountListParams 

type FinancialAccountListParams struct {
	// List financial accounts for a given account_token or business_account_token
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// List financial accounts for a given business_account_token
	BusinessAccountToken param.Field[string] `query:"business_account_token" format:"uuid"`
	// List financial accounts of a given type
	Type param.Field[FinancialAccountListParamsType] `query:"type"`
}

func (FinancialAccountListParams) URLQuery 

func (r FinancialAccountListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialAccountListParams's query parameters as `url.Values`.

type FinancialAccountListParamsType 

type FinancialAccountListParamsType string

List financial accounts of a given type 

const (
	FinancialAccountListParamsTypeIssuing   FinancialAccountListParamsType = "ISSUING"
	FinancialAccountListParamsTypeOperating FinancialAccountListParamsType = "OPERATING"
	FinancialAccountListParamsTypeReserve   FinancialAccountListParamsType = "RESERVE"
)

func (FinancialAccountListParamsType) IsKnown added in v0.27.0 

func (r FinancialAccountListParamsType) IsKnown() bool

type FinancialAccountLoanTapeListParams added in v0.55.0 

type FinancialAccountLoanTapeListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified date
	// will be included.
	Begin param.Field[time.Time] `query:"begin" format:"date"`
	// Date string in RFC 3339 format. Only entries created before the specified date
	// will be included.
	End param.Field[time.Time] `query:"end" format:"date"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (FinancialAccountLoanTapeListParams) URLQuery added in v0.55.0 

func (r FinancialAccountLoanTapeListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialAccountLoanTapeListParams's query parameters as `url.Values`.

type FinancialAccountLoanTapeService added in v0.55.0 

type FinancialAccountLoanTapeService struct {
	Options []option.RequestOption
}

FinancialAccountLoanTapeService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountLoanTapeService method instead.

func NewFinancialAccountLoanTapeService added in v0.55.0 

func NewFinancialAccountLoanTapeService(opts ...option.RequestOption) (r *FinancialAccountLoanTapeService)

NewFinancialAccountLoanTapeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountLoanTapeService) Get added in v0.55.0 

func (r *FinancialAccountLoanTapeService) Get(ctx context.Context, financialAccountToken string, loanTapeToken string, opts ...option.RequestOption) (res *LoanTape, err error)

Get a specific loan tape for a given financial account.

func (*FinancialAccountLoanTapeService) List added in v0.55.0 

func (r *FinancialAccountLoanTapeService) List(ctx context.Context, financialAccountToken string, query FinancialAccountLoanTapeListParams, opts ...option.RequestOption) (res *pagination.CursorPage[LoanTape], err error)

List the loan tapes for a given financial account.

func (*FinancialAccountLoanTapeService) ListAutoPaging added in v0.55.0 

func (r *FinancialAccountLoanTapeService) ListAutoPaging(ctx context.Context, financialAccountToken string, query FinancialAccountLoanTapeListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[LoanTape]

List the loan tapes for a given financial account.

type FinancialAccountNewParams added in v0.25.0 

type FinancialAccountNewParams struct {
	Nickname       param.Field[string]                        `json:"nickname,required"`
	Type           param.Field[FinancialAccountNewParamsType] `json:"type,required"`
	AccountToken   param.Field[string]                        `json:"account_token" format:"uuid"`
	IsForBenefitOf param.Field[bool]                          `json:"is_for_benefit_of"`
	IdempotencyKey param.Field[string]                        `header:"Idempotency-Key" format:"uuid"`
}

func (FinancialAccountNewParams) MarshalJSON added in v0.25.0 

func (r FinancialAccountNewParams) MarshalJSON() (data []byte, err error)

type FinancialAccountNewParamsType added in v0.25.0 

type FinancialAccountNewParamsType string
const (
	FinancialAccountNewParamsTypeOperating FinancialAccountNewParamsType = "OPERATING"
)

func (FinancialAccountNewParamsType) IsKnown added in v0.27.0 

func (r FinancialAccountNewParamsType) IsKnown() bool

type FinancialAccountService 

type FinancialAccountService struct {
	Options               []option.RequestOption
	Balances              *FinancialAccountBalanceService
	FinancialTransactions *FinancialAccountFinancialTransactionService
	CreditConfiguration   *FinancialAccountCreditConfigurationService
	Statements            *FinancialAccountStatementService
	LoanTapes             *FinancialAccountLoanTapeService
}

FinancialAccountService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountService method instead.

func NewFinancialAccountService 

func NewFinancialAccountService(opts ...option.RequestOption) (r *FinancialAccountService)

NewFinancialAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountService) ChargeOff added in v0.62.0 

func (r *FinancialAccountService) ChargeOff(ctx context.Context, financialAccountToken string, body FinancialAccountChargeOffParams, opts ...option.RequestOption) (res *FinancialAccountCreditConfig, err error)

Update issuing account state to charged off

func (*FinancialAccountService) Get added in v0.24.0 

func (r *FinancialAccountService) Get(ctx context.Context, financialAccountToken string, opts ...option.RequestOption) (res *FinancialAccount, err error)

Get a financial account

func (*FinancialAccountService) List 

func (r *FinancialAccountService) List(ctx context.Context, query FinancialAccountListParams, opts ...option.RequestOption) (res *pagination.SinglePage[FinancialAccount], err error)

Retrieve information on your financial accounts including routing and account number.

func (*FinancialAccountService) ListAutoPaging 

func (r *FinancialAccountService) ListAutoPaging(ctx context.Context, query FinancialAccountListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[FinancialAccount]

Retrieve information on your financial accounts including routing and account number.

func (*FinancialAccountService) New added in v0.25.0 

func (r *FinancialAccountService) New(ctx context.Context, params FinancialAccountNewParams, opts ...option.RequestOption) (res *FinancialAccount, err error)

Create a new financial account

func (*FinancialAccountService) Update added in v0.24.0 

func (r *FinancialAccountService) Update(ctx context.Context, financialAccountToken string, body FinancialAccountUpdateParams, opts ...option.RequestOption) (res *FinancialAccount, err error)

Update a financial account

type FinancialAccountStatementLineItemListParams added in v0.9.0 

type FinancialAccountStatementLineItemListParams struct {
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (FinancialAccountStatementLineItemListParams) URLQuery added in v0.9.0 

func (r FinancialAccountStatementLineItemListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialAccountStatementLineItemListParams's query parameters as `url.Values`.

type FinancialAccountStatementLineItemListResponse added in v0.9.0 

type FinancialAccountStatementLineItemListResponse struct {
	// Globally unique identifier for a Statement Line Item
	Token string `json:"token,required"`
	// Transaction amount in cents
	Amount   int64                                                 `json:"amount,required"`
	Category FinancialAccountStatementLineItemListResponseCategory `json:"category,required"`
	// Timestamp of when the line item was generated
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction
	Currency string `json:"currency,required"`
	// Date that the transaction effected the account balance
	EffectiveDate time.Time                                              `json:"effective_date,required" format:"date"`
	EventType     FinancialAccountStatementLineItemListResponseEventType `json:"event_type,required"`
	// Globally unique identifier for a financial account
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Globally unique identifier for a financial transaction event
	FinancialTransactionEventToken string `json:"financial_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for a financial transaction
	FinancialTransactionToken string `json:"financial_transaction_token,required" format:"uuid"`
	// Globally unique identifier for a card
	CardToken  string                                            `json:"card_token" format:"uuid"`
	Descriptor string                                            `json:"descriptor"`
	JSON       financialAccountStatementLineItemListResponseJSON `json:"-"`
}

func (*FinancialAccountStatementLineItemListResponse) UnmarshalJSON added in v0.9.0 

func (r *FinancialAccountStatementLineItemListResponse) UnmarshalJSON(data []byte) (err error)

type FinancialAccountStatementLineItemListResponseCategory added in v0.9.0 

type FinancialAccountStatementLineItemListResponseCategory string
const (
	FinancialAccountStatementLineItemListResponseCategoryACH                  FinancialAccountStatementLineItemListResponseCategory = "ACH"
	FinancialAccountStatementLineItemListResponseCategoryBalanceOrFunding     FinancialAccountStatementLineItemListResponseCategory = "BALANCE_OR_FUNDING"
	FinancialAccountStatementLineItemListResponseCategoryCard                 FinancialAccountStatementLineItemListResponseCategory = "CARD"
	FinancialAccountStatementLineItemListResponseCategoryExternalACH          FinancialAccountStatementLineItemListResponseCategory = "EXTERNAL_ACH"
	FinancialAccountStatementLineItemListResponseCategoryExternalCheck        FinancialAccountStatementLineItemListResponseCategory = "EXTERNAL_CHECK"
	FinancialAccountStatementLineItemListResponseCategoryExternalTransfer     FinancialAccountStatementLineItemListResponseCategory = "EXTERNAL_TRANSFER"
	FinancialAccountStatementLineItemListResponseCategoryExternalWire         FinancialAccountStatementLineItemListResponseCategory = "EXTERNAL_WIRE"
	FinancialAccountStatementLineItemListResponseCategoryManagementAdjustment FinancialAccountStatementLineItemListResponseCategory = "MANAGEMENT_ADJUSTMENT"
	FinancialAccountStatementLineItemListResponseCategoryManagementDispute    FinancialAccountStatementLineItemListResponseCategory = "MANAGEMENT_DISPUTE"
	FinancialAccountStatementLineItemListResponseCategoryManagementFee        FinancialAccountStatementLineItemListResponseCategory = "MANAGEMENT_FEE"
	FinancialAccountStatementLineItemListResponseCategoryManagementReward     FinancialAccountStatementLineItemListResponseCategory = "MANAGEMENT_REWARD"
)

func (FinancialAccountStatementLineItemListResponseCategory) IsKnown added in v0.27.0 

func (r FinancialAccountStatementLineItemListResponseCategory) IsKnown() bool

type FinancialAccountStatementLineItemListResponseEventType added in v0.9.0 

type FinancialAccountStatementLineItemListResponseEventType string
const (
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationCancelled      FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_CANCELLED"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationInitiated      FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationProcessed      FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_PROCESSED"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationReleased       FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationReviewed       FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_REVIEWED"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationSettled        FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReceiptProcessed          FinancialAccountStatementLineItemListResponseEventType = "ACH_RECEIPT_PROCESSED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReceiptSettled            FinancialAccountStatementLineItemListResponseEventType = "ACH_RECEIPT_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReturnInitiated           FinancialAccountStatementLineItemListResponseEventType = "ACH_RETURN_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReturnProcessed           FinancialAccountStatementLineItemListResponseEventType = "ACH_RETURN_PROCESSED"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorization                FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationAdvice          FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_ADVICE"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationExpiry          FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_EXPIRY"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationReversal        FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeBalanceInquiry               FinancialAccountStatementLineItemListResponseEventType = "BALANCE_INQUIRY"
	FinancialAccountStatementLineItemListResponseEventTypeBillingError                 FinancialAccountStatementLineItemListResponseEventType = "BILLING_ERROR"
	FinancialAccountStatementLineItemListResponseEventTypeBillingErrorReversal         FinancialAccountStatementLineItemListResponseEventType = "BILLING_ERROR_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeCardToCard                   FinancialAccountStatementLineItemListResponseEventType = "CARD_TO_CARD"
	FinancialAccountStatementLineItemListResponseEventTypeCashBack                     FinancialAccountStatementLineItemListResponseEventType = "CASH_BACK"
	FinancialAccountStatementLineItemListResponseEventTypeCashBackReversal             FinancialAccountStatementLineItemListResponseEventType = "CASH_BACK_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeClearing                     FinancialAccountStatementLineItemListResponseEventType = "CLEARING"
	FinancialAccountStatementLineItemListResponseEventTypeCorrectionCredit             FinancialAccountStatementLineItemListResponseEventType = "CORRECTION_CREDIT"
	FinancialAccountStatementLineItemListResponseEventTypeCorrectionDebit              FinancialAccountStatementLineItemListResponseEventType = "CORRECTION_DEBIT"
	FinancialAccountStatementLineItemListResponseEventTypeCreditAuthorization          FinancialAccountStatementLineItemListResponseEventType = "CREDIT_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeCreditAuthorizationAdvice    FinancialAccountStatementLineItemListResponseEventType = "CREDIT_AUTHORIZATION_ADVICE"
	FinancialAccountStatementLineItemListResponseEventTypeCurrencyConversion           FinancialAccountStatementLineItemListResponseEventType = "CURRENCY_CONVERSION"
	FinancialAccountStatementLineItemListResponseEventTypeCurrencyConversionReversal   FinancialAccountStatementLineItemListResponseEventType = "CURRENCY_CONVERSION_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeDisputeWon                   FinancialAccountStatementLineItemListResponseEventType = "DISPUTE_WON"
	FinancialAccountStatementLineItemListResponseEventTypeExternalACHCanceled          FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_ACH_CANCELED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalACHInitiated         FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_ACH_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalACHReleased          FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_ACH_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalACHReversed          FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_ACH_REVERSED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalACHSettled           FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_ACH_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalCheckCanceled        FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_CHECK_CANCELED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalCheckInitiated       FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_CHECK_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalCheckReleased        FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_CHECK_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalCheckReversed        FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_CHECK_REVERSED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalCheckSettled         FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_CHECK_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalTransferCanceled     FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_TRANSFER_CANCELED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalTransferInitiated    FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_TRANSFER_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalTransferReleased     FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_TRANSFER_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalTransferReversed     FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_TRANSFER_REVERSED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalTransferSettled      FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_TRANSFER_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalWireCanceled         FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_WIRE_CANCELED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalWireInitiated        FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_WIRE_INITIATED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalWireReleased         FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_WIRE_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalWireReversed         FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_WIRE_REVERSED"
	FinancialAccountStatementLineItemListResponseEventTypeExternalWireSettled          FinancialAccountStatementLineItemListResponseEventType = "EXTERNAL_WIRE_SETTLED"
	FinancialAccountStatementLineItemListResponseEventTypeFinancialAuthorization       FinancialAccountStatementLineItemListResponseEventType = "FINANCIAL_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeFinancialCreditAuthorization FinancialAccountStatementLineItemListResponseEventType = "FINANCIAL_CREDIT_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeInterest                     FinancialAccountStatementLineItemListResponseEventType = "INTEREST"
	FinancialAccountStatementLineItemListResponseEventTypeInterestReversal             FinancialAccountStatementLineItemListResponseEventType = "INTEREST_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeLatePayment                  FinancialAccountStatementLineItemListResponseEventType = "LATE_PAYMENT"
	FinancialAccountStatementLineItemListResponseEventTypeLatePaymentReversal          FinancialAccountStatementLineItemListResponseEventType = "LATE_PAYMENT_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeProvisionalCredit            FinancialAccountStatementLineItemListResponseEventType = "PROVISIONAL_CREDIT"
	FinancialAccountStatementLineItemListResponseEventTypeProvisionalCreditReversal    FinancialAccountStatementLineItemListResponseEventType = "PROVISIONAL_CREDIT_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeReturn                       FinancialAccountStatementLineItemListResponseEventType = "RETURN"
	FinancialAccountStatementLineItemListResponseEventTypeReturnReversal               FinancialAccountStatementLineItemListResponseEventType = "RETURN_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeTransfer                     FinancialAccountStatementLineItemListResponseEventType = "TRANSFER"
	FinancialAccountStatementLineItemListResponseEventTypeTransferInsufficientFunds    FinancialAccountStatementLineItemListResponseEventType = "TRANSFER_INSUFFICIENT_FUNDS"
)

func (FinancialAccountStatementLineItemListResponseEventType) IsKnown added in v0.27.0 

func (r FinancialAccountStatementLineItemListResponseEventType) IsKnown() bool

type FinancialAccountStatementLineItemService added in v0.9.0 

type FinancialAccountStatementLineItemService struct {
	Options []option.RequestOption
}

FinancialAccountStatementLineItemService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountStatementLineItemService method instead.

func NewFinancialAccountStatementLineItemService added in v0.9.0 

func NewFinancialAccountStatementLineItemService(opts ...option.RequestOption) (r *FinancialAccountStatementLineItemService)

NewFinancialAccountStatementLineItemService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountStatementLineItemService) List added in v0.9.0 

func (r *FinancialAccountStatementLineItemService) List(ctx context.Context, financialAccountToken string, statementToken string, query FinancialAccountStatementLineItemListParams, opts ...option.RequestOption) (res *pagination.CursorPage[FinancialAccountStatementLineItemListResponse], err error)

List the line items for a given statement within a given financial account.

func (*FinancialAccountStatementLineItemService) ListAutoPaging added in v0.9.0 

func (r *FinancialAccountStatementLineItemService) ListAutoPaging(ctx context.Context, financialAccountToken string, statementToken string, query FinancialAccountStatementLineItemListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[FinancialAccountStatementLineItemListResponse]

List the line items for a given statement within a given financial account.

type FinancialAccountStatementListParams added in v0.9.0 

type FinancialAccountStatementListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified date
	// will be included.
	Begin param.Field[time.Time] `query:"begin" format:"date"`
	// Date string in RFC 3339 format. Only entries created before the specified date
	// will be included.
	End param.Field[time.Time] `query:"end" format:"date"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Whether to include the initial statement. It is not included by default.
	IncludeInitialStatements param.Field[bool] `query:"include_initial_statements"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (FinancialAccountStatementListParams) URLQuery added in v0.9.0 

func (r FinancialAccountStatementListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialAccountStatementListParams's query parameters as `url.Values`.

type FinancialAccountStatementService added in v0.9.0 

type FinancialAccountStatementService struct {
	Options   []option.RequestOption
	LineItems *FinancialAccountStatementLineItemService
}

FinancialAccountStatementService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFinancialAccountStatementService method instead.

func NewFinancialAccountStatementService added in v0.9.0 

func NewFinancialAccountStatementService(opts ...option.RequestOption) (r *FinancialAccountStatementService)

NewFinancialAccountStatementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FinancialAccountStatementService) Get added in v0.9.0 

func (r *FinancialAccountStatementService) Get(ctx context.Context, financialAccountToken string, statementToken string, opts ...option.RequestOption) (res *Statement, err error)

Get a specific statement for a given financial account.

func (*FinancialAccountStatementService) List added in v0.9.0 

func (r *FinancialAccountStatementService) List(ctx context.Context, financialAccountToken string, query FinancialAccountStatementListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Statement], err error)

List the statements for a given financial account.

func (*FinancialAccountStatementService) ListAutoPaging added in v0.9.0 

func (r *FinancialAccountStatementService) ListAutoPaging(ctx context.Context, financialAccountToken string, query FinancialAccountStatementListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Statement]

List the statements for a given financial account.

type FinancialAccountType 

type FinancialAccountType string
const (
	FinancialAccountTypeIssuing   FinancialAccountType = "ISSUING"
	FinancialAccountTypeReserve   FinancialAccountType = "RESERVE"
	FinancialAccountTypeOperating FinancialAccountType = "OPERATING"
)

func (FinancialAccountType) IsKnown added in v0.27.0 

func (r FinancialAccountType) IsKnown() bool

type FinancialAccountUpdateParams added in v0.24.0 

type FinancialAccountUpdateParams struct {
	Nickname param.Field[string] `json:"nickname"`
}

func (FinancialAccountUpdateParams) MarshalJSON added in v0.24.0 

func (r FinancialAccountUpdateParams) MarshalJSON() (data []byte, err error)

type FinancialTransaction 

type FinancialTransaction struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Status types:
	//
	//   - `CARD` - Issuing card transaction.
	//   - `ACH` - Transaction over ACH.
	//   - `TRANSFER` - Internal transfer of funds between financial accounts in your
	//     program.
	Category FinancialTransactionCategory `json:"category,required"`
	// Date and time when the financial transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction.
	Currency string `json:"currency,required"`
	// A string that provides a description of the financial transaction; may be useful
	// to display to users.
	Descriptor string `json:"descriptor,required"`
	// A list of all financial events that have modified this financial transaction.
	Events []FinancialTransactionEvent `json:"events,required"`
	// Pending amount of the transaction in the currency's smallest unit (e.g., cents),
	// including any acquirer fees. The value of this field will go to zero over time
	// once the financial transaction is settled.
	PendingAmount int64 `json:"pending_amount,required"`
	// APPROVED transactions were successful while DECLINED transactions were declined
	// by user, Lithic, or the network.
	Result FinancialTransactionResult `json:"result,required"`
	// Amount of the transaction that has been settled in the currency's smallest unit
	// (e.g., cents), including any acquirer fees. This may change over time.
	SettledAmount int64 `json:"settled_amount,required"`
	// Status types:
	//
	//   - `DECLINED` - The transaction was declined.
	//   - `EXPIRED` - The authorization as it has passed its expiration time. Card
	//     transaction only.
	//   - `PENDING` - The transaction is expected to settle.
	//   - `RETURNED` - The transaction has been returned.
	//   - `SETTLED` - The transaction is completed.
	//   - `VOIDED` - The transaction was voided. Card transaction only.
	Status FinancialTransactionStatus `json:"status,required"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated time.Time                `json:"updated,required" format:"date-time"`
	JSON    financialTransactionJSON `json:"-"`
}

func (*FinancialTransaction) UnmarshalJSON 

func (r *FinancialTransaction) UnmarshalJSON(data []byte) (err error)

type FinancialTransactionCategory 

type FinancialTransactionCategory string

Status types:

  • `CARD` - Issuing card transaction.
  • `ACH` - Transaction over ACH.
  • `TRANSFER` - Internal transfer of funds between financial accounts in your program.
const (
	FinancialTransactionCategoryACH      FinancialTransactionCategory = "ACH"
	FinancialTransactionCategoryCard     FinancialTransactionCategory = "CARD"
	FinancialTransactionCategoryTransfer FinancialTransactionCategory = "TRANSFER"
)

func (FinancialTransactionCategory) IsKnown added in v0.27.0 

func (r FinancialTransactionCategory) IsKnown() bool

type FinancialTransactionEvent added in v0.5.0 

type FinancialTransactionEvent struct {
	// Globally unique identifier.
	Token string `json:"token" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result FinancialTransactionEventsResult `json:"result"`
	Type   FinancialTransactionEventsType   `json:"type"`
	JSON   financialTransactionEventJSON    `json:"-"`
}

func (*FinancialTransactionEvent) UnmarshalJSON added in v0.5.0 

func (r *FinancialTransactionEvent) UnmarshalJSON(data []byte) (err error)

type FinancialTransactionEventsResult 

type FinancialTransactionEventsResult string

APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network. 

const (
	FinancialTransactionEventsResultApproved FinancialTransactionEventsResult = "APPROVED"
	FinancialTransactionEventsResultDeclined FinancialTransactionEventsResult = "DECLINED"
)

func (FinancialTransactionEventsResult) IsKnown added in v0.27.0 

func (r FinancialTransactionEventsResult) IsKnown() bool

type FinancialTransactionEventsType 

type FinancialTransactionEventsType string
const (
	FinancialTransactionEventsTypeACHOriginationCancelled      FinancialTransactionEventsType = "ACH_ORIGINATION_CANCELLED"
	FinancialTransactionEventsTypeACHOriginationInitiated      FinancialTransactionEventsType = "ACH_ORIGINATION_INITIATED"
	FinancialTransactionEventsTypeACHOriginationProcessed      FinancialTransactionEventsType = "ACH_ORIGINATION_PROCESSED"
	FinancialTransactionEventsTypeACHOriginationReleased       FinancialTransactionEventsType = "ACH_ORIGINATION_RELEASED"
	FinancialTransactionEventsTypeACHOriginationReviewed       FinancialTransactionEventsType = "ACH_ORIGINATION_REVIEWED"
	FinancialTransactionEventsTypeACHOriginationSettled        FinancialTransactionEventsType = "ACH_ORIGINATION_SETTLED"
	FinancialTransactionEventsTypeACHReceiptProcessed          FinancialTransactionEventsType = "ACH_RECEIPT_PROCESSED"
	FinancialTransactionEventsTypeACHReceiptSettled            FinancialTransactionEventsType = "ACH_RECEIPT_SETTLED"
	FinancialTransactionEventsTypeACHReturnInitiated           FinancialTransactionEventsType = "ACH_RETURN_INITIATED"
	FinancialTransactionEventsTypeACHReturnProcessed           FinancialTransactionEventsType = "ACH_RETURN_PROCESSED"
	FinancialTransactionEventsTypeAuthorization                FinancialTransactionEventsType = "AUTHORIZATION"
	FinancialTransactionEventsTypeAuthorizationAdvice          FinancialTransactionEventsType = "AUTHORIZATION_ADVICE"
	FinancialTransactionEventsTypeAuthorizationExpiry          FinancialTransactionEventsType = "AUTHORIZATION_EXPIRY"
	FinancialTransactionEventsTypeAuthorizationReversal        FinancialTransactionEventsType = "AUTHORIZATION_REVERSAL"
	FinancialTransactionEventsTypeBalanceInquiry               FinancialTransactionEventsType = "BALANCE_INQUIRY"
	FinancialTransactionEventsTypeBillingError                 FinancialTransactionEventsType = "BILLING_ERROR"
	FinancialTransactionEventsTypeBillingErrorReversal         FinancialTransactionEventsType = "BILLING_ERROR_REVERSAL"
	FinancialTransactionEventsTypeCardToCard                   FinancialTransactionEventsType = "CARD_TO_CARD"
	FinancialTransactionEventsTypeCashBack                     FinancialTransactionEventsType = "CASH_BACK"
	FinancialTransactionEventsTypeCashBackReversal             FinancialTransactionEventsType = "CASH_BACK_REVERSAL"
	FinancialTransactionEventsTypeClearing                     FinancialTransactionEventsType = "CLEARING"
	FinancialTransactionEventsTypeCorrectionCredit             FinancialTransactionEventsType = "CORRECTION_CREDIT"
	FinancialTransactionEventsTypeCorrectionDebit              FinancialTransactionEventsType = "CORRECTION_DEBIT"
	FinancialTransactionEventsTypeCreditAuthorization          FinancialTransactionEventsType = "CREDIT_AUTHORIZATION"
	FinancialTransactionEventsTypeCreditAuthorizationAdvice    FinancialTransactionEventsType = "CREDIT_AUTHORIZATION_ADVICE"
	FinancialTransactionEventsTypeCurrencyConversion           FinancialTransactionEventsType = "CURRENCY_CONVERSION"
	FinancialTransactionEventsTypeCurrencyConversionReversal   FinancialTransactionEventsType = "CURRENCY_CONVERSION_REVERSAL"
	FinancialTransactionEventsTypeDisputeWon                   FinancialTransactionEventsType = "DISPUTE_WON"
	FinancialTransactionEventsTypeExternalACHCanceled          FinancialTransactionEventsType = "EXTERNAL_ACH_CANCELED"
	FinancialTransactionEventsTypeExternalACHInitiated         FinancialTransactionEventsType = "EXTERNAL_ACH_INITIATED"
	FinancialTransactionEventsTypeExternalACHReleased          FinancialTransactionEventsType = "EXTERNAL_ACH_RELEASED"
	FinancialTransactionEventsTypeExternalACHReversed          FinancialTransactionEventsType = "EXTERNAL_ACH_REVERSED"
	FinancialTransactionEventsTypeExternalACHSettled           FinancialTransactionEventsType = "EXTERNAL_ACH_SETTLED"
	FinancialTransactionEventsTypeExternalCheckCanceled        FinancialTransactionEventsType = "EXTERNAL_CHECK_CANCELED"
	FinancialTransactionEventsTypeExternalCheckInitiated       FinancialTransactionEventsType = "EXTERNAL_CHECK_INITIATED"
	FinancialTransactionEventsTypeExternalCheckReleased        FinancialTransactionEventsType = "EXTERNAL_CHECK_RELEASED"
	FinancialTransactionEventsTypeExternalCheckReversed        FinancialTransactionEventsType = "EXTERNAL_CHECK_REVERSED"
	FinancialTransactionEventsTypeExternalCheckSettled         FinancialTransactionEventsType = "EXTERNAL_CHECK_SETTLED"
	FinancialTransactionEventsTypeExternalTransferCanceled     FinancialTransactionEventsType = "EXTERNAL_TRANSFER_CANCELED"
	FinancialTransactionEventsTypeExternalTransferInitiated    FinancialTransactionEventsType = "EXTERNAL_TRANSFER_INITIATED"
	FinancialTransactionEventsTypeExternalTransferReleased     FinancialTransactionEventsType = "EXTERNAL_TRANSFER_RELEASED"
	FinancialTransactionEventsTypeExternalTransferReversed     FinancialTransactionEventsType = "EXTERNAL_TRANSFER_REVERSED"
	FinancialTransactionEventsTypeExternalTransferSettled      FinancialTransactionEventsType = "EXTERNAL_TRANSFER_SETTLED"
	FinancialTransactionEventsTypeExternalWireCanceled         FinancialTransactionEventsType = "EXTERNAL_WIRE_CANCELED"
	FinancialTransactionEventsTypeExternalWireInitiated        FinancialTransactionEventsType = "EXTERNAL_WIRE_INITIATED"
	FinancialTransactionEventsTypeExternalWireReleased         FinancialTransactionEventsType = "EXTERNAL_WIRE_RELEASED"
	FinancialTransactionEventsTypeExternalWireReversed         FinancialTransactionEventsType = "EXTERNAL_WIRE_REVERSED"
	FinancialTransactionEventsTypeExternalWireSettled          FinancialTransactionEventsType = "EXTERNAL_WIRE_SETTLED"
	FinancialTransactionEventsTypeFinancialAuthorization       FinancialTransactionEventsType = "FINANCIAL_AUTHORIZATION"
	FinancialTransactionEventsTypeFinancialCreditAuthorization FinancialTransactionEventsType = "FINANCIAL_CREDIT_AUTHORIZATION"
	FinancialTransactionEventsTypeInterest                     FinancialTransactionEventsType = "INTEREST"
	FinancialTransactionEventsTypeInterestReversal             FinancialTransactionEventsType = "INTEREST_REVERSAL"
	FinancialTransactionEventsTypeLatePayment                  FinancialTransactionEventsType = "LATE_PAYMENT"
	FinancialTransactionEventsTypeLatePaymentReversal          FinancialTransactionEventsType = "LATE_PAYMENT_REVERSAL"
	FinancialTransactionEventsTypeProvisionalCredit            FinancialTransactionEventsType = "PROVISIONAL_CREDIT"
	FinancialTransactionEventsTypeProvisionalCreditReversal    FinancialTransactionEventsType = "PROVISIONAL_CREDIT_REVERSAL"
	FinancialTransactionEventsTypeReturn                       FinancialTransactionEventsType = "RETURN"
	FinancialTransactionEventsTypeReturnReversal               FinancialTransactionEventsType = "RETURN_REVERSAL"
	FinancialTransactionEventsTypeTransfer                     FinancialTransactionEventsType = "TRANSFER"
	FinancialTransactionEventsTypeTransferInsufficientFunds    FinancialTransactionEventsType = "TRANSFER_INSUFFICIENT_FUNDS"
)

func (FinancialTransactionEventsType) IsKnown added in v0.27.0 

func (r FinancialTransactionEventsType) IsKnown() bool

type FinancialTransactionListParams 

type FinancialTransactionListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Financial Transaction category to be returned.
	Category param.Field[FinancialTransactionListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Financial Transaction result to be returned.
	Result param.Field[FinancialTransactionListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Financial Transaction status to be returned.
	Status param.Field[FinancialTransactionListParamsStatus] `query:"status"`
}

func (FinancialTransactionListParams) URLQuery 

func (r FinancialTransactionListParams) URLQuery() (v url.Values)

URLQuery serializes FinancialTransactionListParams's query parameters as `url.Values`.

type FinancialTransactionListParamsCategory 

type FinancialTransactionListParamsCategory string

Financial Transaction category to be returned. 

const (
	FinancialTransactionListParamsCategoryACH      FinancialTransactionListParamsCategory = "ACH"
	FinancialTransactionListParamsCategoryCard     FinancialTransactionListParamsCategory = "CARD"
	FinancialTransactionListParamsCategoryTransfer FinancialTransactionListParamsCategory = "TRANSFER"
)

func (FinancialTransactionListParamsCategory) IsKnown added in v0.27.0 

func (r FinancialTransactionListParamsCategory) IsKnown() bool

type FinancialTransactionListParamsResult 

type FinancialTransactionListParamsResult string

Financial Transaction result to be returned. 

const (
	FinancialTransactionListParamsResultApproved FinancialTransactionListParamsResult = "APPROVED"
	FinancialTransactionListParamsResultDeclined FinancialTransactionListParamsResult = "DECLINED"
)

func (FinancialTransactionListParamsResult) IsKnown added in v0.27.0 

func (r FinancialTransactionListParamsResult) IsKnown() bool

type FinancialTransactionListParamsStatus 

type FinancialTransactionListParamsStatus string

Financial Transaction status to be returned. 

const (
	FinancialTransactionListParamsStatusDeclined FinancialTransactionListParamsStatus = "DECLINED"
	FinancialTransactionListParamsStatusExpired  FinancialTransactionListParamsStatus = "EXPIRED"
	FinancialTransactionListParamsStatusPending  FinancialTransactionListParamsStatus = "PENDING"
	FinancialTransactionListParamsStatusReturned FinancialTransactionListParamsStatus = "RETURNED"
	FinancialTransactionListParamsStatusSettled  FinancialTransactionListParamsStatus = "SETTLED"
	FinancialTransactionListParamsStatusVoided   FinancialTransactionListParamsStatus = "VOIDED"
)

func (FinancialTransactionListParamsStatus) IsKnown added in v0.27.0 

func (r FinancialTransactionListParamsStatus) IsKnown() bool

type FinancialTransactionResult 

type FinancialTransactionResult string

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. 

const (
	FinancialTransactionResultApproved FinancialTransactionResult = "APPROVED"
	FinancialTransactionResultDeclined FinancialTransactionResult = "DECLINED"
)

func (FinancialTransactionResult) IsKnown added in v0.27.0 

func (r FinancialTransactionResult) IsKnown() bool

type FinancialTransactionStatus 

type FinancialTransactionStatus string

Status types:

  • `DECLINED` - The transaction was declined.
  • `EXPIRED` - The authorization as it has passed its expiration time. Card transaction only.
  • `PENDING` - The transaction is expected to settle.
  • `RETURNED` - The transaction has been returned.
  • `SETTLED` - The transaction is completed.
  • `VOIDED` - The transaction was voided. Card transaction only.
const (
	FinancialTransactionStatusDeclined FinancialTransactionStatus = "DECLINED"
	FinancialTransactionStatusExpired  FinancialTransactionStatus = "EXPIRED"
	FinancialTransactionStatusPending  FinancialTransactionStatus = "PENDING"
	FinancialTransactionStatusReturned FinancialTransactionStatus = "RETURNED"
	FinancialTransactionStatusSettled  FinancialTransactionStatus = "SETTLED"
	FinancialTransactionStatusVoided   FinancialTransactionStatus = "VOIDED"
)

func (FinancialTransactionStatus) IsKnown added in v0.27.0 

func (r FinancialTransactionStatus) IsKnown() bool

type KYBBeneficialOwnerEntityParam added in v0.29.0 

type KYBBeneficialOwnerEntityParam struct {
	// Business's physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName param.Field[string] `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers param.Field[[]string] `json:"phone_numbers,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName param.Field[string] `json:"dba_business_name"`
	// Parent company name (if applicable).
	ParentCompany param.Field[string] `json:"parent_company"`
}

func (KYBBeneficialOwnerEntityParam) MarshalJSON added in v0.29.0 

func (r KYBBeneficialOwnerEntityParam) MarshalJSON() (data []byte, err error)

type KYBBeneficialOwnerIndividualParam added in v0.29.0 

type KYBBeneficialOwnerIndividualParam struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[string] `json:"dob,required"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email param.Field[string] `json:"email,required"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name,required"`
	// Government-issued identification number (required for identity verification and
	// compliance with banking regulations). Social Security Numbers (SSN) and
	// Individual Taxpayer Identification Numbers (ITIN) are currently supported,
	// entered as full nine-digits, with or without hyphens
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber param.Field[string] `json:"phone_number"`
}

Individuals associated with a KYB application. Phone number is optional.

func (KYBBeneficialOwnerIndividualParam) MarshalJSON added in v0.29.0 

func (r KYBBeneficialOwnerIndividualParam) MarshalJSON() (data []byte, err error)

type KYBBusinessEntityParam 

type KYBBusinessEntityParam struct {
	// Business's physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Government-issued identification number. US Federal Employer Identification
	// Numbers (EIN) are currently supported, entered as full nine-digits, with or
	// without hyphens.
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Legal (formal) business name.
	LegalBusinessName param.Field[string] `json:"legal_business_name,required"`
	// One or more of the business's phone number(s), entered as a list in E.164
	// format.
	PhoneNumbers param.Field[[]string] `json:"phone_numbers,required"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName param.Field[string] `json:"dba_business_name"`
	// Parent company name (if applicable).
	ParentCompany param.Field[string] `json:"parent_company"`
}

Information for business for which the account is being opened and KYB is being run.

func (KYBBusinessEntityParam) MarshalJSON 

func (r KYBBusinessEntityParam) MarshalJSON() (data []byte, err error)

type KYBControlPersonParam 

type KYBControlPersonParam struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[string] `json:"dob,required"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email param.Field[string] `json:"email,required"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name,required"`
	// Government-issued identification number (required for identity verification and
	// compliance with banking regulations). Social Security Numbers (SSN) and
	// Individual Taxpayer Identification Numbers (ITIN) are currently supported,
	// entered as full nine-digits, with or without hyphens
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber param.Field[string] `json:"phone_number"`
}

An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above. See [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.

func (KYBControlPersonParam) MarshalJSON 

func (r KYBControlPersonParam) MarshalJSON() (data []byte, err error)

type KYBParam 

type KYBParam struct {
	// List of all entities with >25% ownership in the company. If no entity or
	// individual owns >25% of the company, and the largest shareholder is an entity,
	// please identify them in this field. See
	// [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
	// (Section I) for more background. If no business owner is an entity, pass in an
	// empty list. However, either this parameter or `beneficial_owner_individuals`
	// must be populated. on entities that should be included.
	BeneficialOwnerEntities param.Field[[]KYBBeneficialOwnerEntityParam] `json:"beneficial_owner_entities,required"`
	// List of all direct and indirect individuals with >25% ownership in the company.
	// If no entity or individual owns >25% of the company, and the largest shareholder
	// is an individual, please identify them in this field. See
	// [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
	// (Section I) for more background on individuals that should be included. If no
	// individual is an entity, pass in an empty list. However, either this parameter
	// or `beneficial_owner_entities` must be populated.
	BeneficialOwnerIndividuals param.Field[[]KYBBeneficialOwnerIndividualParam] `json:"beneficial_owner_individuals,required"`
	// Information for business for which the account is being opened and KYB is being
	// run.
	BusinessEntity param.Field[KYBBusinessEntityParam] `json:"business_entity,required"`
	// An individual with significant responsibility for managing the legal entity
	// (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
	// Officer, Managing Member, General Partner, President, Vice President, or
	// Treasurer). This can be an executive, or someone who will have program-wide
	// access to the cards that Lithic will provide. In some cases, this individual
	// could also be a beneficial owner listed above. See
	// [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
	// (Section II) for more background.
	ControlPerson param.Field[KYBControlPersonParam] `json:"control_person,required"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness param.Field[string] `json:"nature_of_business,required"`
	// An RFC 3339 timestamp indicating when the account holder accepted the applicable
	// legal agreements (e.g., cardholder terms) as agreed upon during API customer's
	// implementation with Lithic.
	TosTimestamp param.Field[string] `json:"tos_timestamp,required"`
	// Specifies the type of KYB workflow to run.
	Workflow param.Field[KYBWorkflow] `json:"workflow,required"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// An RFC 3339 timestamp indicating when precomputed KYC was completed on the
	// business with a pass result.
	//
	// This field is required only if workflow type is `KYB_BYO`.
	KYBPassedTimestamp param.Field[string] `json:"kyb_passed_timestamp"`
	// Company website URL.
	WebsiteURL param.Field[string] `json:"website_url"`
}

func (KYBParam) MarshalJSON 

func (r KYBParam) MarshalJSON() (data []byte, err error)

type KYBWorkflow 

type KYBWorkflow string

Specifies the type of KYB workflow to run. 

const (
	KYBWorkflowKYBBasic KYBWorkflow = "KYB_BASIC"
	KYBWorkflowKYBByo   KYBWorkflow = "KYB_BYO"
)

func (KYBWorkflow) IsKnown added in v0.29.0 

func (r KYBWorkflow) IsKnown() bool

type KYCExemptKYCExemptionType 

type KYCExemptKYCExemptionType string

Specifies the type of KYC Exempt user 

const (
	KYCExemptKYCExemptionTypeAuthorizedUser  KYCExemptKYCExemptionType = "AUTHORIZED_USER"
	KYCExemptKYCExemptionTypePrepaidCardUser KYCExemptKYCExemptionType = "PREPAID_CARD_USER"
)

func (KYCExemptKYCExemptionType) IsKnown added in v0.29.0 

func (r KYCExemptKYCExemptionType) IsKnown() bool

type KYCExemptParam 

type KYCExemptParam struct {
	// KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// The KYC Exempt user's email
	Email param.Field[string] `json:"email,required"`
	// The KYC Exempt user's first name
	FirstName param.Field[string] `json:"first_name,required"`
	// Specifies the type of KYC Exempt user
	KYCExemptionType param.Field[KYCExemptKYCExemptionType] `json:"kyc_exemption_type,required"`
	// The KYC Exempt user's last name
	LastName param.Field[string] `json:"last_name,required"`
	// The KYC Exempt user's phone number
	PhoneNumber param.Field[string] `json:"phone_number,required"`
	// Specifies the workflow type. This must be 'KYC_EXEMPT'
	Workflow param.Field[KYCExemptWorkflow] `json:"workflow,required"`
	// Only applicable for customers using the KYC-Exempt workflow to enroll authorized
	// users of businesses. Pass the account_token of the enrolled business associated
	// with the AUTHORIZED_USER in this field.
	BusinessAccountToken param.Field[string] `json:"business_account_token"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
}

func (KYCExemptParam) MarshalJSON 

func (r KYCExemptParam) MarshalJSON() (data []byte, err error)

type KYCExemptWorkflow 

type KYCExemptWorkflow string

Specifies the workflow type. This must be 'KYC_EXEMPT' 

const (
	KYCExemptWorkflowKYCExempt KYCExemptWorkflow = "KYC_EXEMPT"
)

func (KYCExemptWorkflow) IsKnown added in v0.29.0 

func (r KYCExemptWorkflow) IsKnown() bool

type KYCIndividualParam 

type KYCIndividualParam struct {
	// Individual's current address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
	Address param.Field[shared.AddressParam] `json:"address,required"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[string] `json:"dob,required"`
	// Individual's email address. If utilizing Lithic for chargeback processing, this
	// customer email address may be used to communicate dispute status and resolution.
	Email param.Field[string] `json:"email,required"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name,required"`
	// Government-issued identification number (required for identity verification and
	// compliance with banking regulations). Social Security Numbers (SSN) and
	// Individual Taxpayer Identification Numbers (ITIN) are currently supported,
	// entered as full nine-digits, with or without hyphens
	GovernmentID param.Field[string] `json:"government_id,required"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name,required"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber param.Field[string] `json:"phone_number,required"`
}

Information on individual for whom the account is being opened and KYC is being run.

func (KYCIndividualParam) MarshalJSON 

func (r KYCIndividualParam) MarshalJSON() (data []byte, err error)

type KYCParam 

type KYCParam struct {
	// Information on individual for whom the account is being opened and KYC is being
	// run.
	Individual param.Field[KYCIndividualParam] `json:"individual,required"`
	// An RFC 3339 timestamp indicating when the account holder accepted the applicable
	// legal agreements (e.g., cardholder terms) as agreed upon during API customer's
	// implementation with Lithic.
	TosTimestamp param.Field[string] `json:"tos_timestamp,required"`
	// Specifies the type of KYC workflow to run.
	Workflow param.Field[KYCWorkflow] `json:"workflow,required"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// An RFC 3339 timestamp indicating when precomputed KYC was completed on the
	// individual with a pass result.
	//
	// This field is required only if workflow type is `KYC_BYO`.
	KYCPassedTimestamp param.Field[string] `json:"kyc_passed_timestamp"`
}

func (KYCParam) MarshalJSON 

func (r KYCParam) MarshalJSON() (data []byte, err error)

type KYCWorkflow 

type KYCWorkflow string

Specifies the type of KYC workflow to run. 

const (
	KYCWorkflowKYCAdvanced KYCWorkflow = "KYC_ADVANCED"
	KYCWorkflowKYCBasic    KYCWorkflow = "KYC_BASIC"
	KYCWorkflowKYCByo      KYCWorkflow = "KYC_BYO"
)

func (KYCWorkflow) IsKnown added in v0.29.0 

func (r KYCWorkflow) IsKnown() bool

type LoanTape added in v0.55.0 

type LoanTape struct {
	// Globally unique identifier for a loan tape
	Token           string                  `json:"token,required"`
	AccountStanding LoanTapeAccountStanding `json:"account_standing,required"`
	// Amount of credit available to spend in cents
	AvailableCredit int64            `json:"available_credit,required"`
	Balances        LoanTapeBalances `json:"balances,required"`
	// Timestamp of when the loan tape was created
	Created time.Time `json:"created,required" format:"date-time"`
	// For prepay accounts, this is the minimum prepay balance that must be maintained.
	// For charge card accounts, this is the maximum credit balance extended by a
	// lender
	CreditLimit int64 `json:"credit_limit,required"`
	// Globally unique identifier for a credit product
	CreditProductToken string `json:"credit_product_token,required"`
	// Date of transactions that this loan tape covers
	Date      time.Time         `json:"date,required" format:"date"`
	DayTotals LoanTapeDayTotals `json:"day_totals,required"`
	// Balance at the end of the day
	EndingBalance int64 `json:"ending_balance,required"`
	// Excess credits in the form of provisional credits, payments, or purchase
	// refunds. If positive, the account is in net credit state with no outstanding
	// balances. An overpayment could land an account in this state
	ExcessCredits int64 `json:"excess_credits,required"`
	// Globally unique identifier for a financial account
	FinancialAccountToken    string                           `json:"financial_account_token,required" format:"uuid"`
	InterestDetails          LoanTapeInterestDetails          `json:"interest_details,required,nullable"`
	MinimumPaymentBalance    LoanTapeMinimumPaymentBalance    `json:"minimum_payment_balance,required"`
	PaymentAllocation        LoanTapePaymentAllocation        `json:"payment_allocation,required"`
	PeriodTotals             LoanTapePeriodTotals             `json:"period_totals,required"`
	PreviousStatementBalance LoanTapePreviousStatementBalance `json:"previous_statement_balance,required"`
	// Balance at the start of the day
	StartingBalance int64 `json:"starting_balance,required"`
	// Timestamp of when the loan tape was updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// Version number of the loan tape. This starts at 1
	Version   int64             `json:"version,required"`
	YtdTotals LoanTapeYtdTotals `json:"ytd_totals,required"`
	// Interest tier to which this account belongs to
	Tier string       `json:"tier"`
	JSON loanTapeJSON `json:"-"`
}

func (*LoanTape) UnmarshalJSON added in v0.55.0 

func (r *LoanTape) UnmarshalJSON(data []byte) (err error)

type LoanTapeAccountStanding added in v0.55.0 

type LoanTapeAccountStanding struct {
	// Number of consecutive full payments made
	ConsecutiveFullPaymentsMade int64 `json:"consecutive_full_payments_made,required"`
	// Number of consecutive minimum payments made
	ConsecutiveMinimumPaymentsMade int64 `json:"consecutive_minimum_payments_made,required"`
	// Number of consecutive minimum payments missed
	ConsecutiveMinimumPaymentsMissed int64 `json:"consecutive_minimum_payments_missed,required"`
	// Number of days past due
	DaysPastDue int64 `json:"days_past_due,required"`
	// Whether the account currently has grace or not
	HasGrace bool `json:"has_grace,required"`
	// Current overall period number
	PeriodNumber int64                              `json:"period_number,required"`
	PeriodState  LoanTapeAccountStandingPeriodState `json:"period_state,required"`
	JSON         loanTapeAccountStandingJSON        `json:"-"`
}

func (*LoanTapeAccountStanding) UnmarshalJSON added in v0.55.0 

func (r *LoanTapeAccountStanding) UnmarshalJSON(data []byte) (err error)

type LoanTapeAccountStandingPeriodState added in v0.55.0 

type LoanTapeAccountStandingPeriodState string
const (
	LoanTapeAccountStandingPeriodStateStandard LoanTapeAccountStandingPeriodState = "STANDARD"
	LoanTapeAccountStandingPeriodStatePromo    LoanTapeAccountStandingPeriodState = "PROMO"
	LoanTapeAccountStandingPeriodStatePenalty  LoanTapeAccountStandingPeriodState = "PENALTY"
)

func (LoanTapeAccountStandingPeriodState) IsKnown added in v0.55.0 

func (r LoanTapeAccountStandingPeriodState) IsKnown() bool

type LoanTapeBalances added in v0.58.0 

type LoanTapeBalances struct {
	// Amount due for the prior billing cycle. Any amounts not fully paid off on this
	// due date will be considered past due the next day
	Due LoanTapeBalancesDue `json:"due,required"`
	// Amount due for the current billing cycle. Any amounts not paid off by early
	// payments or credits will be considered due at the end of the current billing
	// period
	NextStatementDue LoanTapeBalancesNextStatementDue `json:"next_statement_due,required"`
	// Amount not paid off on previous due dates
	PastDue LoanTapeBalancesPastDue `json:"past_due,required"`
	// Amount due for the past billing cycles.
	PastStatementsDue LoanTapeBalancesPastStatementsDue `json:"past_statements_due,required"`
	JSON              loanTapeBalancesJSON              `json:"-"`
}

func (*LoanTapeBalances) UnmarshalJSON added in v0.58.0 

func (r *LoanTapeBalances) UnmarshalJSON(data []byte) (err error)

type LoanTapeBalancesDue added in v0.58.0 

type LoanTapeBalancesDue struct {
	Fees      int64                   `json:"fees,required"`
	Interest  int64                   `json:"interest,required"`
	Principal int64                   `json:"principal,required"`
	JSON      loanTapeBalancesDueJSON `json:"-"`
}

Amount due for the prior billing cycle. Any amounts not fully paid off on this due date will be considered past due the next day

func (*LoanTapeBalancesDue) UnmarshalJSON added in v0.58.0 

func (r *LoanTapeBalancesDue) UnmarshalJSON(data []byte) (err error)

type LoanTapeBalancesNextStatementDue added in v0.58.0 

type LoanTapeBalancesNextStatementDue struct {
	Fees      int64                                `json:"fees,required"`
	Interest  int64                                `json:"interest,required"`
	Principal int64                                `json:"principal,required"`
	JSON      loanTapeBalancesNextStatementDueJSON `json:"-"`
}

Amount due for the current billing cycle. Any amounts not paid off by early payments or credits will be considered due at the end of the current billing period

func (*LoanTapeBalancesNextStatementDue) UnmarshalJSON added in v0.58.0 

func (r *LoanTapeBalancesNextStatementDue) UnmarshalJSON(data []byte) (err error)

type LoanTapeBalancesPastDue added in v0.58.0 

type LoanTapeBalancesPastDue struct {
	Fees      int64                       `json:"fees,required"`
	Interest  int64                       `json:"interest,required"`
	Principal int64                       `json:"principal,required"`
	JSON      loanTapeBalancesPastDueJSON `json:"-"`
}

Amount not paid off on previous due dates

func (*LoanTapeBalancesPastDue) UnmarshalJSON added in v0.58.0 

func (r *LoanTapeBalancesPastDue) UnmarshalJSON(data []byte) (err error)

type LoanTapeBalancesPastStatementsDue added in v0.58.0 

type LoanTapeBalancesPastStatementsDue struct {
	Fees      int64                                 `json:"fees,required"`
	Interest  int64                                 `json:"interest,required"`
	Principal int64                                 `json:"principal,required"`
	JSON      loanTapeBalancesPastStatementsDueJSON `json:"-"`
}

Amount due for the past billing cycles.

func (*LoanTapeBalancesPastStatementsDue) UnmarshalJSON added in v0.58.0 

func (r *LoanTapeBalancesPastStatementsDue) UnmarshalJSON(data []byte) (err error)

type LoanTapeDayTotals added in v0.55.0 

type LoanTapeDayTotals struct {
	// Opening balance transferred from previous account in cents
	BalanceTransfers int64 `json:"balance_transfers,required"`
	// ATM and cashback transactions in cents
	CashAdvances int64 `json:"cash_advances,required"`
	// Volume of credit management operation transactions less any balance transfers in
	// cents
	Credits int64 `json:"credits,required"`
	// Volume of debit management operation transactions less any interest in cents
	Fees int64 `json:"fees,required"`
	// Interest accrued in cents
	Interest int64 `json:"interest,required"`
	// Any funds transfers which affective the balance in cents
	Payments int64 `json:"payments,required"`
	// Net card transaction volume less any cash advances in cents
	Purchases int64                 `json:"purchases,required"`
	JSON      loanTapeDayTotalsJSON `json:"-"`
}

func (*LoanTapeDayTotals) UnmarshalJSON added in v0.55.0 

func (r *LoanTapeDayTotals) UnmarshalJSON(data []byte) (err error)

type LoanTapeInterestDetails added in v0.60.0 

type LoanTapeInterestDetails struct {
	ActualInterestCharged     int64                                            `json:"actual_interest_charged,required,nullable"`
	DailyBalanceAmounts       LoanTapeInterestDetailsDailyBalanceAmounts       `json:"daily_balance_amounts,required"`
	EffectiveApr              LoanTapeInterestDetailsEffectiveApr              `json:"effective_apr,required"`
	InterestCalculationMethod LoanTapeInterestDetailsInterestCalculationMethod `json:"interest_calculation_method,required"`
	InterestForPeriod         LoanTapeInterestDetailsInterestForPeriod         `json:"interest_for_period,required"`
	PrimeRate                 string                                           `json:"prime_rate,required,nullable"`
	MinimumInterestCharged    int64                                            `json:"minimum_interest_charged,nullable"`
	JSON                      loanTapeInterestDetailsJSON                      `json:"-"`
}

func (*LoanTapeInterestDetails) UnmarshalJSON added in v0.60.0 

func (r *LoanTapeInterestDetails) UnmarshalJSON(data []byte) (err error)

type LoanTapeInterestDetailsDailyBalanceAmounts added in v0.60.0 

type LoanTapeInterestDetailsDailyBalanceAmounts struct {
	BalanceTransfers string                                         `json:"balance_transfers,required"`
	CashAdvances     string                                         `json:"cash_advances,required"`
	Purchases        string                                         `json:"purchases,required"`
	JSON             loanTapeInterestDetailsDailyBalanceAmountsJSON `json:"-"`
}

func (*LoanTapeInterestDetailsDailyBalanceAmounts) UnmarshalJSON added in v0.60.0 

func (r *LoanTapeInterestDetailsDailyBalanceAmounts) UnmarshalJSON(data []byte) (err error)

type LoanTapeInterestDetailsEffectiveApr added in v0.60.0 

type LoanTapeInterestDetailsEffectiveApr struct {
	BalanceTransfers string                                  `json:"balance_transfers,required"`
	CashAdvances     string                                  `json:"cash_advances,required"`
	Purchases        string                                  `json:"purchases,required"`
	JSON             loanTapeInterestDetailsEffectiveAprJSON `json:"-"`
}

func (*LoanTapeInterestDetailsEffectiveApr) UnmarshalJSON added in v0.60.0 

func (r *LoanTapeInterestDetailsEffectiveApr) UnmarshalJSON(data []byte) (err error)

type LoanTapeInterestDetailsInterestCalculationMethod added in v0.60.0 

type LoanTapeInterestDetailsInterestCalculationMethod string
const (
	LoanTapeInterestDetailsInterestCalculationMethodDaily        LoanTapeInterestDetailsInterestCalculationMethod = "DAILY"
	LoanTapeInterestDetailsInterestCalculationMethodAverageDaily LoanTapeInterestDetailsInterestCalculationMethod = "AVERAGE_DAILY"
)

func (LoanTapeInterestDetailsInterestCalculationMethod) IsKnown added in v0.60.0 

func (r LoanTapeInterestDetailsInterestCalculationMethod) IsKnown() bool

type LoanTapeInterestDetailsInterestForPeriod added in v0.60.0 

type LoanTapeInterestDetailsInterestForPeriod struct {
	BalanceTransfers string                                       `json:"balance_transfers,required"`
	CashAdvances     string                                       `json:"cash_advances,required"`
	Purchases        string                                       `json:"purchases,required"`
	JSON             loanTapeInterestDetailsInterestForPeriodJSON `json:"-"`
}

func (*LoanTapeInterestDetailsInterestForPeriod) UnmarshalJSON added in v0.60.0 

func (r *LoanTapeInterestDetailsInterestForPeriod) UnmarshalJSON(data []byte) (err error)

type LoanTapeMinimumPaymentBalance added in v0.55.0 

type LoanTapeMinimumPaymentBalance struct {
	Amount    int64                             `json:"amount,required"`
	Remaining int64                             `json:"remaining,required"`
	JSON      loanTapeMinimumPaymentBalanceJSON `json:"-"`
}

func (*LoanTapeMinimumPaymentBalance) UnmarshalJSON added in v0.55.0 

func (r *LoanTapeMinimumPaymentBalance) UnmarshalJSON(data []byte) (err error)

type LoanTapePaymentAllocation added in v0.55.0 

type LoanTapePaymentAllocation struct {
	Fees      int64                         `json:"fees,required"`
	Interest  int64                         `json:"interest,required"`
	Principal int64                         `json:"principal,required"`
	JSON      loanTapePaymentAllocationJSON `json:"-"`
}

func (*LoanTapePaymentAllocation) UnmarshalJSON added in v0.55.0 

func (r *LoanTapePaymentAllocation) UnmarshalJSON(data []byte) (err error)

type LoanTapePeriodTotals added in v0.55.0 

type LoanTapePeriodTotals struct {
	// Opening balance transferred from previous account in cents
	BalanceTransfers int64 `json:"balance_transfers,required"`
	// ATM and cashback transactions in cents
	CashAdvances int64 `json:"cash_advances,required"`
	// Volume of credit management operation transactions less any balance transfers in
	// cents
	Credits int64 `json:"credits,required"`
	// Volume of debit management operation transactions less any interest in cents
	Fees int64 `json:"fees,required"`
	// Interest accrued in cents
	Interest int64 `json:"interest,required"`
	// Any funds transfers which affective the balance in cents
	Payments int64 `json:"payments,required"`
	// Net card transaction volume less any cash advances in cents
	Purchases int64                    `json:"purchases,required"`
	JSON      loanTapePeriodTotalsJSON `json:"-"`
}

func (*LoanTapePeriodTotals) UnmarshalJSON added in v0.55.0 

func (r *LoanTapePeriodTotals) UnmarshalJSON(data []byte) (err error)

type LoanTapePreviousStatementBalance added in v0.56.0 

type LoanTapePreviousStatementBalance struct {
	Amount    int64                                `json:"amount,required"`
	Remaining int64                                `json:"remaining,required"`
	JSON      loanTapePreviousStatementBalanceJSON `json:"-"`
}

func (*LoanTapePreviousStatementBalance) UnmarshalJSON added in v0.56.0 

func (r *LoanTapePreviousStatementBalance) UnmarshalJSON(data []byte) (err error)

type LoanTapeYtdTotals added in v0.55.0 

type LoanTapeYtdTotals struct {
	// Opening balance transferred from previous account in cents
	BalanceTransfers int64 `json:"balance_transfers,required"`
	// ATM and cashback transactions in cents
	CashAdvances int64 `json:"cash_advances,required"`
	// Volume of credit management operation transactions less any balance transfers in
	// cents
	Credits int64 `json:"credits,required"`
	// Volume of debit management operation transactions less any interest in cents
	Fees int64 `json:"fees,required"`
	// Interest accrued in cents
	Interest int64 `json:"interest,required"`
	// Any funds transfers which affective the balance in cents
	Payments int64 `json:"payments,required"`
	// Net card transaction volume less any cash advances in cents
	Purchases int64                 `json:"purchases,required"`
	JSON      loanTapeYtdTotalsJSON `json:"-"`
}

func (*LoanTapeYtdTotals) UnmarshalJSON added in v0.55.0 

func (r *LoanTapeYtdTotals) UnmarshalJSON(data []byte) (err error)

type ManagementOperationListParams added in v0.55.0 

type ManagementOperationListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin                param.Field[time.Time] `query:"begin" format:"date-time"`
	BusinessAccountToken param.Field[string]    `query:"business_account_token" format:"uuid"`
	// Management operation category to be returned.
	Category param.Field[ManagementOperationListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Globally unique identifier for the financial account. Accepted type dependent on
	// the program's use case.
	FinancialAccountToken param.Field[string] `query:"financial_account_token" format:"uuid"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Management operation status to be returned.
	Status param.Field[ManagementOperationListParamsStatus] `query:"status"`
}

func (ManagementOperationListParams) URLQuery added in v0.55.0 

func (r ManagementOperationListParams) URLQuery() (v url.Values)

URLQuery serializes ManagementOperationListParams's query parameters as `url.Values`.

type ManagementOperationListParamsCategory added in v0.55.0 

type ManagementOperationListParamsCategory string

Management operation category to be returned. 

const (
	ManagementOperationListParamsCategoryManagementFee        ManagementOperationListParamsCategory = "MANAGEMENT_FEE"
	ManagementOperationListParamsCategoryManagementDispute    ManagementOperationListParamsCategory = "MANAGEMENT_DISPUTE"
	ManagementOperationListParamsCategoryManagementReward     ManagementOperationListParamsCategory = "MANAGEMENT_REWARD"
	ManagementOperationListParamsCategoryManagementAdjustment ManagementOperationListParamsCategory = "MANAGEMENT_ADJUSTMENT"
)

func (ManagementOperationListParamsCategory) IsKnown added in v0.55.0 

func (r ManagementOperationListParamsCategory) IsKnown() bool

type ManagementOperationListParamsStatus added in v0.55.0 

type ManagementOperationListParamsStatus string

Management operation status to be returned. 

const (
	ManagementOperationListParamsStatusPending  ManagementOperationListParamsStatus = "PENDING"
	ManagementOperationListParamsStatusSettled  ManagementOperationListParamsStatus = "SETTLED"
	ManagementOperationListParamsStatusDeclined ManagementOperationListParamsStatus = "DECLINED"
	ManagementOperationListParamsStatusReversed ManagementOperationListParamsStatus = "REVERSED"
	ManagementOperationListParamsStatusCanceled ManagementOperationListParamsStatus = "CANCELED"
)

func (ManagementOperationListParamsStatus) IsKnown added in v0.55.0 

func (r ManagementOperationListParamsStatus) IsKnown() bool

type ManagementOperationNewParams added in v0.55.0 

type ManagementOperationNewParams struct {
	Amount                param.Field[int64]                                 `json:"amount,required"`
	Category              param.Field[ManagementOperationNewParamsCategory]  `json:"category,required"`
	Direction             param.Field[ManagementOperationNewParamsDirection] `json:"direction,required"`
	EffectiveDate         param.Field[time.Time]                             `json:"effective_date,required" format:"date"`
	EventType             param.Field[ManagementOperationNewParamsEventType] `json:"event_type,required"`
	FinancialAccountToken param.Field[string]                                `json:"financial_account_token,required" format:"uuid"`
	Token                 param.Field[string]                                `json:"token" format:"uuid"`
	Memo                  param.Field[string]                                `json:"memo"`
	Subtype               param.Field[string]                                `json:"subtype"`
	UserDefinedID         param.Field[string]                                `json:"user_defined_id"`
}

func (ManagementOperationNewParams) MarshalJSON added in v0.55.0 

func (r ManagementOperationNewParams) MarshalJSON() (data []byte, err error)

type ManagementOperationNewParamsCategory added in v0.55.0 

type ManagementOperationNewParamsCategory string
const (
	ManagementOperationNewParamsCategoryManagementFee        ManagementOperationNewParamsCategory = "MANAGEMENT_FEE"
	ManagementOperationNewParamsCategoryManagementDispute    ManagementOperationNewParamsCategory = "MANAGEMENT_DISPUTE"
	ManagementOperationNewParamsCategoryManagementReward     ManagementOperationNewParamsCategory = "MANAGEMENT_REWARD"
	ManagementOperationNewParamsCategoryManagementAdjustment ManagementOperationNewParamsCategory = "MANAGEMENT_ADJUSTMENT"
)

func (ManagementOperationNewParamsCategory) IsKnown added in v0.55.0 

func (r ManagementOperationNewParamsCategory) IsKnown() bool

type ManagementOperationNewParamsDirection added in v0.55.0 

type ManagementOperationNewParamsDirection string
const (
	ManagementOperationNewParamsDirectionCredit ManagementOperationNewParamsDirection = "CREDIT"
	ManagementOperationNewParamsDirectionDebit  ManagementOperationNewParamsDirection = "DEBIT"
)

func (ManagementOperationNewParamsDirection) IsKnown added in v0.55.0 

func (r ManagementOperationNewParamsDirection) IsKnown() bool

type ManagementOperationNewParamsEventType added in v0.55.0 

type ManagementOperationNewParamsEventType string
const (
	ManagementOperationNewParamsEventTypeCashBack                   ManagementOperationNewParamsEventType = "CASH_BACK"
	ManagementOperationNewParamsEventTypeCurrencyConversion         ManagementOperationNewParamsEventType = "CURRENCY_CONVERSION"
	ManagementOperationNewParamsEventTypeInterest                   ManagementOperationNewParamsEventType = "INTEREST"
	ManagementOperationNewParamsEventTypeLatePayment                ManagementOperationNewParamsEventType = "LATE_PAYMENT"
	ManagementOperationNewParamsEventTypeBillingError               ManagementOperationNewParamsEventType = "BILLING_ERROR"
	ManagementOperationNewParamsEventTypeProvisionalCredit          ManagementOperationNewParamsEventType = "PROVISIONAL_CREDIT"
	ManagementOperationNewParamsEventTypeCashBackReversal           ManagementOperationNewParamsEventType = "CASH_BACK_REVERSAL"
	ManagementOperationNewParamsEventTypeCurrencyConversionReversal ManagementOperationNewParamsEventType = "CURRENCY_CONVERSION_REVERSAL"
	ManagementOperationNewParamsEventTypeInterestReversal           ManagementOperationNewParamsEventType = "INTEREST_REVERSAL"
	ManagementOperationNewParamsEventTypeLatePaymentReversal        ManagementOperationNewParamsEventType = "LATE_PAYMENT_REVERSAL"
	ManagementOperationNewParamsEventTypeBillingErrorReversal       ManagementOperationNewParamsEventType = "BILLING_ERROR_REVERSAL"
	ManagementOperationNewParamsEventTypeProvisionalCreditReversal  ManagementOperationNewParamsEventType = "PROVISIONAL_CREDIT_REVERSAL"
)

func (ManagementOperationNewParamsEventType) IsKnown added in v0.55.0 

func (r ManagementOperationNewParamsEventType) IsKnown() bool

type ManagementOperationReverseParams added in v0.55.0 

type ManagementOperationReverseParams struct {
	EffectiveDate param.Field[time.Time] `json:"effective_date,required" format:"date"`
	Memo          param.Field[string]    `json:"memo"`
}

func (ManagementOperationReverseParams) MarshalJSON added in v0.55.0 

func (r ManagementOperationReverseParams) MarshalJSON() (data []byte, err error)

type ManagementOperationService added in v0.55.0 

type ManagementOperationService struct {
	Options []option.RequestOption
}

ManagementOperationService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewManagementOperationService method instead.

func NewManagementOperationService added in v0.55.0 

func NewManagementOperationService(opts ...option.RequestOption) (r *ManagementOperationService)

NewManagementOperationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ManagementOperationService) Get added in v0.55.0 

func (r *ManagementOperationService) Get(ctx context.Context, managementOperationToken string, opts ...option.RequestOption) (res *ManagementOperationTransaction, err error)

Get management operation

func (*ManagementOperationService) List added in v0.55.0 

func (r *ManagementOperationService) List(ctx context.Context, query ManagementOperationListParams, opts ...option.RequestOption) (res *pagination.CursorPage[ManagementOperationTransaction], err error)

List management operations

func (*ManagementOperationService) ListAutoPaging added in v0.55.0 

func (r *ManagementOperationService) ListAutoPaging(ctx context.Context, query ManagementOperationListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[ManagementOperationTransaction]

List management operations

func (*ManagementOperationService) New added in v0.55.0 

func (r *ManagementOperationService) New(ctx context.Context, body ManagementOperationNewParams, opts ...option.RequestOption) (res *ManagementOperationTransaction, err error)

Create management operation

func (*ManagementOperationService) Reverse added in v0.55.0 

func (r *ManagementOperationService) Reverse(ctx context.Context, managementOperationToken string, body ManagementOperationReverseParams, opts ...option.RequestOption) (res *ManagementOperationTransaction, err error)

Reverse a management operation

type ManagementOperationTransaction added in v0.55.0 

type ManagementOperationTransaction struct {
	Token                 string                                  `json:"token,required" format:"uuid"`
	Category              ManagementOperationTransactionCategory  `json:"category,required"`
	Created               time.Time                               `json:"created,required" format:"date-time"`
	Currency              string                                  `json:"currency,required"`
	Direction             ManagementOperationTransactionDirection `json:"direction,required"`
	Events                []ManagementOperationTransactionEvent   `json:"events,required"`
	FinancialAccountToken string                                  `json:"financial_account_token,required" format:"uuid"`
	PendingAmount         int64                                   `json:"pending_amount,required"`
	Result                ManagementOperationTransactionResult    `json:"result,required"`
	SettledAmount         int64                                   `json:"settled_amount,required"`
	Status                ManagementOperationTransactionStatus    `json:"status,required"`
	Updated               time.Time                               `json:"updated,required" format:"date-time"`
	UserDefinedID         string                                  `json:"user_defined_id"`
	JSON                  managementOperationTransactionJSON      `json:"-"`
}

func (*ManagementOperationTransaction) UnmarshalJSON added in v0.55.0 

func (r *ManagementOperationTransaction) UnmarshalJSON(data []byte) (err error)

type ManagementOperationTransactionCategory added in v0.55.0 

type ManagementOperationTransactionCategory string
const (
	ManagementOperationTransactionCategoryManagementFee        ManagementOperationTransactionCategory = "MANAGEMENT_FEE"
	ManagementOperationTransactionCategoryManagementDispute    ManagementOperationTransactionCategory = "MANAGEMENT_DISPUTE"
	ManagementOperationTransactionCategoryManagementReward     ManagementOperationTransactionCategory = "MANAGEMENT_REWARD"
	ManagementOperationTransactionCategoryManagementAdjustment ManagementOperationTransactionCategory = "MANAGEMENT_ADJUSTMENT"
)

func (ManagementOperationTransactionCategory) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionCategory) IsKnown() bool

type ManagementOperationTransactionDirection added in v0.55.0 

type ManagementOperationTransactionDirection string
const (
	ManagementOperationTransactionDirectionCredit ManagementOperationTransactionDirection = "CREDIT"
	ManagementOperationTransactionDirectionDebit  ManagementOperationTransactionDirection = "DEBIT"
)

func (ManagementOperationTransactionDirection) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionDirection) IsKnown() bool

type ManagementOperationTransactionEvent added in v0.55.0 

type ManagementOperationTransactionEvent struct {
	Token           string                                               `json:"token,required" format:"uuid"`
	Amount          int64                                                `json:"amount,required"`
	Created         time.Time                                            `json:"created,required" format:"date-time"`
	DetailedResults []ManagementOperationTransactionEventsDetailedResult `json:"detailed_results,required"`
	EffectiveDate   time.Time                                            `json:"effective_date,required" format:"date"`
	Memo            string                                               `json:"memo,required"`
	Result          ManagementOperationTransactionEventsResult           `json:"result,required"`
	Type            ManagementOperationTransactionEventsType             `json:"type,required"`
	Subtype         string                                               `json:"subtype"`
	JSON            managementOperationTransactionEventJSON              `json:"-"`
}

func (*ManagementOperationTransactionEvent) UnmarshalJSON added in v0.55.0 

func (r *ManagementOperationTransactionEvent) UnmarshalJSON(data []byte) (err error)

type ManagementOperationTransactionEventsDetailedResult added in v0.55.0 

type ManagementOperationTransactionEventsDetailedResult string
const (
	ManagementOperationTransactionEventsDetailedResultApproved ManagementOperationTransactionEventsDetailedResult = "APPROVED"
)

func (ManagementOperationTransactionEventsDetailedResult) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionEventsDetailedResult) IsKnown() bool

type ManagementOperationTransactionEventsResult added in v0.55.0 

type ManagementOperationTransactionEventsResult string
const (
	ManagementOperationTransactionEventsResultApproved ManagementOperationTransactionEventsResult = "APPROVED"
	ManagementOperationTransactionEventsResultDeclined ManagementOperationTransactionEventsResult = "DECLINED"
)

func (ManagementOperationTransactionEventsResult) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionEventsResult) IsKnown() bool

type ManagementOperationTransactionEventsType added in v0.55.0 

type ManagementOperationTransactionEventsType string
const (
	ManagementOperationTransactionEventsTypeCashBack                   ManagementOperationTransactionEventsType = "CASH_BACK"
	ManagementOperationTransactionEventsTypeCurrencyConversion         ManagementOperationTransactionEventsType = "CURRENCY_CONVERSION"
	ManagementOperationTransactionEventsTypeInterest                   ManagementOperationTransactionEventsType = "INTEREST"
	ManagementOperationTransactionEventsTypeLatePayment                ManagementOperationTransactionEventsType = "LATE_PAYMENT"
	ManagementOperationTransactionEventsTypeBillingError               ManagementOperationTransactionEventsType = "BILLING_ERROR"
	ManagementOperationTransactionEventsTypeProvisionalCredit          ManagementOperationTransactionEventsType = "PROVISIONAL_CREDIT"
	ManagementOperationTransactionEventsTypeCashBackReversal           ManagementOperationTransactionEventsType = "CASH_BACK_REVERSAL"
	ManagementOperationTransactionEventsTypeCurrencyConversionReversal ManagementOperationTransactionEventsType = "CURRENCY_CONVERSION_REVERSAL"
	ManagementOperationTransactionEventsTypeInterestReversal           ManagementOperationTransactionEventsType = "INTEREST_REVERSAL"
	ManagementOperationTransactionEventsTypeLatePaymentReversal        ManagementOperationTransactionEventsType = "LATE_PAYMENT_REVERSAL"
	ManagementOperationTransactionEventsTypeBillingErrorReversal       ManagementOperationTransactionEventsType = "BILLING_ERROR_REVERSAL"
	ManagementOperationTransactionEventsTypeProvisionalCreditReversal  ManagementOperationTransactionEventsType = "PROVISIONAL_CREDIT_REVERSAL"
)

func (ManagementOperationTransactionEventsType) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionEventsType) IsKnown() bool

type ManagementOperationTransactionResult added in v0.55.0 

type ManagementOperationTransactionResult string
const (
	ManagementOperationTransactionResultApproved ManagementOperationTransactionResult = "APPROVED"
	ManagementOperationTransactionResultDeclined ManagementOperationTransactionResult = "DECLINED"
)

func (ManagementOperationTransactionResult) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionResult) IsKnown() bool

type ManagementOperationTransactionStatus added in v0.55.0 

type ManagementOperationTransactionStatus string
const (
	ManagementOperationTransactionStatusPending  ManagementOperationTransactionStatus = "PENDING"
	ManagementOperationTransactionStatusSettled  ManagementOperationTransactionStatus = "SETTLED"
	ManagementOperationTransactionStatusDeclined ManagementOperationTransactionStatus = "DECLINED"
	ManagementOperationTransactionStatusReversed ManagementOperationTransactionStatus = "REVERSED"
	ManagementOperationTransactionStatusCanceled ManagementOperationTransactionStatus = "CANCELED"
)

func (ManagementOperationTransactionStatus) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionStatus) IsKnown() bool

type MessageAttempt added in v0.6.3 

type MessageAttempt struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// An RFC 3339 timestamp for when the event was created. UTC time zone.
	//
	// If no timezone is specified, UTC will be used.
	Created time.Time `json:"created,required" format:"date-time"`
	// Globally unique identifier.
	EventSubscriptionToken string `json:"event_subscription_token,required"`
	// Globally unique identifier.
	EventToken string `json:"event_token,required"`
	// The response body from the event subscription's URL.
	Response string `json:"response,required"`
	// The response status code from the event subscription's URL.
	ResponseStatusCode int64 `json:"response_status_code,required"`
	// The status of the event attempt.
	Status MessageAttemptStatus `json:"status,required"`
	URL    string               `json:"url,required" format:"uri"`
	JSON   messageAttemptJSON   `json:"-"`
}

A subscription to specific event types.

func (*MessageAttempt) UnmarshalJSON added in v0.6.3 

func (r *MessageAttempt) UnmarshalJSON(data []byte) (err error)

type MessageAttemptStatus added in v0.6.3 

type MessageAttemptStatus string

The status of the event attempt. 

const (
	MessageAttemptStatusFailed  MessageAttemptStatus = "FAILED"
	MessageAttemptStatusPending MessageAttemptStatus = "PENDING"
	MessageAttemptStatusSending MessageAttemptStatus = "SENDING"
	MessageAttemptStatusSuccess MessageAttemptStatus = "SUCCESS"
)

func (MessageAttemptStatus) IsKnown added in v0.27.0 

func (r MessageAttemptStatus) IsKnown() bool

type OwnerType added in v0.6.5 

type OwnerType string
const (
	OwnerTypeIndividual OwnerType = "INDIVIDUAL"
	OwnerTypeBusiness   OwnerType = "BUSINESS"
)

func (OwnerType) IsKnown added in v0.27.0 

func (r OwnerType) IsKnown() bool

type Payment added in v0.6.5 

type Payment struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Payment category
	Category PaymentCategory `json:"category,required"`
	// Date and time when the payment first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the payment.
	Currency string `json:"currency,required"`
	// A string that provides a description of the payment; may be useful to display to
	// users.
	Descriptor string           `json:"descriptor,required"`
	Direction  PaymentDirection `json:"direction,required"`
	// A list of all payment events that have modified this payment.
	Events                   []PaymentEvent          `json:"events,required"`
	ExternalBankAccountToken string                  `json:"external_bank_account_token,required,nullable" format:"uuid"`
	FinancialAccountToken    string                  `json:"financial_account_token,required" format:"uuid"`
	Method                   PaymentMethod           `json:"method,required"`
	MethodAttributes         PaymentMethodAttributes `json:"method_attributes,required"`
	// Pending amount of the payment in the currency's smallest unit (e.g., cents). The
	// value of this field will go to zero over time once the payment is settled.
	PendingAmount int64 `json:"pending_amount,required"`
	// APPROVED payments were successful while DECLINED payments were declined by
	// Lithic or returned.
	Result PaymentResult `json:"result,required"`
	// Amount of the payment that has been settled in the currency's smallest unit
	// (e.g., cents).
	SettledAmount int64         `json:"settled_amount,required"`
	Source        PaymentSource `json:"source,required"`
	// Status types:
	//
	//   - `DECLINED` - The payment was declined.
	//   - `PENDING` - The payment is being processed and has yet to settle or release
	//     (origination debit).
	//   - `RETURNED` - The payment has been returned.
	//   - `SETTLED` - The payment is completed.
	Status PaymentStatus `json:"status,required"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated       time.Time   `json:"updated,required" format:"date-time"`
	UserDefinedID string      `json:"user_defined_id,required,nullable"`
	JSON          paymentJSON `json:"-"`
}

func (*Payment) UnmarshalJSON added in v0.6.5 

func (r *Payment) UnmarshalJSON(data []byte) (err error)

type PaymentCategory added in v0.34.0 

type PaymentCategory string

Payment category 

const (
	PaymentCategoryACH PaymentCategory = "ACH"
)

func (PaymentCategory) IsKnown added in v0.34.0 

func (r PaymentCategory) IsKnown() bool

type PaymentDirection added in v0.6.5 

type PaymentDirection string
const (
	PaymentDirectionCredit PaymentDirection = "CREDIT"
	PaymentDirectionDebit  PaymentDirection = "DEBIT"
)

func (PaymentDirection) IsKnown added in v0.27.0 

func (r PaymentDirection) IsKnown() bool

type PaymentEvent added in v0.34.0 

type PaymentEvent struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount,required"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result PaymentEventsResult `json:"result,required"`
	// Event types:
	//
	//   - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
	//     approval/release from an ACH hold.
	//   - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
	//   - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
	//   - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
	//     the fed.
	//   - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
	//   - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
	//     available balance.
	//   - `ACH_RETURN_PROCESSED` - ACH origination returned by the Receiving Depository
	//     Financial Institution.
	//   - `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
	//   - `ACH_RETURN_INITIATED` - ACH initiated return for a ACH receipt.
	//   - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
	//   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
	//     balance.
	Type PaymentEventsType `json:"type,required"`
	// More detailed reasons for the event
	DetailedResults []PaymentEventsDetailedResult `json:"detailed_results"`
	JSON            paymentEventJSON              `json:"-"`
}

func (*PaymentEvent) UnmarshalJSON added in v0.34.0 

func (r *PaymentEvent) UnmarshalJSON(data []byte) (err error)

type PaymentEventsDetailedResult added in v0.34.0 

type PaymentEventsDetailedResult string
const (
	PaymentEventsDetailedResultApproved                        PaymentEventsDetailedResult = "APPROVED"
	PaymentEventsDetailedResultFundsInsufficient               PaymentEventsDetailedResult = "FUNDS_INSUFFICIENT"
	PaymentEventsDetailedResultAccountInvalid                  PaymentEventsDetailedResult = "ACCOUNT_INVALID"
	PaymentEventsDetailedResultProgramTransactionLimitExceeded PaymentEventsDetailedResult = "PROGRAM_TRANSACTION_LIMIT_EXCEEDED"
	PaymentEventsDetailedResultProgramDailyLimitExceeded       PaymentEventsDetailedResult = "PROGRAM_DAILY_LIMIT_EXCEEDED"
	PaymentEventsDetailedResultProgramMonthlyLimitExceeded     PaymentEventsDetailedResult = "PROGRAM_MONTHLY_LIMIT_EXCEEDED"
)

func (PaymentEventsDetailedResult) IsKnown added in v0.34.0 

func (r PaymentEventsDetailedResult) IsKnown() bool

type PaymentEventsResult added in v0.34.0 

type PaymentEventsResult string

APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network. 

const (
	PaymentEventsResultApproved PaymentEventsResult = "APPROVED"
	PaymentEventsResultDeclined PaymentEventsResult = "DECLINED"
)

func (PaymentEventsResult) IsKnown added in v0.34.0 

func (r PaymentEventsResult) IsKnown() bool

type PaymentEventsType added in v0.34.0 

type PaymentEventsType string

Event types:

  • `ACH_ORIGINATION_INITIATED` - ACH origination received and pending approval/release from an ACH hold.
  • `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
  • `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
  • `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to the fed.
  • `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
  • `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.
  • `ACH_RETURN_PROCESSED` - ACH origination returned by the Receiving Depository Financial Institution.
  • `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
  • `ACH_RETURN_INITIATED` - ACH initiated return for a ACH receipt.
  • `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
  • `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.
const (
	PaymentEventsTypeACHOriginationCancelled PaymentEventsType = "ACH_ORIGINATION_CANCELLED"
	PaymentEventsTypeACHOriginationInitiated PaymentEventsType = "ACH_ORIGINATION_INITIATED"
	PaymentEventsTypeACHOriginationProcessed PaymentEventsType = "ACH_ORIGINATION_PROCESSED"
	PaymentEventsTypeACHOriginationSettled   PaymentEventsType = "ACH_ORIGINATION_SETTLED"
	PaymentEventsTypeACHOriginationReleased  PaymentEventsType = "ACH_ORIGINATION_RELEASED"
	PaymentEventsTypeACHOriginationReviewed  PaymentEventsType = "ACH_ORIGINATION_REVIEWED"
	PaymentEventsTypeACHReceiptProcessed     PaymentEventsType = "ACH_RECEIPT_PROCESSED"
	PaymentEventsTypeACHReceiptSettled       PaymentEventsType = "ACH_RECEIPT_SETTLED"
	PaymentEventsTypeACHReturnInitiated      PaymentEventsType = "ACH_RETURN_INITIATED"
	PaymentEventsTypeACHReturnProcessed      PaymentEventsType = "ACH_RETURN_PROCESSED"
)

func (PaymentEventsType) IsKnown added in v0.34.0 

func (r PaymentEventsType) IsKnown() bool

type PaymentListParams added in v0.6.5 

type PaymentListParams struct {
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin                param.Field[time.Time]                 `query:"begin" format:"date-time"`
	BusinessAccountToken param.Field[string]                    `query:"business_account_token" format:"uuid"`
	Category             param.Field[PaymentListParamsCategory] `query:"category"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore          param.Field[string] `query:"ending_before"`
	FinancialAccountToken param.Field[string] `query:"financial_account_token" format:"uuid"`
	// Page size (for pagination).
	PageSize param.Field[int64]                   `query:"page_size"`
	Result   param.Field[PaymentListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string]                  `query:"starting_after"`
	Status        param.Field[PaymentListParamsStatus] `query:"status"`
}

func (PaymentListParams) URLQuery added in v0.6.5 

func (r PaymentListParams) URLQuery() (v url.Values)

URLQuery serializes PaymentListParams's query parameters as `url.Values`.

type PaymentListParamsCategory added in v0.35.0 

type PaymentListParamsCategory string
const (
	PaymentListParamsCategoryACH PaymentListParamsCategory = "ACH"
)

func (PaymentListParamsCategory) IsKnown added in v0.35.0 

func (r PaymentListParamsCategory) IsKnown() bool

type PaymentListParamsResult added in v0.6.5 

type PaymentListParamsResult string
const (
	PaymentListParamsResultApproved PaymentListParamsResult = "APPROVED"
	PaymentListParamsResultDeclined PaymentListParamsResult = "DECLINED"
)

func (PaymentListParamsResult) IsKnown added in v0.27.0 

func (r PaymentListParamsResult) IsKnown() bool

type PaymentListParamsStatus added in v0.6.5 

type PaymentListParamsStatus string
const (
	PaymentListParamsStatusDeclined PaymentListParamsStatus = "DECLINED"
	PaymentListParamsStatusPending  PaymentListParamsStatus = "PENDING"
	PaymentListParamsStatusReturned PaymentListParamsStatus = "RETURNED"
	PaymentListParamsStatusSettled  PaymentListParamsStatus = "SETTLED"
)

func (PaymentListParamsStatus) IsKnown added in v0.27.0 

func (r PaymentListParamsStatus) IsKnown() bool

type PaymentMethod added in v0.6.5 

type PaymentMethod string
const (
	PaymentMethodACHNextDay PaymentMethod = "ACH_NEXT_DAY"
	PaymentMethodACHSameDay PaymentMethod = "ACH_SAME_DAY"
)

func (PaymentMethod) IsKnown added in v0.27.0 

func (r PaymentMethod) IsKnown() bool

type PaymentMethodAttributes added in v0.6.5 

type PaymentMethodAttributes struct {
	CompanyID            string                         `json:"company_id,required,nullable"`
	ReceiptRoutingNumber string                         `json:"receipt_routing_number,required,nullable"`
	Retries              int64                          `json:"retries,required,nullable"`
	ReturnReasonCode     string                         `json:"return_reason_code,required,nullable"`
	SecCode              PaymentMethodAttributesSecCode `json:"sec_code,required"`
	TraceNumbers         []string                       `json:"trace_numbers,required"`
	JSON                 paymentMethodAttributesJSON    `json:"-"`
}

func (*PaymentMethodAttributes) UnmarshalJSON added in v0.6.5 

func (r *PaymentMethodAttributes) UnmarshalJSON(data []byte) (err error)

type PaymentMethodAttributesSecCode added in v0.6.5 

type PaymentMethodAttributesSecCode string
const (
	PaymentMethodAttributesSecCodeCcd PaymentMethodAttributesSecCode = "CCD"
	PaymentMethodAttributesSecCodePpd PaymentMethodAttributesSecCode = "PPD"
	PaymentMethodAttributesSecCodeWeb PaymentMethodAttributesSecCode = "WEB"
)

func (PaymentMethodAttributesSecCode) IsKnown added in v0.27.0 

func (r PaymentMethodAttributesSecCode) IsKnown() bool

type PaymentNewParams added in v0.6.5 

type PaymentNewParams struct {
	Amount                   param.Field[int64]                            `json:"amount,required"`
	ExternalBankAccountToken param.Field[string]                           `json:"external_bank_account_token,required" format:"uuid"`
	FinancialAccountToken    param.Field[string]                           `json:"financial_account_token,required" format:"uuid"`
	Method                   param.Field[PaymentNewParamsMethod]           `json:"method,required"`
	MethodAttributes         param.Field[PaymentNewParamsMethodAttributes] `json:"method_attributes,required"`
	Type                     param.Field[PaymentNewParamsType]             `json:"type,required"`
	// Customer-provided token that will serve as an idempotency token. This token will
	// become the transaction token.
	Token         param.Field[string] `json:"token" format:"uuid"`
	Memo          param.Field[string] `json:"memo"`
	UserDefinedID param.Field[string] `json:"user_defined_id"`
}

func (PaymentNewParams) MarshalJSON added in v0.6.5 

func (r PaymentNewParams) MarshalJSON() (data []byte, err error)

type PaymentNewParamsMethod added in v0.6.5 

type PaymentNewParamsMethod string
const (
	PaymentNewParamsMethodACHNextDay PaymentNewParamsMethod = "ACH_NEXT_DAY"
	PaymentNewParamsMethodACHSameDay PaymentNewParamsMethod = "ACH_SAME_DAY"
)

func (PaymentNewParamsMethod) IsKnown added in v0.27.0 

func (r PaymentNewParamsMethod) IsKnown() bool

type PaymentNewParamsMethodAttributes added in v0.6.5 

type PaymentNewParamsMethodAttributes struct {
	SecCode param.Field[PaymentNewParamsMethodAttributesSecCode] `json:"sec_code,required"`
}

func (PaymentNewParamsMethodAttributes) MarshalJSON added in v0.6.5 

func (r PaymentNewParamsMethodAttributes) MarshalJSON() (data []byte, err error)

type PaymentNewParamsMethodAttributesSecCode added in v0.6.5 

type PaymentNewParamsMethodAttributesSecCode string
const (
	PaymentNewParamsMethodAttributesSecCodeCcd PaymentNewParamsMethodAttributesSecCode = "CCD"
	PaymentNewParamsMethodAttributesSecCodePpd PaymentNewParamsMethodAttributesSecCode = "PPD"
	PaymentNewParamsMethodAttributesSecCodeWeb PaymentNewParamsMethodAttributesSecCode = "WEB"
)

func (PaymentNewParamsMethodAttributesSecCode) IsKnown added in v0.27.0 

func (r PaymentNewParamsMethodAttributesSecCode) IsKnown() bool

type PaymentNewParamsType added in v0.6.5 

type PaymentNewParamsType string
const (
	PaymentNewParamsTypeCollection PaymentNewParamsType = "COLLECTION"
	PaymentNewParamsTypePayment    PaymentNewParamsType = "PAYMENT"
)

func (PaymentNewParamsType) IsKnown added in v0.27.0 

func (r PaymentNewParamsType) IsKnown() bool

type PaymentNewResponse added in v0.6.5 

type PaymentNewResponse struct {
	// Balance
	Balance Balance                `json:"balance"`
	JSON    paymentNewResponseJSON `json:"-"`
	Payment
}

func (*PaymentNewResponse) UnmarshalJSON added in v0.6.5 

func (r *PaymentNewResponse) UnmarshalJSON(data []byte) (err error)

type PaymentResult added in v0.34.0 

type PaymentResult string

APPROVED payments were successful while DECLINED payments were declined by Lithic or returned. 

const (
	PaymentResultApproved PaymentResult = "APPROVED"
	PaymentResultDeclined PaymentResult = "DECLINED"
)

func (PaymentResult) IsKnown added in v0.34.0 

func (r PaymentResult) IsKnown() bool

type PaymentRetryResponse added in v0.9.0 

type PaymentRetryResponse struct {
	// Balance
	Balance Balance                  `json:"balance"`
	JSON    paymentRetryResponseJSON `json:"-"`
	Payment
}

func (*PaymentRetryResponse) UnmarshalJSON added in v0.9.0 

func (r *PaymentRetryResponse) UnmarshalJSON(data []byte) (err error)

type PaymentService added in v0.6.5 

type PaymentService struct {
	Options []option.RequestOption
}

PaymentService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPaymentService method instead.

func NewPaymentService added in v0.6.5 

func NewPaymentService(opts ...option.RequestOption) (r *PaymentService)

NewPaymentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PaymentService) Get added in v0.6.5 

func (r *PaymentService) Get(ctx context.Context, paymentToken string, opts ...option.RequestOption) (res *Payment, err error)

Get the payment by token.

func (*PaymentService) List added in v0.6.5 

func (r *PaymentService) List(ctx context.Context, query PaymentListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Payment], err error)

List all the payments for the provided search criteria.

func (*PaymentService) ListAutoPaging added in v0.6.5 

func (r *PaymentService) ListAutoPaging(ctx context.Context, query PaymentListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Payment]

List all the payments for the provided search criteria.

func (*PaymentService) New added in v0.6.5 

func (r *PaymentService) New(ctx context.Context, body PaymentNewParams, opts ...option.RequestOption) (res *PaymentNewResponse, err error)

Initiates a payment between a financial account and an external bank account.

func (*PaymentService) Retry added in v0.9.0 

func (r *PaymentService) Retry(ctx context.Context, paymentToken string, opts ...option.RequestOption) (res *PaymentRetryResponse, err error)

Retry an origination which has been returned.

func (*PaymentService) SimulateAction added in v0.32.0 

func (r *PaymentService) SimulateAction(ctx context.Context, paymentToken string, body PaymentSimulateActionParams, opts ...option.RequestOption) (res *PaymentSimulateActionResponse, err error)

Simulate payment lifecycle event

func (*PaymentService) SimulateReceipt added in v0.32.0 

func (r *PaymentService) SimulateReceipt(ctx context.Context, body PaymentSimulateReceiptParams, opts ...option.RequestOption) (res *PaymentSimulateReceiptResponse, err error)

Simulates a receipt of a Payment.

func (*PaymentService) SimulateRelease added in v0.6.5 

func (r *PaymentService) SimulateRelease(ctx context.Context, body PaymentSimulateReleaseParams, opts ...option.RequestOption) (res *PaymentSimulateReleaseResponse, err error)

Simulates a release of a Payment.

func (*PaymentService) SimulateReturn added in v0.7.1 

func (r *PaymentService) SimulateReturn(ctx context.Context, body PaymentSimulateReturnParams, opts ...option.RequestOption) (res *PaymentSimulateReturnResponse, err error)

Simulates a return of a Payment.

type PaymentSimulateActionParams added in v0.32.0 

type PaymentSimulateActionParams struct {
	// Event Type
	EventType param.Field[PaymentSimulateActionParamsEventType] `json:"event_type,required"`
	// Decline reason
	DeclineReason param.Field[PaymentSimulateActionParamsDeclineReason] `json:"decline_reason"`
	// Return Reason Code
	ReturnReasonCode param.Field[string] `json:"return_reason_code"`
}

func (PaymentSimulateActionParams) MarshalJSON added in v0.32.0 

func (r PaymentSimulateActionParams) MarshalJSON() (data []byte, err error)

type PaymentSimulateActionParamsDeclineReason added in v0.32.0 

type PaymentSimulateActionParamsDeclineReason string

Decline reason 

const (
	PaymentSimulateActionParamsDeclineReasonProgramTransactionLimitExceeded PaymentSimulateActionParamsDeclineReason = "PROGRAM_TRANSACTION_LIMIT_EXCEEDED"
	PaymentSimulateActionParamsDeclineReasonProgramDailyLimitExceeded       PaymentSimulateActionParamsDeclineReason = "PROGRAM_DAILY_LIMIT_EXCEEDED"
	PaymentSimulateActionParamsDeclineReasonProgramMonthlyLimitExceeded     PaymentSimulateActionParamsDeclineReason = "PROGRAM_MONTHLY_LIMIT_EXCEEDED"
)

func (PaymentSimulateActionParamsDeclineReason) IsKnown added in v0.32.0 

func (r PaymentSimulateActionParamsDeclineReason) IsKnown() bool

type PaymentSimulateActionParamsEventType added in v0.32.0 

type PaymentSimulateActionParamsEventType string

Event Type 

const (
	PaymentSimulateActionParamsEventTypeACHOriginationReviewed  PaymentSimulateActionParamsEventType = "ACH_ORIGINATION_REVIEWED"
	PaymentSimulateActionParamsEventTypeACHOriginationReleased  PaymentSimulateActionParamsEventType = "ACH_ORIGINATION_RELEASED"
	PaymentSimulateActionParamsEventTypeACHOriginationProcessed PaymentSimulateActionParamsEventType = "ACH_ORIGINATION_PROCESSED"
	PaymentSimulateActionParamsEventTypeACHOriginationSettled   PaymentSimulateActionParamsEventType = "ACH_ORIGINATION_SETTLED"
	PaymentSimulateActionParamsEventTypeACHReceiptSettled       PaymentSimulateActionParamsEventType = "ACH_RECEIPT_SETTLED"
	PaymentSimulateActionParamsEventTypeACHReturnInitiated      PaymentSimulateActionParamsEventType = "ACH_RETURN_INITIATED"
	PaymentSimulateActionParamsEventTypeACHReturnProcessed      PaymentSimulateActionParamsEventType = "ACH_RETURN_PROCESSED"
)

func (PaymentSimulateActionParamsEventType) IsKnown added in v0.32.0 

func (r PaymentSimulateActionParamsEventType) IsKnown() bool

type PaymentSimulateActionResponse added in v0.32.0 

type PaymentSimulateActionResponse struct {
	// Debugging Request Id
	DebuggingRequestID string `json:"debugging_request_id,required" format:"uuid"`
	// Request Result
	Result PaymentSimulateActionResponseResult `json:"result,required"`
	// Transaction Event Token
	TransactionEventToken string                            `json:"transaction_event_token,required" format:"uuid"`
	JSON                  paymentSimulateActionResponseJSON `json:"-"`
}

func (*PaymentSimulateActionResponse) UnmarshalJSON added in v0.32.0 

func (r *PaymentSimulateActionResponse) UnmarshalJSON(data []byte) (err error)

type PaymentSimulateActionResponseResult added in v0.32.0 

type PaymentSimulateActionResponseResult string

Request Result 

const (
	PaymentSimulateActionResponseResultApproved PaymentSimulateActionResponseResult = "APPROVED"
	PaymentSimulateActionResponseResultDeclined PaymentSimulateActionResponseResult = "DECLINED"
)

func (PaymentSimulateActionResponseResult) IsKnown added in v0.32.0 

func (r PaymentSimulateActionResponseResult) IsKnown() bool

type PaymentSimulateReceiptParams added in v0.32.0 

type PaymentSimulateReceiptParams struct {
	// Payment token
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount
	Amount param.Field[int64] `json:"amount,required"`
	// Financial Account Token
	FinancialAccountToken param.Field[string] `json:"financial_account_token,required" format:"uuid"`
	// Receipt Type
	ReceiptType param.Field[PaymentSimulateReceiptParamsReceiptType] `json:"receipt_type,required"`
	// Memo
	Memo param.Field[string] `json:"memo"`
}

func (PaymentSimulateReceiptParams) MarshalJSON added in v0.32.0 

func (r PaymentSimulateReceiptParams) MarshalJSON() (data []byte, err error)

type PaymentSimulateReceiptParamsReceiptType added in v0.32.0 

type PaymentSimulateReceiptParamsReceiptType string

Receipt Type 

const (
	PaymentSimulateReceiptParamsReceiptTypeReceiptCredit PaymentSimulateReceiptParamsReceiptType = "RECEIPT_CREDIT"
	PaymentSimulateReceiptParamsReceiptTypeReceiptDebit  PaymentSimulateReceiptParamsReceiptType = "RECEIPT_DEBIT"
)

func (PaymentSimulateReceiptParamsReceiptType) IsKnown added in v0.32.0 

func (r PaymentSimulateReceiptParamsReceiptType) IsKnown() bool

type PaymentSimulateReceiptResponse added in v0.32.0 

type PaymentSimulateReceiptResponse struct {
	// Debugging Request Id
	DebuggingRequestID string `json:"debugging_request_id,required" format:"uuid"`
	// Request Result
	Result PaymentSimulateReceiptResponseResult `json:"result,required"`
	// Transaction Event Token
	TransactionEventToken string                             `json:"transaction_event_token,required" format:"uuid"`
	JSON                  paymentSimulateReceiptResponseJSON `json:"-"`
}

func (*PaymentSimulateReceiptResponse) UnmarshalJSON added in v0.32.0 

func (r *PaymentSimulateReceiptResponse) UnmarshalJSON(data []byte) (err error)

type PaymentSimulateReceiptResponseResult added in v0.32.0 

type PaymentSimulateReceiptResponseResult string

Request Result 

const (
	PaymentSimulateReceiptResponseResultApproved PaymentSimulateReceiptResponseResult = "APPROVED"
	PaymentSimulateReceiptResponseResultDeclined PaymentSimulateReceiptResponseResult = "DECLINED"
)

func (PaymentSimulateReceiptResponseResult) IsKnown added in v0.32.0 

func (r PaymentSimulateReceiptResponseResult) IsKnown() bool

type PaymentSimulateReleaseParams added in v0.6.5 

type PaymentSimulateReleaseParams struct {
	// Payment Token
	PaymentToken param.Field[string] `json:"payment_token,required" format:"uuid"`
}

func (PaymentSimulateReleaseParams) MarshalJSON added in v0.6.5 

func (r PaymentSimulateReleaseParams) MarshalJSON() (data []byte, err error)

type PaymentSimulateReleaseResponse added in v0.6.5 

type PaymentSimulateReleaseResponse struct {
	// Debugging Request Id
	DebuggingRequestID string `json:"debugging_request_id,required" format:"uuid"`
	// Request Result
	Result PaymentSimulateReleaseResponseResult `json:"result,required"`
	// Transaction Event Token
	TransactionEventToken string                             `json:"transaction_event_token,required" format:"uuid"`
	JSON                  paymentSimulateReleaseResponseJSON `json:"-"`
}

func (*PaymentSimulateReleaseResponse) UnmarshalJSON added in v0.6.5 

func (r *PaymentSimulateReleaseResponse) UnmarshalJSON(data []byte) (err error)

type PaymentSimulateReleaseResponseResult added in v0.6.5 

type PaymentSimulateReleaseResponseResult string

Request Result 

const (
	PaymentSimulateReleaseResponseResultApproved PaymentSimulateReleaseResponseResult = "APPROVED"
	PaymentSimulateReleaseResponseResultDeclined PaymentSimulateReleaseResponseResult = "DECLINED"
)

func (PaymentSimulateReleaseResponseResult) IsKnown added in v0.27.0 

func (r PaymentSimulateReleaseResponseResult) IsKnown() bool

type PaymentSimulateReturnParams added in v0.7.1 

type PaymentSimulateReturnParams struct {
	// Payment Token
	PaymentToken param.Field[string] `json:"payment_token,required" format:"uuid"`
	// Return Reason Code
	ReturnReasonCode param.Field[string] `json:"return_reason_code"`
}

func (PaymentSimulateReturnParams) MarshalJSON added in v0.7.1 

func (r PaymentSimulateReturnParams) MarshalJSON() (data []byte, err error)

type PaymentSimulateReturnResponse added in v0.7.1 

type PaymentSimulateReturnResponse struct {
	// Debugging Request Id
	DebuggingRequestID string `json:"debugging_request_id,required" format:"uuid"`
	// Request Result
	Result PaymentSimulateReturnResponseResult `json:"result,required"`
	// Transaction Event Token
	TransactionEventToken string                            `json:"transaction_event_token,required" format:"uuid"`
	JSON                  paymentSimulateReturnResponseJSON `json:"-"`
}

func (*PaymentSimulateReturnResponse) UnmarshalJSON added in v0.7.1 

func (r *PaymentSimulateReturnResponse) UnmarshalJSON(data []byte) (err error)

type PaymentSimulateReturnResponseResult added in v0.7.1 

type PaymentSimulateReturnResponseResult string

Request Result 

const (
	PaymentSimulateReturnResponseResultApproved PaymentSimulateReturnResponseResult = "APPROVED"
	PaymentSimulateReturnResponseResultDeclined PaymentSimulateReturnResponseResult = "DECLINED"
)

func (PaymentSimulateReturnResponseResult) IsKnown added in v0.27.0 

func (r PaymentSimulateReturnResponseResult) IsKnown() bool

type PaymentSource added in v0.6.5 

type PaymentSource string
const (
	PaymentSourceCustomer PaymentSource = "CUSTOMER"
	PaymentSourceLithic   PaymentSource = "LITHIC"
)

func (PaymentSource) IsKnown added in v0.27.0 

func (r PaymentSource) IsKnown() bool

type PaymentStatus added in v0.34.0 

type PaymentStatus string

Status types:

  • `DECLINED` - The payment was declined.
  • `PENDING` - The payment is being processed and has yet to settle or release (origination debit).
  • `RETURNED` - The payment has been returned.
  • `SETTLED` - The payment is completed.
const (
	PaymentStatusDeclined PaymentStatus = "DECLINED"
	PaymentStatusPending  PaymentStatus = "PENDING"
	PaymentStatusReturned PaymentStatus = "RETURNED"
	PaymentStatusSettled  PaymentStatus = "SETTLED"
)

func (PaymentStatus) IsKnown added in v0.34.0 

func (r PaymentStatus) IsKnown() bool

type ReportService added in v0.9.0 

type ReportService struct {
	Options    []option.RequestOption
	Settlement *ReportSettlementService
}

ReportService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReportService method instead.

func NewReportService added in v0.9.0 

func NewReportService(opts ...option.RequestOption) (r *ReportService)

NewReportService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type ReportSettlementListDetailsParams added in v0.9.0 

type ReportSettlementListDetailsParams struct {
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (ReportSettlementListDetailsParams) URLQuery added in v0.9.0 

func (r ReportSettlementListDetailsParams) URLQuery() (v url.Values)

URLQuery serializes ReportSettlementListDetailsParams's query parameters as `url.Values`.

type ReportSettlementService added in v0.9.0 

type ReportSettlementService struct {
	Options []option.RequestOption
}

ReportSettlementService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReportSettlementService method instead.

func NewReportSettlementService added in v0.9.0 

func NewReportSettlementService(opts ...option.RequestOption) (r *ReportSettlementService)

NewReportSettlementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ReportSettlementService) ListDetails added in v0.9.0 

func (r *ReportSettlementService) ListDetails(ctx context.Context, reportDate time.Time, query ReportSettlementListDetailsParams, opts ...option.RequestOption) (res *pagination.CursorPage[SettlementDetail], err error)

List details.

func (*ReportSettlementService) ListDetailsAutoPaging added in v0.9.0 

func (r *ReportSettlementService) ListDetailsAutoPaging(ctx context.Context, reportDate time.Time, query ReportSettlementListDetailsParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[SettlementDetail]

List details.

func (*ReportSettlementService) Summary added in v0.9.0 

func (r *ReportSettlementService) Summary(ctx context.Context, reportDate time.Time, opts ...option.RequestOption) (res *SettlementReport, err error)

Get the settlement report for a specified report date.

type RequiredDocument added in v0.51.0 

type RequiredDocument struct {
	// Globally unique identifier for an entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// rovides the status reasons that will be satisfied by providing one of the valid
	// documents.
	StatusReasons []string `json:"status_reasons,required"`
	// A list of valid documents that will satisfy the KYC requirements for the
	// specified entity.
	ValidDocuments []string             `json:"valid_documents,required"`
	JSON           requiredDocumentJSON `json:"-"`
}

func (*RequiredDocument) UnmarshalJSON added in v0.51.0 

func (r *RequiredDocument) UnmarshalJSON(data []byte) (err error)

type ResponderEndpointCheckStatusParams 

type ResponderEndpointCheckStatusParams struct {
	// The type of the endpoint.
	Type param.Field[ResponderEndpointCheckStatusParamsType] `query:"type,required"`
}

func (ResponderEndpointCheckStatusParams) URLQuery 

func (r ResponderEndpointCheckStatusParams) URLQuery() (v url.Values)

URLQuery serializes ResponderEndpointCheckStatusParams's query parameters as `url.Values`.

type ResponderEndpointCheckStatusParamsType 

type ResponderEndpointCheckStatusParamsType string

The type of the endpoint. 

const (
	ResponderEndpointCheckStatusParamsTypeAuthStreamAccess        ResponderEndpointCheckStatusParamsType = "AUTH_STREAM_ACCESS"
	ResponderEndpointCheckStatusParamsTypeThreeDSDecisioning      ResponderEndpointCheckStatusParamsType = "THREE_DS_DECISIONING"
	ResponderEndpointCheckStatusParamsTypeTokenizationDecisioning ResponderEndpointCheckStatusParamsType = "TOKENIZATION_DECISIONING"
)

func (ResponderEndpointCheckStatusParamsType) IsKnown added in v0.27.0 

func (r ResponderEndpointCheckStatusParamsType) IsKnown() bool

type ResponderEndpointDeleteParams 

type ResponderEndpointDeleteParams struct {
	// The type of the endpoint.
	Type param.Field[ResponderEndpointDeleteParamsType] `query:"type,required"`
}

func (ResponderEndpointDeleteParams) URLQuery 

func (r ResponderEndpointDeleteParams) URLQuery() (v url.Values)

URLQuery serializes ResponderEndpointDeleteParams's query parameters as `url.Values`.

type ResponderEndpointDeleteParamsType 

type ResponderEndpointDeleteParamsType string

The type of the endpoint. 

const (
	ResponderEndpointDeleteParamsTypeAuthStreamAccess        ResponderEndpointDeleteParamsType = "AUTH_STREAM_ACCESS"
	ResponderEndpointDeleteParamsTypeThreeDSDecisioning      ResponderEndpointDeleteParamsType = "THREE_DS_DECISIONING"
	ResponderEndpointDeleteParamsTypeTokenizationDecisioning ResponderEndpointDeleteParamsType = "TOKENIZATION_DECISIONING"
)

func (ResponderEndpointDeleteParamsType) IsKnown added in v0.27.0 

func (r ResponderEndpointDeleteParamsType) IsKnown() bool

type ResponderEndpointNewParams 

type ResponderEndpointNewParams struct {
	// The type of the endpoint.
	Type param.Field[ResponderEndpointNewParamsType] `json:"type"`
	// The URL for the responder endpoint (must be http(s)).
	URL param.Field[string] `json:"url" format:"uri"`
}

func (ResponderEndpointNewParams) MarshalJSON 

func (r ResponderEndpointNewParams) MarshalJSON() (data []byte, err error)

type ResponderEndpointNewParamsType 

type ResponderEndpointNewParamsType string

The type of the endpoint. 

const (
	ResponderEndpointNewParamsTypeAuthStreamAccess        ResponderEndpointNewParamsType = "AUTH_STREAM_ACCESS"
	ResponderEndpointNewParamsTypeThreeDSDecisioning      ResponderEndpointNewParamsType = "THREE_DS_DECISIONING"
	ResponderEndpointNewParamsTypeTokenizationDecisioning ResponderEndpointNewParamsType = "TOKENIZATION_DECISIONING"
)

func (ResponderEndpointNewParamsType) IsKnown added in v0.27.0 

func (r ResponderEndpointNewParamsType) IsKnown() bool

type ResponderEndpointNewResponse added in v0.5.0 

type ResponderEndpointNewResponse struct {
	// True if the endpoint was enrolled successfully.
	Enrolled bool                             `json:"enrolled"`
	JSON     responderEndpointNewResponseJSON `json:"-"`
}

func (*ResponderEndpointNewResponse) UnmarshalJSON added in v0.5.0 

func (r *ResponderEndpointNewResponse) UnmarshalJSON(data []byte) (err error)

type ResponderEndpointService 

type ResponderEndpointService struct {
	Options []option.RequestOption
}

ResponderEndpointService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewResponderEndpointService method instead.

func NewResponderEndpointService 

func NewResponderEndpointService(opts ...option.RequestOption) (r *ResponderEndpointService)

NewResponderEndpointService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ResponderEndpointService) CheckStatus 

func (r *ResponderEndpointService) CheckStatus(ctx context.Context, query ResponderEndpointCheckStatusParams, opts ...option.RequestOption) (res *ResponderEndpointStatus, err error)

Check the status of a responder endpoint

func (*ResponderEndpointService) Delete 

func (r *ResponderEndpointService) Delete(ctx context.Context, body ResponderEndpointDeleteParams, opts ...option.RequestOption) (err error)

Disenroll a responder endpoint

func (*ResponderEndpointService) New 

func (r *ResponderEndpointService) New(ctx context.Context, body ResponderEndpointNewParams, opts ...option.RequestOption) (res *ResponderEndpointNewResponse, err error)

Enroll a responder endpoint

type ResponderEndpointStatus 

type ResponderEndpointStatus struct {
	// True if the instance has an endpoint enrolled.
	Enrolled bool `json:"enrolled"`
	// The URL of the currently enrolled endpoint or null.
	URL  string                      `json:"url,nullable" format:"uri"`
	JSON responderEndpointStatusJSON `json:"-"`
}

func (*ResponderEndpointStatus) UnmarshalJSON 

func (r *ResponderEndpointStatus) UnmarshalJSON(data []byte) (err error)

type SettlementDetail added in v0.9.0 

type SettlementDetail struct {
	// Globally unique identifier denoting the Settlement Detail.
	Token string `json:"token,required" format:"uuid"`
	// The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
	// for Visa).
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Globally unique identifier denoting the card program that the associated
	// Transaction occurred on.
	CardProgramToken string `json:"card_program_token,required" format:"uuid"`
	// Globally unique identifier denoting the card that the associated Transaction
	// occurred on.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Date and time when the transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Three-digit alphabetic ISO 4217 code.
	Currency string `json:"currency,required"`
	// The total gross amount of disputes settlements.
	DisputesGrossAmount int64 `json:"disputes_gross_amount,required"`
	// Globally unique identifiers denoting the Events associated with this settlement.
	EventTokens []string `json:"event_tokens,required"`
	// The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
	// for Visa).
	Institution string `json:"institution,required"`
	// The total amount of interchange in six-digit extended precision.
	InterchangeFeeExtendedPrecision int64 `json:"interchange_fee_extended_precision,required"`
	// The total amount of interchange.
	InterchangeGrossAmount int64 `json:"interchange_gross_amount,required"`
	// Card network where the transaction took place.
	Network SettlementDetailNetwork `json:"network,required"`
	// The total gross amount of other fees by type.
	OtherFeesDetails SettlementDetailOtherFeesDetails `json:"other_fees_details,required"`
	// Total amount of gross other fees outside of interchange.
	OtherFeesGrossAmount int64 `json:"other_fees_gross_amount,required"`
	// Date of when the report was first generated.
	ReportDate string `json:"report_date,required"`
	// Date of when money movement is triggered for the transaction.
	SettlementDate string `json:"settlement_date,required"`
	// Globally unique identifier denoting the associated Transaction object.
	TransactionToken string `json:"transaction_token,required" format:"uuid"`
	// The total amount of settlement impacting transactions (excluding interchange,
	// fees, and disputes).
	TransactionsGrossAmount int64 `json:"transactions_gross_amount,required"`
	// The type of settlement record.
	Type SettlementDetailType `json:"type,required"`
	// Date and time when the transaction first occurred. UTC time zone.
	Updated time.Time            `json:"updated,required" format:"date-time"`
	JSON    settlementDetailJSON `json:"-"`
}

func (*SettlementDetail) UnmarshalJSON added in v0.9.0 

func (r *SettlementDetail) UnmarshalJSON(data []byte) (err error)

type SettlementDetailNetwork added in v0.9.0 

type SettlementDetailNetwork string

Card network where the transaction took place. 

const (
	SettlementDetailNetworkInterlink  SettlementDetailNetwork = "INTERLINK"
	SettlementDetailNetworkMaestro    SettlementDetailNetwork = "MAESTRO"
	SettlementDetailNetworkMastercard SettlementDetailNetwork = "MASTERCARD"
	SettlementDetailNetworkUnknown    SettlementDetailNetwork = "UNKNOWN"
	SettlementDetailNetworkVisa       SettlementDetailNetwork = "VISA"
)

func (SettlementDetailNetwork) IsKnown added in v0.27.0 

func (r SettlementDetailNetwork) IsKnown() bool

type SettlementDetailOtherFeesDetails added in v0.9.0 

type SettlementDetailOtherFeesDetails struct {
	Isa  int64                                `json:"ISA"`
	JSON settlementDetailOtherFeesDetailsJSON `json:"-"`
}

The total gross amount of other fees by type.

func (*SettlementDetailOtherFeesDetails) UnmarshalJSON added in v0.9.0 

func (r *SettlementDetailOtherFeesDetails) UnmarshalJSON(data []byte) (err error)

type SettlementDetailType added in v0.20.0 

type SettlementDetailType string

The type of settlement record. 

const (
	SettlementDetailTypeAdjustment     SettlementDetailType = "ADJUSTMENT"
	SettlementDetailTypeArbitration    SettlementDetailType = "ARBITRATION"
	SettlementDetailTypeChargeback     SettlementDetailType = "CHARGEBACK"
	SettlementDetailTypeClearing       SettlementDetailType = "CLEARING"
	SettlementDetailTypeFee            SettlementDetailType = "FEE"
	SettlementDetailTypeFinancial      SettlementDetailType = "FINANCIAL"
	SettlementDetailTypeNonFinancial   SettlementDetailType = "NON-FINANCIAL"
	SettlementDetailTypePrearbitration SettlementDetailType = "PREARBITRATION"
	SettlementDetailTypeRepresentment  SettlementDetailType = "REPRESENTMENT"
)

func (SettlementDetailType) IsKnown added in v0.27.0 

func (r SettlementDetailType) IsKnown() bool

type SettlementReport added in v0.9.0 

type SettlementReport struct {
	// Date and time when the transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Three-digit alphabetic ISO 4217 code. (This field is deprecated and will be
	// removed in a future version of the API.)
	Currency string                     `json:"currency,required"`
	Details  []SettlementSummaryDetails `json:"details,required"`
	// The total gross amount of disputes settlements. (This field is deprecated and
	// will be removed in a future version of the API. To compute total amounts, Lithic
	// recommends that customers sum the relevant settlement amounts found within
	// `details`.)
	DisputesGrossAmount int64 `json:"disputes_gross_amount,required"`
	// The total amount of interchange. (This field is deprecated and will be removed
	// in a future version of the API. To compute total amounts, Lithic recommends that
	// customers sum the relevant settlement amounts found within `details`.)
	InterchangeGrossAmount int64 `json:"interchange_gross_amount,required"`
	// Indicates that all data expected on the given report date is available.
	IsComplete bool `json:"is_complete,required"`
	// Total amount of gross other fees outside of interchange. (This field is
	// deprecated and will be removed in a future version of the API. To compute total
	// amounts, Lithic recommends that customers sum the relevant settlement amounts
	// found within `details`.)
	OtherFeesGrossAmount int64 `json:"other_fees_gross_amount,required"`
	// Date of when the report was first generated.
	ReportDate string `json:"report_date,required"`
	// The total net amount of cash moved. (net value of settled_gross_amount,
	// interchange, fees). (This field is deprecated and will be removed in a future
	// version of the API. To compute total amounts, Lithic recommends that customers
	// sum the relevant settlement amounts found within `details`.)
	SettledNetAmount int64 `json:"settled_net_amount,required"`
	// The total amount of settlement impacting transactions (excluding interchange,
	// fees, and disputes). (This field is deprecated and will be removed in a future
	// version of the API. To compute total amounts, Lithic recommends that customers
	// sum the relevant settlement amounts found within `details`.)
	TransactionsGrossAmount int64 `json:"transactions_gross_amount,required"`
	// Date and time when the transaction first occurred. UTC time zone.
	Updated time.Time            `json:"updated,required" format:"date-time"`
	JSON    settlementReportJSON `json:"-"`
}

func (*SettlementReport) UnmarshalJSON added in v0.9.0 

func (r *SettlementReport) UnmarshalJSON(data []byte) (err error)

type SettlementSummaryDetails added in v0.9.0 

type SettlementSummaryDetails struct {
	// ISO 4217 alpha 3 code.
	Currency string `json:"currency"`
	// The total gross amount of disputes settlements.
	DisputesGrossAmount int64 `json:"disputes_gross_amount"`
	// The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
	// for Visa).
	Institution string `json:"institution"`
	// The total amount of interchange.
	InterchangeGrossAmount int64 `json:"interchange_gross_amount"`
	// Card network where the transaction took place
	Network SettlementSummaryDetailsNetwork `json:"network"`
	// Total amount of gross other fees outside of interchange.
	OtherFeesGrossAmount int64 `json:"other_fees_gross_amount"`
	// The total net amount of cash moved. (net value of settled_gross_amount,
	// interchange, fees).
	SettledNetAmount int64 `json:"settled_net_amount"`
	// The total amount of settlement impacting transactions (excluding interchange,
	// fees, and disputes).
	TransactionsGrossAmount int64                        `json:"transactions_gross_amount"`
	JSON                    settlementSummaryDetailsJSON `json:"-"`
}

func (*SettlementSummaryDetails) UnmarshalJSON added in v0.9.0 

func (r *SettlementSummaryDetails) UnmarshalJSON(data []byte) (err error)

type SettlementSummaryDetailsNetwork added in v0.9.0 

type SettlementSummaryDetailsNetwork string

Card network where the transaction took place 

const (
	SettlementSummaryDetailsNetworkInterlink  SettlementSummaryDetailsNetwork = "INTERLINK"
	SettlementSummaryDetailsNetworkMaestro    SettlementSummaryDetailsNetwork = "MAESTRO"
	SettlementSummaryDetailsNetworkMastercard SettlementSummaryDetailsNetwork = "MASTERCARD"
	SettlementSummaryDetailsNetworkUnknown    SettlementSummaryDetailsNetwork = "UNKNOWN"
	SettlementSummaryDetailsNetworkVisa       SettlementSummaryDetailsNetwork = "VISA"
)

func (SettlementSummaryDetailsNetwork) IsKnown added in v0.27.0 

func (r SettlementSummaryDetailsNetwork) IsKnown() bool

type ShippingAddressParam 

type ShippingAddressParam = shared.ShippingAddressParam

This is an alias to an internal type.

type SpendLimitDuration 

type SpendLimitDuration string

Spend limit duration values:

  • `ANNUALLY` - Card will authorize transactions up to spend limit for the trailing year.
  • `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the card.
  • `MONTHLY` - Card will authorize transactions up to spend limit for the trailing month. To support recurring monthly payments, which can occur on different day every month, the time window we consider for monthly velocity starts 6 days after the current calendar date one month prior.
  • `TRANSACTION` - Card will authorize multiple transactions if each individual transaction is under the spend limit.
const (
	SpendLimitDurationAnnually    SpendLimitDuration = "ANNUALLY"
	SpendLimitDurationForever     SpendLimitDuration = "FOREVER"
	SpendLimitDurationMonthly     SpendLimitDuration = "MONTHLY"
	SpendLimitDurationTransaction SpendLimitDuration = "TRANSACTION"
)

func (SpendLimitDuration) IsKnown added in v0.27.0 

func (r SpendLimitDuration) IsKnown() bool

type Statement added in v0.9.0 

type Statement struct {
	// Globally unique identifier for a statement
	Token           string                   `json:"token,required"`
	AccountStanding StatementAccountStanding `json:"account_standing,required"`
	AmountDue       StatementAmountDue       `json:"amount_due,required"`
	// Amount of credit available to spend in cents
	AvailableCredit int64 `json:"available_credit,required"`
	// Timestamp of when the statement was created
	Created time.Time `json:"created,required" format:"date-time"`
	// This is the maximum credit balance extended by the lender in cents
	CreditLimit int64 `json:"credit_limit,required"`
	// Globally unique identifier for a credit product
	CreditProductToken string `json:"credit_product_token,required"`
	// Number of days in the billing cycle
	DaysInBillingCycle int64 `json:"days_in_billing_cycle,required"`
	// Balance at the end of the billing period. For charge cards, this should be the
	// same at the statement amount due in cents
	EndingBalance int64 `json:"ending_balance,required"`
	// Globally unique identifier for a financial account
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Date of when the next statement will be created
	NextStatementDate time.Time `json:"next_statement_date,required" format:"date"`
	// Date when the payment is due
	PaymentDueDate time.Time             `json:"payment_due_date,required" format:"date"`
	PeriodTotals   StatementPeriodTotals `json:"period_totals,required"`
	// Balance at the start of the billing period
	StartingBalance int64 `json:"starting_balance,required"`
	// Date when the billing period ended
	StatementEndDate time.Time `json:"statement_end_date,required" format:"date"`
	// Date when the billing period began
	StatementStartDate time.Time              `json:"statement_start_date,required" format:"date"`
	StatementType      StatementStatementType `json:"statement_type,required"`
	// Timestamp of when the statement was updated
	Updated         time.Time                `json:"updated,required" format:"date-time"`
	YtdTotals       StatementYtdTotals       `json:"ytd_totals,required"`
	InterestDetails StatementInterestDetails `json:"interest_details,nullable"`
	// Date when the next payment is due
	NextPaymentDueDate time.Time `json:"next_payment_due_date" format:"date"`
	// Date when the next billing period will end
	NextStatementEndDate time.Time     `json:"next_statement_end_date" format:"date"`
	JSON                 statementJSON `json:"-"`
}

func (*Statement) UnmarshalJSON added in v0.9.0 

func (r *Statement) UnmarshalJSON(data []byte) (err error)

type StatementAccountStanding added in v0.40.0 

type StatementAccountStanding struct {
	// Number of consecutive full payments made
	ConsecutiveFullPaymentsMade int64 `json:"consecutive_full_payments_made,required"`
	// Number of consecutive minimum payments made
	ConsecutiveMinimumPaymentsMade int64 `json:"consecutive_minimum_payments_made,required"`
	// Number of consecutive minimum payments missed
	ConsecutiveMinimumPaymentsMissed int64 `json:"consecutive_minimum_payments_missed,required"`
	// Number of days past due
	DaysPastDue int64 `json:"days_past_due,required"`
	// Whether the account currently has grace or not
	HasGrace bool `json:"has_grace,required"`
	// Current overall period number
	PeriodNumber int64                               `json:"period_number,required"`
	PeriodState  StatementAccountStandingPeriodState `json:"period_state,required"`
	JSON         statementAccountStandingJSON        `json:"-"`
}

func (*StatementAccountStanding) UnmarshalJSON added in v0.40.0 

func (r *StatementAccountStanding) UnmarshalJSON(data []byte) (err error)

type StatementAccountStandingPeriodState added in v0.41.0 

type StatementAccountStandingPeriodState string
const (
	StatementAccountStandingPeriodStateStandard StatementAccountStandingPeriodState = "STANDARD"
	StatementAccountStandingPeriodStatePromo    StatementAccountStandingPeriodState = "PROMO"
	StatementAccountStandingPeriodStatePenalty  StatementAccountStandingPeriodState = "PENALTY"
)

func (StatementAccountStandingPeriodState) IsKnown added in v0.41.0 

func (r StatementAccountStandingPeriodState) IsKnown() bool

type StatementAmountDue added in v0.55.0 

type StatementAmountDue struct {
	// Payment due at the end of the billing period in cents. Negative amount indicates
	// something is owed. If the amount owed is positive there was a net credit. If
	// auto-collections are enabled this is the amount that will be requested on the
	// payment due date
	Amount int64 `json:"amount,required"`
	// Amount past due for statement in cents
	PastDue int64                  `json:"past_due,required"`
	JSON    statementAmountDueJSON `json:"-"`
}

func (*StatementAmountDue) UnmarshalJSON added in v0.55.0 

func (r *StatementAmountDue) UnmarshalJSON(data []byte) (err error)

type StatementInterestDetails added in v0.55.0 

type StatementInterestDetails struct {
	ActualInterestCharged     int64                                             `json:"actual_interest_charged,required,nullable"`
	DailyBalanceAmounts       StatementInterestDetailsDailyBalanceAmounts       `json:"daily_balance_amounts,required"`
	EffectiveApr              StatementInterestDetailsEffectiveApr              `json:"effective_apr,required"`
	InterestCalculationMethod StatementInterestDetailsInterestCalculationMethod `json:"interest_calculation_method,required"`
	InterestForPeriod         StatementInterestDetailsInterestForPeriod         `json:"interest_for_period,required"`
	PrimeRate                 string                                            `json:"prime_rate,required,nullable"`
	MinimumInterestCharged    int64                                             `json:"minimum_interest_charged,nullable"`
	JSON                      statementInterestDetailsJSON                      `json:"-"`
}

func (*StatementInterestDetails) UnmarshalJSON added in v0.55.0 

func (r *StatementInterestDetails) UnmarshalJSON(data []byte) (err error)

type StatementInterestDetailsDailyBalanceAmounts added in v0.55.0 

type StatementInterestDetailsDailyBalanceAmounts struct {
	BalanceTransfers string                                          `json:"balance_transfers,required"`
	CashAdvances     string                                          `json:"cash_advances,required"`
	Purchases        string                                          `json:"purchases,required"`
	JSON             statementInterestDetailsDailyBalanceAmountsJSON `json:"-"`
}

func (*StatementInterestDetailsDailyBalanceAmounts) UnmarshalJSON added in v0.55.0 

func (r *StatementInterestDetailsDailyBalanceAmounts) UnmarshalJSON(data []byte) (err error)

type StatementInterestDetailsEffectiveApr added in v0.55.0 

type StatementInterestDetailsEffectiveApr struct {
	BalanceTransfers string                                   `json:"balance_transfers,required"`
	CashAdvances     string                                   `json:"cash_advances,required"`
	Purchases        string                                   `json:"purchases,required"`
	JSON             statementInterestDetailsEffectiveAprJSON `json:"-"`
}

func (*StatementInterestDetailsEffectiveApr) UnmarshalJSON added in v0.55.0 

func (r *StatementInterestDetailsEffectiveApr) UnmarshalJSON(data []byte) (err error)

type StatementInterestDetailsInterestCalculationMethod added in v0.55.0 

type StatementInterestDetailsInterestCalculationMethod string
const (
	StatementInterestDetailsInterestCalculationMethodDaily        StatementInterestDetailsInterestCalculationMethod = "DAILY"
	StatementInterestDetailsInterestCalculationMethodAverageDaily StatementInterestDetailsInterestCalculationMethod = "AVERAGE_DAILY"
)

func (StatementInterestDetailsInterestCalculationMethod) IsKnown added in v0.55.0 

func (r StatementInterestDetailsInterestCalculationMethod) IsKnown() bool

type StatementInterestDetailsInterestForPeriod added in v0.55.0 

type StatementInterestDetailsInterestForPeriod struct {
	BalanceTransfers string                                        `json:"balance_transfers,required"`
	CashAdvances     string                                        `json:"cash_advances,required"`
	Purchases        string                                        `json:"purchases,required"`
	JSON             statementInterestDetailsInterestForPeriodJSON `json:"-"`
}

func (*StatementInterestDetailsInterestForPeriod) UnmarshalJSON added in v0.55.0 

func (r *StatementInterestDetailsInterestForPeriod) UnmarshalJSON(data []byte) (err error)

type StatementLineItems added in v0.40.0 

type StatementLineItems struct {
	Data    []StatementLineItemsData `json:"data,required"`
	HasMore bool                     `json:"has_more,required"`
	JSON    statementLineItemsJSON   `json:"-"`
}

func (*StatementLineItems) UnmarshalJSON added in v0.40.0 

func (r *StatementLineItems) UnmarshalJSON(data []byte) (err error)

type StatementLineItemsData added in v0.40.0 

type StatementLineItemsData struct {
	// Globally unique identifier for a Statement Line Item
	Token string `json:"token,required"`
	// Transaction amount in cents
	Amount   int64                          `json:"amount,required"`
	Category StatementLineItemsDataCategory `json:"category,required"`
	// Timestamp of when the line item was generated
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction
	Currency string `json:"currency,required"`
	// Date that the transaction effected the account balance
	EffectiveDate time.Time                       `json:"effective_date,required" format:"date"`
	EventType     StatementLineItemsDataEventType `json:"event_type,required"`
	// Globally unique identifier for a financial account
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Globally unique identifier for a financial transaction event
	FinancialTransactionEventToken string `json:"financial_transaction_event_token,required" format:"uuid"`
	// Globally unique identifier for a financial transaction
	FinancialTransactionToken string `json:"financial_transaction_token,required" format:"uuid"`
	// Globally unique identifier for a card
	CardToken  string                     `json:"card_token" format:"uuid"`
	Descriptor string                     `json:"descriptor"`
	JSON       statementLineItemsDataJSON `json:"-"`
}

func (*StatementLineItemsData) UnmarshalJSON added in v0.40.0 

func (r *StatementLineItemsData) UnmarshalJSON(data []byte) (err error)

type StatementLineItemsDataCategory added in v0.40.0 

type StatementLineItemsDataCategory string
const (
	StatementLineItemsDataCategoryACH                  StatementLineItemsDataCategory = "ACH"
	StatementLineItemsDataCategoryBalanceOrFunding     StatementLineItemsDataCategory = "BALANCE_OR_FUNDING"
	StatementLineItemsDataCategoryCard                 StatementLineItemsDataCategory = "CARD"
	StatementLineItemsDataCategoryExternalACH          StatementLineItemsDataCategory = "EXTERNAL_ACH"
	StatementLineItemsDataCategoryExternalCheck        StatementLineItemsDataCategory = "EXTERNAL_CHECK"
	StatementLineItemsDataCategoryExternalTransfer     StatementLineItemsDataCategory = "EXTERNAL_TRANSFER"
	StatementLineItemsDataCategoryExternalWire         StatementLineItemsDataCategory = "EXTERNAL_WIRE"
	StatementLineItemsDataCategoryManagementAdjustment StatementLineItemsDataCategory = "MANAGEMENT_ADJUSTMENT"
	StatementLineItemsDataCategoryManagementDispute    StatementLineItemsDataCategory = "MANAGEMENT_DISPUTE"
	StatementLineItemsDataCategoryManagementFee        StatementLineItemsDataCategory = "MANAGEMENT_FEE"
	StatementLineItemsDataCategoryManagementReward     StatementLineItemsDataCategory = "MANAGEMENT_REWARD"
)

func (StatementLineItemsDataCategory) IsKnown added in v0.40.0 

func (r StatementLineItemsDataCategory) IsKnown() bool

type StatementLineItemsDataEventType added in v0.40.0 

type StatementLineItemsDataEventType string
const (
	StatementLineItemsDataEventTypeACHOriginationCancelled      StatementLineItemsDataEventType = "ACH_ORIGINATION_CANCELLED"
	StatementLineItemsDataEventTypeACHOriginationInitiated      StatementLineItemsDataEventType = "ACH_ORIGINATION_INITIATED"
	StatementLineItemsDataEventTypeACHOriginationProcessed      StatementLineItemsDataEventType = "ACH_ORIGINATION_PROCESSED"
	StatementLineItemsDataEventTypeACHOriginationReleased       StatementLineItemsDataEventType = "ACH_ORIGINATION_RELEASED"
	StatementLineItemsDataEventTypeACHOriginationReviewed       StatementLineItemsDataEventType = "ACH_ORIGINATION_REVIEWED"
	StatementLineItemsDataEventTypeACHOriginationSettled        StatementLineItemsDataEventType = "ACH_ORIGINATION_SETTLED"
	StatementLineItemsDataEventTypeACHReceiptProcessed          StatementLineItemsDataEventType = "ACH_RECEIPT_PROCESSED"
	StatementLineItemsDataEventTypeACHReceiptSettled            StatementLineItemsDataEventType = "ACH_RECEIPT_SETTLED"
	StatementLineItemsDataEventTypeACHReturnInitiated           StatementLineItemsDataEventType = "ACH_RETURN_INITIATED"
	StatementLineItemsDataEventTypeACHReturnProcessed           StatementLineItemsDataEventType = "ACH_RETURN_PROCESSED"
	StatementLineItemsDataEventTypeAuthorization                StatementLineItemsDataEventType = "AUTHORIZATION"
	StatementLineItemsDataEventTypeAuthorizationAdvice          StatementLineItemsDataEventType = "AUTHORIZATION_ADVICE"
	StatementLineItemsDataEventTypeAuthorizationExpiry          StatementLineItemsDataEventType = "AUTHORIZATION_EXPIRY"
	StatementLineItemsDataEventTypeAuthorizationReversal        StatementLineItemsDataEventType = "AUTHORIZATION_REVERSAL"
	StatementLineItemsDataEventTypeBalanceInquiry               StatementLineItemsDataEventType = "BALANCE_INQUIRY"
	StatementLineItemsDataEventTypeBillingError                 StatementLineItemsDataEventType = "BILLING_ERROR"
	StatementLineItemsDataEventTypeBillingErrorReversal         StatementLineItemsDataEventType = "BILLING_ERROR_REVERSAL"
	StatementLineItemsDataEventTypeCardToCard                   StatementLineItemsDataEventType = "CARD_TO_CARD"
	StatementLineItemsDataEventTypeCashBack                     StatementLineItemsDataEventType = "CASH_BACK"
	StatementLineItemsDataEventTypeCashBackReversal             StatementLineItemsDataEventType = "CASH_BACK_REVERSAL"
	StatementLineItemsDataEventTypeClearing                     StatementLineItemsDataEventType = "CLEARING"
	StatementLineItemsDataEventTypeCorrectionCredit             StatementLineItemsDataEventType = "CORRECTION_CREDIT"
	StatementLineItemsDataEventTypeCorrectionDebit              StatementLineItemsDataEventType = "CORRECTION_DEBIT"
	StatementLineItemsDataEventTypeCreditAuthorization          StatementLineItemsDataEventType = "CREDIT_AUTHORIZATION"
	StatementLineItemsDataEventTypeCreditAuthorizationAdvice    StatementLineItemsDataEventType = "CREDIT_AUTHORIZATION_ADVICE"
	StatementLineItemsDataEventTypeCurrencyConversion           StatementLineItemsDataEventType = "CURRENCY_CONVERSION"
	StatementLineItemsDataEventTypeCurrencyConversionReversal   StatementLineItemsDataEventType = "CURRENCY_CONVERSION_REVERSAL"
	StatementLineItemsDataEventTypeDisputeWon                   StatementLineItemsDataEventType = "DISPUTE_WON"
	StatementLineItemsDataEventTypeExternalACHCanceled          StatementLineItemsDataEventType = "EXTERNAL_ACH_CANCELED"
	StatementLineItemsDataEventTypeExternalACHInitiated         StatementLineItemsDataEventType = "EXTERNAL_ACH_INITIATED"
	StatementLineItemsDataEventTypeExternalACHReleased          StatementLineItemsDataEventType = "EXTERNAL_ACH_RELEASED"
	StatementLineItemsDataEventTypeExternalACHReversed          StatementLineItemsDataEventType = "EXTERNAL_ACH_REVERSED"
	StatementLineItemsDataEventTypeExternalACHSettled           StatementLineItemsDataEventType = "EXTERNAL_ACH_SETTLED"
	StatementLineItemsDataEventTypeExternalCheckCanceled        StatementLineItemsDataEventType = "EXTERNAL_CHECK_CANCELED"
	StatementLineItemsDataEventTypeExternalCheckInitiated       StatementLineItemsDataEventType = "EXTERNAL_CHECK_INITIATED"
	StatementLineItemsDataEventTypeExternalCheckReleased        StatementLineItemsDataEventType = "EXTERNAL_CHECK_RELEASED"
	StatementLineItemsDataEventTypeExternalCheckReversed        StatementLineItemsDataEventType = "EXTERNAL_CHECK_REVERSED"
	StatementLineItemsDataEventTypeExternalCheckSettled         StatementLineItemsDataEventType = "EXTERNAL_CHECK_SETTLED"
	StatementLineItemsDataEventTypeExternalTransferCanceled     StatementLineItemsDataEventType = "EXTERNAL_TRANSFER_CANCELED"
	StatementLineItemsDataEventTypeExternalTransferInitiated    StatementLineItemsDataEventType = "EXTERNAL_TRANSFER_INITIATED"
	StatementLineItemsDataEventTypeExternalTransferReleased     StatementLineItemsDataEventType = "EXTERNAL_TRANSFER_RELEASED"
	StatementLineItemsDataEventTypeExternalTransferReversed     StatementLineItemsDataEventType = "EXTERNAL_TRANSFER_REVERSED"
	StatementLineItemsDataEventTypeExternalTransferSettled      StatementLineItemsDataEventType = "EXTERNAL_TRANSFER_SETTLED"
	StatementLineItemsDataEventTypeExternalWireCanceled         StatementLineItemsDataEventType = "EXTERNAL_WIRE_CANCELED"
	StatementLineItemsDataEventTypeExternalWireInitiated        StatementLineItemsDataEventType = "EXTERNAL_WIRE_INITIATED"
	StatementLineItemsDataEventTypeExternalWireReleased         StatementLineItemsDataEventType = "EXTERNAL_WIRE_RELEASED"
	StatementLineItemsDataEventTypeExternalWireReversed         StatementLineItemsDataEventType = "EXTERNAL_WIRE_REVERSED"
	StatementLineItemsDataEventTypeExternalWireSettled          StatementLineItemsDataEventType = "EXTERNAL_WIRE_SETTLED"
	StatementLineItemsDataEventTypeFinancialAuthorization       StatementLineItemsDataEventType = "FINANCIAL_AUTHORIZATION"
	StatementLineItemsDataEventTypeFinancialCreditAuthorization StatementLineItemsDataEventType = "FINANCIAL_CREDIT_AUTHORIZATION"
	StatementLineItemsDataEventTypeInterest                     StatementLineItemsDataEventType = "INTEREST"
	StatementLineItemsDataEventTypeInterestReversal             StatementLineItemsDataEventType = "INTEREST_REVERSAL"
	StatementLineItemsDataEventTypeLatePayment                  StatementLineItemsDataEventType = "LATE_PAYMENT"
	StatementLineItemsDataEventTypeLatePaymentReversal          StatementLineItemsDataEventType = "LATE_PAYMENT_REVERSAL"
	StatementLineItemsDataEventTypeProvisionalCredit            StatementLineItemsDataEventType = "PROVISIONAL_CREDIT"
	StatementLineItemsDataEventTypeProvisionalCreditReversal    StatementLineItemsDataEventType = "PROVISIONAL_CREDIT_REVERSAL"
	StatementLineItemsDataEventTypeReturn                       StatementLineItemsDataEventType = "RETURN"
	StatementLineItemsDataEventTypeReturnReversal               StatementLineItemsDataEventType = "RETURN_REVERSAL"
	StatementLineItemsDataEventTypeTransfer                     StatementLineItemsDataEventType = "TRANSFER"
	StatementLineItemsDataEventTypeTransferInsufficientFunds    StatementLineItemsDataEventType = "TRANSFER_INSUFFICIENT_FUNDS"
)

func (StatementLineItemsDataEventType) IsKnown added in v0.40.0 

func (r StatementLineItemsDataEventType) IsKnown() bool

type StatementPeriodTotals added in v0.40.0 

type StatementPeriodTotals struct {
	// Opening balance transferred from previous account in cents
	BalanceTransfers int64 `json:"balance_transfers,required"`
	// ATM and cashback transactions in cents
	CashAdvances int64 `json:"cash_advances,required"`
	// Volume of credit management operation transactions less any balance transfers in
	// cents
	Credits int64 `json:"credits,required"`
	// Volume of debit management operation transactions less any interest in cents
	Fees int64 `json:"fees,required"`
	// Interest accrued in cents
	Interest int64 `json:"interest,required"`
	// Any funds transfers which affective the balance in cents
	Payments int64 `json:"payments,required"`
	// Net card transaction volume less any cash advances in cents
	Purchases int64                     `json:"purchases,required"`
	JSON      statementPeriodTotalsJSON `json:"-"`
}

func (*StatementPeriodTotals) UnmarshalJSON added in v0.40.0 

func (r *StatementPeriodTotals) UnmarshalJSON(data []byte) (err error)

type StatementStatementType added in v0.57.0 

type StatementStatementType string
const (
	StatementStatementTypeInitial   StatementStatementType = "INITIAL"
	StatementStatementTypePeriodEnd StatementStatementType = "PERIOD_END"
)

func (StatementStatementType) IsKnown added in v0.57.0 

func (r StatementStatementType) IsKnown() bool

type StatementYtdTotals added in v0.40.0 

type StatementYtdTotals struct {
	// Opening balance transferred from previous account in cents
	BalanceTransfers int64 `json:"balance_transfers,required"`
	// ATM and cashback transactions in cents
	CashAdvances int64 `json:"cash_advances,required"`
	// Volume of credit management operation transactions less any balance transfers in
	// cents
	Credits int64 `json:"credits,required"`
	// Volume of debit management operation transactions less any interest in cents
	Fees int64 `json:"fees,required"`
	// Interest accrued in cents
	Interest int64 `json:"interest,required"`
	// Any funds transfers which affective the balance in cents
	Payments int64 `json:"payments,required"`
	// Net card transaction volume less any cash advances in cents
	Purchases int64                  `json:"purchases,required"`
	JSON      statementYtdTotalsJSON `json:"-"`
}

func (*StatementYtdTotals) UnmarshalJSON added in v0.40.0 

func (r *StatementYtdTotals) UnmarshalJSON(data []byte) (err error)

type Statements added in v0.40.0 

type Statements struct {
	Data    []Statement    `json:"data,required"`
	HasMore bool           `json:"has_more,required"`
	JSON    statementsJSON `json:"-"`
}

func (*Statements) UnmarshalJSON added in v0.40.0 

func (r *Statements) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponse added in v0.6.6 

type ThreeDSAuthenticationGetResponse struct {
	// Globally unique identifier for the 3DS authentication.
	Token string `json:"token,required" format:"uuid"`
	// Type of account/card that is being used for the transaction. Maps to EMV 3DS
	// field `acctType`.
	AccountType ThreeDSAuthenticationGetResponseAccountType `json:"account_type,required,nullable"`
	// Indicates the outcome of the 3DS authentication process.
	AuthenticationResult ThreeDSAuthenticationGetResponseAuthenticationResult `json:"authentication_result,required,nullable"`
	// Indicates whether the expiration date provided by the cardholder during checkout
	// matches Lithic's record of the card's expiration date.
	CardExpiryCheck ThreeDSAuthenticationGetResponseCardExpiryCheck `json:"card_expiry_check,required"`
	// Globally unique identifier for the card on which the 3DS authentication has
	// occurred.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Object containing data about the cardholder provided during the transaction.
	Cardholder ThreeDSAuthenticationGetResponseCardholder `json:"cardholder,required"`
	// Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
	Channel ThreeDSAuthenticationGetResponseChannel `json:"channel,required"`
	// Date and time when the authentication was created in Lithic's system.
	Created time.Time `json:"created,required" format:"date-time"`
	// Entity that made the authentication decision.
	DecisionMadeBy ThreeDSAuthenticationGetResponseDecisionMadeBy `json:"decision_made_by,required,nullable"`
	// Object containing data about the merchant involved in the e-commerce
	// transaction.
	Merchant ThreeDSAuthenticationGetResponseMerchant `json:"merchant,required"`
	// Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
	// NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
	// populated.
	MessageCategory ThreeDSAuthenticationGetResponseMessageCategory `json:"message_category,required"`
	// Object containing additional data about the 3DS request that is beyond the EMV
	// 3DS standard spec (e.g., specific fields that only certain card networks send
	// but are not required across all 3DS requests).
	AdditionalData ThreeDSAuthenticationGetResponseAdditionalData `json:"additional_data,nullable"`
	// Object containing data about the app used in the e-commerce transaction. Present
	// if the channel is 'APP_BASED'.
	App ThreeDSAuthenticationGetResponseApp `json:"app"`
	// Type of authentication request - i.e., the type of transaction or interaction is
	// causing the merchant to request an authentication. Maps to EMV 3DS field
	// threeDSRequestorAuthenticationInd.
	AuthenticationRequestType ThreeDSAuthenticationGetResponseAuthenticationRequestType `json:"authentication_request_type,nullable"`
	// Object containing data about the browser used in the e-commerce transaction.
	// Present if the channel is 'BROWSER'.
	Browser ThreeDSAuthenticationGetResponseBrowser `json:"browser"`
	// Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that
	// takes place at the initiation of the merchant rather than the cardholder. The
	// most common example of this is where a merchant is authenticating before billing
	// for a recurring transaction such as a pay TV subscription or a utility bill.
	// Maps to EMV 3DS field threeRIInd.
	ThreeRiRequestType ThreeDSAuthenticationGetResponseThreeRiRequestType `json:"three_ri_request_type,nullable"`
	// Object containing data about the e-commerce transaction for which the merchant
	// is requesting authentication.
	Transaction ThreeDSAuthenticationGetResponseTransaction `json:"transaction,nullable"`
	JSON        threeDSAuthenticationGetResponseJSON        `json:"-"`
}

func (*ThreeDSAuthenticationGetResponse) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponse) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseAccountType added in v0.6.6 

type ThreeDSAuthenticationGetResponseAccountType string

Type of account/card that is being used for the transaction. Maps to EMV 3DS field `acctType`. 

const (
	ThreeDSAuthenticationGetResponseAccountTypeCredit        ThreeDSAuthenticationGetResponseAccountType = "CREDIT"
	ThreeDSAuthenticationGetResponseAccountTypeDebit         ThreeDSAuthenticationGetResponseAccountType = "DEBIT"
	ThreeDSAuthenticationGetResponseAccountTypeNotApplicable ThreeDSAuthenticationGetResponseAccountType = "NOT_APPLICABLE"
)

func (ThreeDSAuthenticationGetResponseAccountType) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseAccountType) IsKnown() bool

type ThreeDSAuthenticationGetResponseAdditionalData added in v0.6.6 

type ThreeDSAuthenticationGetResponseAdditionalData struct {
	// Mastercard only: Indicates whether the network would have considered the
	// authentication request to be low risk or not.
	NetworkDecision ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision `json:"network_decision,nullable"`
	// Mastercard only: Assessment by the network of the authentication risk level,
	// with a higher value indicating a higher amount of risk.
	NetworkRiskScore float64                                            `json:"network_risk_score,nullable"`
	JSON             threeDSAuthenticationGetResponseAdditionalDataJSON `json:"-"`
}

Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).

func (*ThreeDSAuthenticationGetResponseAdditionalData) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseAdditionalData) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision added in v0.6.6 

type ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision string

Mastercard only: Indicates whether the network would have considered the authentication request to be low risk or not. 

const (
	ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecisionLowRisk    ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision = "LOW_RISK"
	ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecisionNotLowRisk ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision = "NOT_LOW_RISK"
)

func (ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision) IsKnown() bool

type ThreeDSAuthenticationGetResponseApp added in v0.6.6 

type ThreeDSAuthenticationGetResponseApp struct {
	// Device information gathered from the cardholder's device - JSON name/value pairs
	// that is Base64url encoded. Maps to EMV 3DS field deviceInfo.
	DeviceInfo string `json:"device_info,nullable"`
	// External IP address used by the app generating the 3DS authentication request.
	// Maps to EMV 3DS field appIp.
	Ip   string                                  `json:"ip"`
	JSON threeDSAuthenticationGetResponseAppJSON `json:"-"`
}

Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

func (*ThreeDSAuthenticationGetResponseApp) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseApp) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseAuthenticationRequestType added in v0.6.6 

type ThreeDSAuthenticationGetResponseAuthenticationRequestType string

Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd. 

const (
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeAddCard                        ThreeDSAuthenticationGetResponseAuthenticationRequestType = "ADD_CARD"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeBillingAgreement               ThreeDSAuthenticationGetResponseAuthenticationRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeDelayedShipment                ThreeDSAuthenticationGetResponseAuthenticationRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeEmvTokenCardholderVerification ThreeDSAuthenticationGetResponseAuthenticationRequestType = "EMV_TOKEN_CARDHOLDER_VERIFICATION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeInstallmentTransaction         ThreeDSAuthenticationGetResponseAuthenticationRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeMaintainCard                   ThreeDSAuthenticationGetResponseAuthenticationRequestType = "MAINTAIN_CARD"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypePaymentTransaction             ThreeDSAuthenticationGetResponseAuthenticationRequestType = "PAYMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeRecurringTransaction           ThreeDSAuthenticationGetResponseAuthenticationRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeSplitPayment                   ThreeDSAuthenticationGetResponseAuthenticationRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeSplitShipment                  ThreeDSAuthenticationGetResponseAuthenticationRequestType = "SPLIT_SHIPMENT"
)

func (ThreeDSAuthenticationGetResponseAuthenticationRequestType) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseAuthenticationRequestType) IsKnown() bool

type ThreeDSAuthenticationGetResponseAuthenticationResult added in v0.6.6 

type ThreeDSAuthenticationGetResponseAuthenticationResult string

Indicates the outcome of the 3DS authentication process. 

const (
	ThreeDSAuthenticationGetResponseAuthenticationResultDecline ThreeDSAuthenticationGetResponseAuthenticationResult = "DECLINE"
	ThreeDSAuthenticationGetResponseAuthenticationResultSuccess ThreeDSAuthenticationGetResponseAuthenticationResult = "SUCCESS"
)

func (ThreeDSAuthenticationGetResponseAuthenticationResult) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseAuthenticationResult) IsKnown() bool

type ThreeDSAuthenticationGetResponseBrowser added in v0.6.6 

type ThreeDSAuthenticationGetResponseBrowser struct {
	// IP address of the browser as returned by the HTTP headers to the 3DS requestor
	// (e.g., merchant or digital wallet). Maps to EMV 3DS field browserIP.
	Ip string `json:"ip,nullable"`
	// Indicates whether the cardholder's browser has the ability to execute Java. Maps
	// to EMV 3DS field browserJavaEnabled.
	JavaEnabled bool `json:"java_enabled,nullable"`
	// Indicates whether the cardholder's browser has the ability to execute
	// JavaScript. Maps to EMV 3DS field browserJavascriptEnabled.
	JavascriptEnabled bool `json:"javascript_enabled,nullable"`
	// Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS
	// field browserLanguage.
	Language string `json:"language,nullable"`
	// Time zone of the cardholder's browser offset in minutes between UTC and the
	// cardholder browser's local time. The offset is positive if the local time is
	// behind UTC and negative if it is ahead. Maps to EMV 3DS field browserTz.
	TimeZone string `json:"time_zone,nullable"`
	// Content of the HTTP user-agent header. Maps to EMV 3DS field browserUserAgent.
	UserAgent string                                      `json:"user_agent,nullable"`
	JSON      threeDSAuthenticationGetResponseBrowserJSON `json:"-"`
}

Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

func (*ThreeDSAuthenticationGetResponseBrowser) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseBrowser) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseCardExpiryCheck added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardExpiryCheck string

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. 

const (
	ThreeDSAuthenticationGetResponseCardExpiryCheckMatch      ThreeDSAuthenticationGetResponseCardExpiryCheck = "MATCH"
	ThreeDSAuthenticationGetResponseCardExpiryCheckMismatch   ThreeDSAuthenticationGetResponseCardExpiryCheck = "MISMATCH"
	ThreeDSAuthenticationGetResponseCardExpiryCheckNotPresent ThreeDSAuthenticationGetResponseCardExpiryCheck = "NOT_PRESENT"
)

func (ThreeDSAuthenticationGetResponseCardExpiryCheck) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseCardExpiryCheck) IsKnown() bool

type ThreeDSAuthenticationGetResponseCardholder added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholder struct {
	// Indicates whether the shipping address and billing address provided by the
	// cardholder are the same. This value - and assessment of whether the addresses
	// match - is provided directly in the 3DS request and is not determined by Lithic.
	// Maps to EMV 3DS field addrMatch.
	AddressMatch bool `json:"address_match,nullable"`
	// Object containing data on the billing address provided during the transaction.
	BillingAddress ThreeDSAuthenticationGetResponseCardholderBillingAddress `json:"billing_address"`
	// Email address that is either provided by the cardholder or is on file with the
	// merchant in a 3RI request. Maps to EMV 3DS field email.
	Email string `json:"email,nullable"`
	// Name of the cardholder. Maps to EMV 3DS field cardholderName.
	Name string `json:"name,nullable"`
	// Home phone number provided by the cardholder. Maps to EMV 3DS fields
	// homePhone.cc and homePhone.subscriber.
	PhoneNumberHome string `json:"phone_number_home,nullable"`
	// Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
	// mobilePhone.cc and mobilePhone.subscriber.
	PhoneNumberMobile string `json:"phone_number_mobile,nullable"`
	// Work phone number provided by the cardholder. Maps to EMV 3DS fields
	// workPhone.cc and workPhone.subscriber.
	PhoneNumberWork string `json:"phone_number_work,nullable"`
	// Object containing data on the shipping address provided during the transaction.
	ShippingAddress ThreeDSAuthenticationGetResponseCardholderShippingAddress `json:"shipping_address"`
	JSON            threeDSAuthenticationGetResponseCardholderJSON            `json:"-"`
}

Object containing data about the cardholder provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholder) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseCardholder) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseCardholderBillingAddress added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholderBillingAddress struct {
	// First line of the street address provided by the cardholder.
	Address1 string `json:"address1,nullable"`
	// Second line of the street address provided by the cardholder.
	Address2 string `json:"address2,nullable"`
	// Third line of the street address provided by the cardholder.
	Address3 string `json:"address3,nullable"`
	// City of the address provided by the cardholder.
	City string `json:"city,nullable"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country string `json:"country,nullable"`
	// Postal code (e.g., ZIP code) of the address provided by the cardholder
	PostalCode string                                                       `json:"postal_code,nullable"`
	JSON       threeDSAuthenticationGetResponseCardholderBillingAddressJSON `json:"-"`
}

Object containing data on the billing address provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholderBillingAddress) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseCardholderBillingAddress) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseCardholderShippingAddress added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholderShippingAddress struct {
	// First line of the street address provided by the cardholder.
	Address1 string `json:"address1,nullable"`
	// Second line of the street address provided by the cardholder.
	Address2 string `json:"address2,nullable"`
	// Third line of the street address provided by the cardholder.
	Address3 string `json:"address3,nullable"`
	// City of the address provided by the cardholder.
	City string `json:"city,nullable"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country string `json:"country,nullable"`
	// Postal code (e.g., ZIP code) of the address provided by the cardholder
	PostalCode string                                                        `json:"postal_code,nullable"`
	JSON       threeDSAuthenticationGetResponseCardholderShippingAddressJSON `json:"-"`
}

Object containing data on the shipping address provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholderShippingAddress) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseCardholderShippingAddress) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseChannel added in v0.6.6 

type ThreeDSAuthenticationGetResponseChannel string

Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. 

const (
	ThreeDSAuthenticationGetResponseChannelAppBased                  ThreeDSAuthenticationGetResponseChannel = "APP_BASED"
	ThreeDSAuthenticationGetResponseChannelBrowser                   ThreeDSAuthenticationGetResponseChannel = "BROWSER"
	ThreeDSAuthenticationGetResponseChannelThreeDSRequestorInitiated ThreeDSAuthenticationGetResponseChannel = "THREE_DS_REQUESTOR_INITIATED"
)

func (ThreeDSAuthenticationGetResponseChannel) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseChannel) IsKnown() bool

type ThreeDSAuthenticationGetResponseDecisionMadeBy added in v0.6.6 

type ThreeDSAuthenticationGetResponseDecisionMadeBy string

Entity that made the authentication decision. 

const (
	ThreeDSAuthenticationGetResponseDecisionMadeByCustomerEndpoint ThreeDSAuthenticationGetResponseDecisionMadeBy = "CUSTOMER_ENDPOINT"
	ThreeDSAuthenticationGetResponseDecisionMadeByLithicDefault    ThreeDSAuthenticationGetResponseDecisionMadeBy = "LITHIC_DEFAULT"
	ThreeDSAuthenticationGetResponseDecisionMadeByLithicRules      ThreeDSAuthenticationGetResponseDecisionMadeBy = "LITHIC_RULES"
	ThreeDSAuthenticationGetResponseDecisionMadeByNetwork          ThreeDSAuthenticationGetResponseDecisionMadeBy = "NETWORK"
	ThreeDSAuthenticationGetResponseDecisionMadeByUnknown          ThreeDSAuthenticationGetResponseDecisionMadeBy = "UNKNOWN"
)

func (ThreeDSAuthenticationGetResponseDecisionMadeBy) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseDecisionMadeBy) IsKnown() bool

type ThreeDSAuthenticationGetResponseMerchant added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchant struct {
	// Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
	// acquirerMerchantId.
	ID string `json:"id,required"`
	// Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
	// field merchantCountryCode.
	Country string `json:"country,required"`
	// Merchant category code assigned to the merchant that describes its business
	// activity type. Maps to EMV 3DS field mcc.
	Mcc string `json:"mcc,required"`
	// Name of the merchant. Maps to EMV 3DS field merchantName.
	Name string `json:"name,required"`
	// Object containing additional data indicating additional risk factors related to
	// the e-commerce transaction.
	RiskIndicator ThreeDSAuthenticationGetResponseMerchantRiskIndicator `json:"risk_indicator,required"`
	JSON          threeDSAuthenticationGetResponseMerchantJSON          `json:"-"`
}

Object containing data about the merchant involved in the e-commerce transaction.

func (*ThreeDSAuthenticationGetResponseMerchant) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseMerchant) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseMerchantRiskIndicator added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicator struct {
	// In transactions with electronic delivery, email address to which merchandise is
	// delivered. Maps to EMV 3DS field deliveryEmailAddress.
	DeliveryEmailAddress string `json:"delivery_email_address,nullable"`
	// The delivery time frame for the merchandise. Maps to EMV 3DS field
	// deliveryTimeframe.
	DeliveryTimeFrame ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame `json:"delivery_time_frame,nullable"`
	// In prepaid or gift card purchase transactions, purchase amount total in major
	// units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
	// giftCardAmount.
	GiftCardAmount float64 `json:"gift_card_amount,nullable"`
	// In prepaid or gift card purchase transactions, count of individual prepaid or
	// gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.
	GiftCardCount float64 `json:"gift_card_count,nullable"`
	// In prepaid or gift card purchase transactions, currency code of the gift card.
	// Maps to EMV 3DS field giftCardCurr.
	GiftCardCurrency string `json:"gift_card_currency,nullable"`
	// Indicates whether the purchase is for merchandise that is available now or at a
	// future date. Maps to EMV 3DS field preOrderPurchaseInd.
	OrderAvailability ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability `json:"order_availability,nullable"`
	// In pre-order purchase transactions, the expected date that the merchandise will
	// be available. Maps to EMV 3DS field preOrderDate.
	PreOrderAvailableDate time.Time `json:"pre_order_available_date,nullable" format:"date-time"`
	// Indicates whether the cardholder is reordering previously purchased merchandise.
	// Maps to EMV 3DS field reorderItemsInd.
	ReorderItems ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems `json:"reorder_items,nullable"`
	// Shipping method that the cardholder chose for the transaction. If purchase
	// includes one or more item, this indicator is used for the physical goods; if the
	// purchase only includes digital goods, this indicator is used to describe the
	// most expensive item purchased. Maps to EMV 3DS field shipIndicator.
	ShippingMethod ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod `json:"shipping_method,nullable"`
	JSON           threeDSAuthenticationGetResponseMerchantRiskIndicatorJSON           `json:"-"`
}

Object containing additional data indicating additional risk factors related to the e-commerce transaction.

func (*ThreeDSAuthenticationGetResponseMerchantRiskIndicator) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseMerchantRiskIndicator) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame string

The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimeframe. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameElectronicDelivery   ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "ELECTRONIC_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameOvernightShipping    ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "OVERNIGHT_SHIPPING"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameSameDayShipping      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "SAME_DAY_SHIPPING"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameTwoDayOrMoreShipping ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "TWO_DAY_OR_MORE_SHIPPING"
)

func (ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame) IsKnown() bool

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability string

Indicates whether the purchase is for merchandise that is available now or at a future date. Maps to EMV 3DS field preOrderPurchaseInd. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailabilityFutureAvailability   ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability = "FUTURE_AVAILABILITY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailabilityMerchandiseAvailable ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability = "MERCHANDISE_AVAILABLE"
)

func (ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability) IsKnown() bool

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems string

Indicates whether the cardholder is reordering previously purchased merchandise. Maps to EMV 3DS field reorderItemsInd. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItemsFirstTimeOrdered ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems = "FIRST_TIME_ORDERED"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItemsReordered        ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems = "REORDERED"
)

func (ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems) IsKnown() bool

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod string

Shipping method that the cardholder chose for the transaction. If purchase includes one or more item, this indicator is used for the physical goods; if the purchase only includes digital goods, this indicator is used to describe the most expensive item purchased. Maps to EMV 3DS field shipIndicator. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodDigitalGoods               ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "DIGITAL_GOODS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodLockerDelivery             ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "LOCKER_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodOther                      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "OTHER"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodPickUpAndGoDelivery        ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "PICK_UP_AND_GO_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToBillingAddress       ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_BILLING_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToNonBillingAddress    ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_NON_BILLING_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToOtherVerifiedAddress ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_OTHER_VERIFIED_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToStore                ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_STORE"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodTravelAndEventTickets      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "TRAVEL_AND_EVENT_TICKETS"
)

func (ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod) IsKnown() bool

type ThreeDSAuthenticationGetResponseMessageCategory added in v0.9.0 

type ThreeDSAuthenticationGetResponseMessageCategory string

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated. 

const (
	ThreeDSAuthenticationGetResponseMessageCategoryNonPaymentAuthentication ThreeDSAuthenticationGetResponseMessageCategory = "NON_PAYMENT_AUTHENTICATION"
	ThreeDSAuthenticationGetResponseMessageCategoryPaymentAuthentication    ThreeDSAuthenticationGetResponseMessageCategory = "PAYMENT_AUTHENTICATION"
)

func (ThreeDSAuthenticationGetResponseMessageCategory) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseMessageCategory) IsKnown() bool

type ThreeDSAuthenticationGetResponseThreeRiRequestType added in v0.6.6 

type ThreeDSAuthenticationGetResponseThreeRiRequestType string

Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd. 

const (
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeAccountVerification         ThreeDSAuthenticationGetResponseThreeRiRequestType = "ACCOUNT_VERIFICATION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeAddCard                     ThreeDSAuthenticationGetResponseThreeRiRequestType = "ADD_CARD"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeBillingAgreement            ThreeDSAuthenticationGetResponseThreeRiRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeCardSecurityCodeStatusCheck ThreeDSAuthenticationGetResponseThreeRiRequestType = "CARD_SECURITY_CODE_STATUS_CHECK"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeDelayedShipment             ThreeDSAuthenticationGetResponseThreeRiRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeDeviceBindingStatusCheck    ThreeDSAuthenticationGetResponseThreeRiRequestType = "DEVICE_BINDING_STATUS_CHECK"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeInstallmentTransaction      ThreeDSAuthenticationGetResponseThreeRiRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeMailOrder                   ThreeDSAuthenticationGetResponseThreeRiRequestType = "MAIL_ORDER"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeMaintainCardInfo            ThreeDSAuthenticationGetResponseThreeRiRequestType = "MAINTAIN_CARD_INFO"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeOtherPayment                ThreeDSAuthenticationGetResponseThreeRiRequestType = "OTHER_PAYMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeRecurringTransaction        ThreeDSAuthenticationGetResponseThreeRiRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeSplitPayment                ThreeDSAuthenticationGetResponseThreeRiRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeSplitShipment               ThreeDSAuthenticationGetResponseThreeRiRequestType = "SPLIT_SHIPMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTelephoneOrder              ThreeDSAuthenticationGetResponseThreeRiRequestType = "TELEPHONE_ORDER"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTopUp                       ThreeDSAuthenticationGetResponseThreeRiRequestType = "TOP_UP"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTrustListStatusCheck        ThreeDSAuthenticationGetResponseThreeRiRequestType = "TRUST_LIST_STATUS_CHECK"
)

func (ThreeDSAuthenticationGetResponseThreeRiRequestType) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseThreeRiRequestType) IsKnown() bool

type ThreeDSAuthenticationGetResponseTransaction added in v0.6.6 

type ThreeDSAuthenticationGetResponseTransaction struct {
	// Amount of the purchase in minor units of currency with all punctuation removed.
	// Maps to EMV 3DS field purchaseAmount.
	Amount float64 `json:"amount,required"`
	// Currency of the purchase. Maps to EMV 3DS field purchaseCurrency.
	Currency string `json:"currency,required"`
	// Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
	// 3DS field purchaseExponent.
	CurrencyExponent float64 `json:"currency_exponent,required"`
	// Date and time when the authentication was generated by the merchant/acquirer's
	// 3DS server. Maps to EMV 3DS field purchaseDate.
	DateTime time.Time `json:"date_time,required" format:"date-time"`
	// Type of the transaction for which a 3DS authentication request is occurring.
	// Maps to EMV 3DS field transType.
	Type ThreeDSAuthenticationGetResponseTransactionType `json:"type,required,nullable"`
	JSON threeDSAuthenticationGetResponseTransactionJSON `json:"-"`
}

Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

func (*ThreeDSAuthenticationGetResponseTransaction) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSAuthenticationGetResponseTransaction) UnmarshalJSON(data []byte) (err error)

type ThreeDSAuthenticationGetResponseTransactionType added in v0.6.6 

type ThreeDSAuthenticationGetResponseTransactionType string

Type of the transaction for which a 3DS authentication request is occurring. Maps to EMV 3DS field transType. 

const (
	ThreeDSAuthenticationGetResponseTransactionTypeAccountFunding           ThreeDSAuthenticationGetResponseTransactionType = "ACCOUNT_FUNDING"
	ThreeDSAuthenticationGetResponseTransactionTypeCheckAcceptance          ThreeDSAuthenticationGetResponseTransactionType = "CHECK_ACCEPTANCE"
	ThreeDSAuthenticationGetResponseTransactionTypeGoodsServicePurchase     ThreeDSAuthenticationGetResponseTransactionType = "GOODS_SERVICE_PURCHASE"
	ThreeDSAuthenticationGetResponseTransactionTypePrepaidActivationAndLoad ThreeDSAuthenticationGetResponseTransactionType = "PREPAID_ACTIVATION_AND_LOAD"
	ThreeDSAuthenticationGetResponseTransactionTypeQuasiCashTransaction     ThreeDSAuthenticationGetResponseTransactionType = "QUASI_CASH_TRANSACTION"
)

func (ThreeDSAuthenticationGetResponseTransactionType) IsKnown added in v0.27.0 

func (r ThreeDSAuthenticationGetResponseTransactionType) IsKnown() bool

type ThreeDSAuthenticationService added in v0.6.6 

type ThreeDSAuthenticationService struct {
	Options []option.RequestOption
}

ThreeDSAuthenticationService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewThreeDSAuthenticationService method instead.

func NewThreeDSAuthenticationService added in v0.6.6 

func NewThreeDSAuthenticationService(opts ...option.RequestOption) (r *ThreeDSAuthenticationService)

NewThreeDSAuthenticationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ThreeDSAuthenticationService) Get added in v0.6.6 

func (r *ThreeDSAuthenticationService) Get(ctx context.Context, threeDSAuthenticationToken string, opts ...option.RequestOption) (res *ThreeDSAuthenticationGetResponse, err error)

Get 3DS Authentication by token

func (*ThreeDSAuthenticationService) Simulate added in v0.7.4 

func (r *ThreeDSAuthenticationService) Simulate(ctx context.Context, body ThreeDSAuthenticationSimulateParams, opts ...option.RequestOption) (res *ThreeDSAuthenticationSimulateResponse, err error)

Simulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating authentications requires your customer decisioning endpoint to be set up properly (respond with a valid JSON).

type ThreeDSAuthenticationSimulateParams added in v0.7.4 

type ThreeDSAuthenticationSimulateParams struct {
	Merchant param.Field[ThreeDSAuthenticationSimulateParamsMerchant] `json:"merchant,required"`
	// Sixteen digit card number.
	Pan         param.Field[string]                                         `json:"pan,required"`
	Transaction param.Field[ThreeDSAuthenticationSimulateParamsTransaction] `json:"transaction,required"`
	// When set will use the following values as part of the Simulated Authentication.
	// When not set defaults to MATCH
	CardExpiryCheck param.Field[ThreeDSAuthenticationSimulateParamsCardExpiryCheck] `json:"card_expiry_check"`
}

func (ThreeDSAuthenticationSimulateParams) MarshalJSON added in v0.7.4 

func (r ThreeDSAuthenticationSimulateParams) MarshalJSON() (data []byte, err error)

type ThreeDSAuthenticationSimulateParamsCardExpiryCheck added in v0.58.0 

type ThreeDSAuthenticationSimulateParamsCardExpiryCheck string

When set will use the following values as part of the Simulated Authentication. When not set defaults to MATCH 

const (
	ThreeDSAuthenticationSimulateParamsCardExpiryCheckMatch      ThreeDSAuthenticationSimulateParamsCardExpiryCheck = "MATCH"
	ThreeDSAuthenticationSimulateParamsCardExpiryCheckMismatch   ThreeDSAuthenticationSimulateParamsCardExpiryCheck = "MISMATCH"
	ThreeDSAuthenticationSimulateParamsCardExpiryCheckNotPresent ThreeDSAuthenticationSimulateParamsCardExpiryCheck = "NOT_PRESENT"
)

func (ThreeDSAuthenticationSimulateParamsCardExpiryCheck) IsKnown added in v0.58.0 

func (r ThreeDSAuthenticationSimulateParamsCardExpiryCheck) IsKnown() bool

type ThreeDSAuthenticationSimulateParamsMerchant added in v0.7.4 

type ThreeDSAuthenticationSimulateParamsMerchant struct {
	// Unique identifier to identify the payment card acceptor. Corresponds to
	// `merchant_acceptor_id` in authorization.
	ID param.Field[string] `json:"id,required"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country param.Field[string] `json:"country,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc,required"`
	// Merchant descriptor, corresponds to `descriptor` in authorization.
	Name param.Field[string] `json:"name,required"`
}

func (ThreeDSAuthenticationSimulateParamsMerchant) MarshalJSON added in v0.7.4 

func (r ThreeDSAuthenticationSimulateParamsMerchant) MarshalJSON() (data []byte, err error)

type ThreeDSAuthenticationSimulateParamsTransaction added in v0.7.4 

type ThreeDSAuthenticationSimulateParamsTransaction struct {
	// Amount (in cents) to authenticate.
	Amount param.Field[int64] `json:"amount,required"`
	// 3-digit alphabetic ISO 4217 currency code.
	Currency param.Field[string] `json:"currency,required"`
}

func (ThreeDSAuthenticationSimulateParamsTransaction) MarshalJSON added in v0.7.4 

func (r ThreeDSAuthenticationSimulateParamsTransaction) MarshalJSON() (data []byte, err error)

type ThreeDSAuthenticationSimulateResponse added in v0.7.4 

type ThreeDSAuthenticationSimulateResponse struct {
	// A unique token to reference this transaction with later calls to void or clear
	// the authorization.
	Token string                                    `json:"token" format:"uuid"`
	JSON  threeDSAuthenticationSimulateResponseJSON `json:"-"`
}

func (*ThreeDSAuthenticationSimulateResponse) UnmarshalJSON added in v0.7.4 

func (r *ThreeDSAuthenticationSimulateResponse) UnmarshalJSON(data []byte) (err error)

type ThreeDSDecisioningChallengeResponseParams added in v0.47.0 

type ThreeDSDecisioningChallengeResponseParams struct {
	ChallengeResponse ChallengeResponseParam `json:"challenge_response,required"`
}

func (ThreeDSDecisioningChallengeResponseParams) MarshalJSON added in v0.47.0 

func (r ThreeDSDecisioningChallengeResponseParams) MarshalJSON() (data []byte, err error)

type ThreeDSDecisioningGetSecretResponse added in v0.6.6 

type ThreeDSDecisioningGetSecretResponse struct {
	// The 3DS Decisioning HMAC secret
	Secret string                                  `json:"secret"`
	JSON   threeDSDecisioningGetSecretResponseJSON `json:"-"`
}

func (*ThreeDSDecisioningGetSecretResponse) UnmarshalJSON added in v0.6.6 

func (r *ThreeDSDecisioningGetSecretResponse) UnmarshalJSON(data []byte) (err error)

type ThreeDSDecisioningService added in v0.6.6 

type ThreeDSDecisioningService struct {
	Options []option.RequestOption
}

ThreeDSDecisioningService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewThreeDSDecisioningService method instead.

func NewThreeDSDecisioningService added in v0.6.6 

func NewThreeDSDecisioningService(opts ...option.RequestOption) (r *ThreeDSDecisioningService)

NewThreeDSDecisioningService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ThreeDSDecisioningService) ChallengeResponse added in v0.47.0 

func (r *ThreeDSDecisioningService) ChallengeResponse(ctx context.Context, body ThreeDSDecisioningChallengeResponseParams, opts ...option.RequestOption) (err error)

Card program's response to a 3DS Challenge Request (CReq)

func (*ThreeDSDecisioningService) GetSecret added in v0.6.6 

func (r *ThreeDSDecisioningService) GetSecret(ctx context.Context, opts ...option.RequestOption) (res *ThreeDSDecisioningGetSecretResponse, err error)

Retrieve the 3DS Decisioning HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify 3DS Decisioning requests) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/3ds-decisioning#3ds-decisioning-hmac-secrets) for more detail about verifying 3DS Decisioning requests.

func (*ThreeDSDecisioningService) RotateSecret added in v0.6.6 

func (r *ThreeDSDecisioningService) RotateSecret(ctx context.Context, opts ...option.RequestOption) (err error)

Generate a new 3DS Decisioning HMAC secret key. The old secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /three_ds_decisioning/secret`](https://docs.lithic.com/reference/getthreedsdecisioningsecret) request to retrieve the new secret key.

func (*ThreeDSDecisioningService) SimulateChallenge added in v0.58.0 

func (r *ThreeDSDecisioningService) SimulateChallenge(ctx context.Context, body ThreeDSDecisioningSimulateChallengeParams, opts ...option.RequestOption) (res *ThreeDSDecisioningSimulateChallengeResponse, err error)

Simulates a 3DS authentication challenge request from the payment network as if it came from an ACS. Requires being configured for 3DS Customer Decisioning, and enrolled with Lithic's Challenge solution.

func (*ThreeDSDecisioningService) SimulateChallengeResponse added in v0.58.0 

func (r *ThreeDSDecisioningService) SimulateChallengeResponse(ctx context.Context, body ThreeDSDecisioningSimulateChallengeResponseParams, opts ...option.RequestOption) (err error)

Endpoint for responding to a 3DS Challenge initiated by a call to /v1/three_ds_decisioning/simulate/challenge

type ThreeDSDecisioningSimulateChallengeParams added in v0.58.0 

type ThreeDSDecisioningSimulateChallengeParams struct {
	// A unique token returned as part of a /v1/three_ds_authentication/simulate call
	// that responded with a CHALLENGE_REQUESTED status.
	Token param.Field[string] `json:"token" format:"uuid"`
}

func (ThreeDSDecisioningSimulateChallengeParams) MarshalJSON added in v0.58.0 

func (r ThreeDSDecisioningSimulateChallengeParams) MarshalJSON() (data []byte, err error)

type ThreeDSDecisioningSimulateChallengeResponse added in v0.58.0 

type ThreeDSDecisioningSimulateChallengeResponse struct {
	// A unique token to reference this transaction with later calls to void or clear
	// the authorization. This token is used in
	// /v1/three_ds_decisioning/simulate/challenge_response to Approve or Decline the
	// authentication
	Token string                                          `json:"token" format:"uuid"`
	JSON  threeDSDecisioningSimulateChallengeResponseJSON `json:"-"`
}

func (*ThreeDSDecisioningSimulateChallengeResponse) UnmarshalJSON added in v0.58.0 

func (r *ThreeDSDecisioningSimulateChallengeResponse) UnmarshalJSON(data []byte) (err error)

type ThreeDSDecisioningSimulateChallengeResponseParams added in v0.58.0 

type ThreeDSDecisioningSimulateChallengeResponseParams struct {
	ChallengeResponse ChallengeResponseParam `json:"challenge_response,required"`
}

func (ThreeDSDecisioningSimulateChallengeResponseParams) MarshalJSON added in v0.58.0 

func (r ThreeDSDecisioningSimulateChallengeResponseParams) MarshalJSON() (data []byte, err error)

type ThreeDSService added in v0.6.6 

type ThreeDSService struct {
	Options        []option.RequestOption
	Authentication *ThreeDSAuthenticationService
	Decisioning    *ThreeDSDecisioningService
}

ThreeDSService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewThreeDSService method instead.

func NewThreeDSService added in v0.6.6 

func NewThreeDSService(opts ...option.RequestOption) (r *ThreeDSService)

NewThreeDSService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Tokenization added in v0.7.1 

type Tokenization struct {
	// Globally unique identifier for a Tokenization
	Token string `json:"token,required" format:"uuid"`
	// The account token associated with the card being tokenized.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// The card token associated with the card being tokenized.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Date and time when the tokenization first occurred. UTC time zone.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The status of the tokenization request
	Status TokenizationStatus `json:"status,required"`
	// The entity that requested the tokenization. Represents a Digital Wallet or
	// merchant.
	TokenRequestorName TokenizationTokenRequestorName `json:"token_requestor_name,required"`
	// The network's unique reference for the tokenization.
	TokenUniqueReference string `json:"token_unique_reference,required"`
	// The channel through which the tokenization was made.
	TokenizationChannel TokenizationTokenizationChannel `json:"tokenization_channel,required"`
	// Latest date and time when the tokenization was updated. UTC time zone.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Specifies the digital card art displayed in the user’s digital wallet after
	// tokenization. This will be null if the tokenization was created without an
	// associated digital card art. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken string `json:"digital_card_art_token" format:"uuid"`
	// A list of events related to the tokenization.
	Events []TokenizationEvent `json:"events"`
	JSON   tokenizationJSON    `json:"-"`
}

func (*Tokenization) UnmarshalJSON added in v0.7.1 

func (r *Tokenization) UnmarshalJSON(data []byte) (err error)

type TokenizationDecisioningRotateSecretResponse 

type TokenizationDecisioningRotateSecretResponse struct {
	// The new Tokenization Decisioning HMAC secret
	Secret string                                          `json:"secret"`
	JSON   tokenizationDecisioningRotateSecretResponseJSON `json:"-"`
}

func (*TokenizationDecisioningRotateSecretResponse) UnmarshalJSON 

func (r *TokenizationDecisioningRotateSecretResponse) UnmarshalJSON(data []byte) (err error)

type TokenizationDecisioningService 

type TokenizationDecisioningService struct {
	Options []option.RequestOption
}

TokenizationDecisioningService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenizationDecisioningService method instead.

func NewTokenizationDecisioningService 

func NewTokenizationDecisioningService(opts ...option.RequestOption) (r *TokenizationDecisioningService)

NewTokenizationDecisioningService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TokenizationDecisioningService) GetSecret 

func (r *TokenizationDecisioningService) GetSecret(ctx context.Context, opts ...option.RequestOption) (res *TokenizationSecret, err error)

Retrieve the Tokenization Decisioning secret key. If one does not exist your program yet, calling this endpoint will create one for you. The headers of the Tokenization Decisioning request will contain a hmac signature which you can use to verify requests originate from Lithic. See [this page](https://docs.lithic.com/docs/events-api#verifying-webhooks) for more detail about verifying Tokenization Decisioning requests.

func (*TokenizationDecisioningService) RotateSecret 

func (r *TokenizationDecisioningService) RotateSecret(ctx context.Context, opts ...option.RequestOption) (res *TokenizationDecisioningRotateSecretResponse, err error)

Generate a new Tokenization Decisioning secret key. The old Tokenization Decisioning secret key will be deactivated 24 hours after a successful request to this endpoint.

type TokenizationEvent added in v0.25.0 

type TokenizationEvent struct {
	// Globally unique identifier for a Tokenization Event
	Token string `json:"token" format:"uuid"`
	// Date and time when the tokenization event first occurred. UTC time zone.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Enum representing the result of the tokenization event
	Result TokenizationEventsResult `json:"result"`
	// Enum representing the type of tokenization event that occurred
	Type TokenizationEventsType `json:"type"`
	JSON tokenizationEventJSON  `json:"-"`
}

func (*TokenizationEvent) UnmarshalJSON added in v0.25.0 

func (r *TokenizationEvent) UnmarshalJSON(data []byte) (err error)

type TokenizationEventsResult added in v0.25.0 

type TokenizationEventsResult string

Enum representing the result of the tokenization event 

const (
	TokenizationEventsResultApproved                        TokenizationEventsResult = "APPROVED"
	TokenizationEventsResultDeclined                        TokenizationEventsResult = "DECLINED"
	TokenizationEventsResultNotificationDelivered           TokenizationEventsResult = "NOTIFICATION_DELIVERED"
	TokenizationEventsResultRequireAdditionalAuthentication TokenizationEventsResult = "REQUIRE_ADDITIONAL_AUTHENTICATION"
	TokenizationEventsResultTokenActivated                  TokenizationEventsResult = "TOKEN_ACTIVATED"
	TokenizationEventsResultTokenCreated                    TokenizationEventsResult = "TOKEN_CREATED"
	TokenizationEventsResultTokenDeactivated                TokenizationEventsResult = "TOKEN_DEACTIVATED"
	TokenizationEventsResultTokenInactive                   TokenizationEventsResult = "TOKEN_INACTIVE"
	TokenizationEventsResultTokenStateUnknown               TokenizationEventsResult = "TOKEN_STATE_UNKNOWN"
	TokenizationEventsResultTokenSuspended                  TokenizationEventsResult = "TOKEN_SUSPENDED"
	TokenizationEventsResultTokenUpdated                    TokenizationEventsResult = "TOKEN_UPDATED"
)

func (TokenizationEventsResult) IsKnown added in v0.27.0 

func (r TokenizationEventsResult) IsKnown() bool

type TokenizationEventsType added in v0.25.0 

type TokenizationEventsType string

Enum representing the type of tokenization event that occurred 

const (
	TokenizationEventsTypeTokenization2Fa              TokenizationEventsType = "TOKENIZATION_2FA"
	TokenizationEventsTypeTokenizationAuthorization    TokenizationEventsType = "TOKENIZATION_AUTHORIZATION"
	TokenizationEventsTypeTokenizationDecisioning      TokenizationEventsType = "TOKENIZATION_DECISIONING"
	TokenizationEventsTypeTokenizationEligibilityCheck TokenizationEventsType = "TOKENIZATION_ELIGIBILITY_CHECK"
	TokenizationEventsTypeTokenizationUpdated          TokenizationEventsType = "TOKENIZATION_UPDATED"
)

func (TokenizationEventsType) IsKnown added in v0.27.0 

func (r TokenizationEventsType) IsKnown() bool

type TokenizationGetResponse added in v0.25.0 

type TokenizationGetResponse struct {
	Data Tokenization                `json:"data"`
	JSON tokenizationGetResponseJSON `json:"-"`
}

func (*TokenizationGetResponse) UnmarshalJSON added in v0.25.0 

func (r *TokenizationGetResponse) UnmarshalJSON(data []byte) (err error)

type TokenizationListParams added in v0.25.0 

type TokenizationListParams struct {
	// Filters for tokenizations associated with a specific account.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Filter for tokenizations created after this date.
	Begin param.Field[time.Time] `query:"begin" format:"date"`
	// Filters for tokenizations associated with a specific card.
	CardToken param.Field[string] `query:"card_token" format:"uuid"`
	// Filter for tokenizations created before this date.
	End param.Field[time.Time] `query:"end" format:"date"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Filter for tokenizations by tokenization channel. If this is not specified, only
	// DIGITAL_WALLET tokenizations will be returned.
	TokenizationChannel param.Field[TokenizationListParamsTokenizationChannel] `query:"tokenization_channel"`
}

func (TokenizationListParams) URLQuery added in v0.25.0 

func (r TokenizationListParams) URLQuery() (v url.Values)

URLQuery serializes TokenizationListParams's query parameters as `url.Values`.

type TokenizationListParamsTokenizationChannel added in v0.38.0 

type TokenizationListParamsTokenizationChannel string

Filter for tokenizations by tokenization channel. If this is not specified, only DIGITAL_WALLET tokenizations will be returned. 

const (
	TokenizationListParamsTokenizationChannelDigitalWallet TokenizationListParamsTokenizationChannel = "DIGITAL_WALLET"
	TokenizationListParamsTokenizationChannelMerchant      TokenizationListParamsTokenizationChannel = "MERCHANT"
	TokenizationListParamsTokenizationChannelAll           TokenizationListParamsTokenizationChannel = "ALL"
)

func (TokenizationListParamsTokenizationChannel) IsKnown added in v0.38.0 

func (r TokenizationListParamsTokenizationChannel) IsKnown() bool

type TokenizationResendActivationCodeParams added in v0.37.0 

type TokenizationResendActivationCodeParams struct {
	// The communication method that the user has selected to use to receive the
	// authentication code. Supported Values: Sms = "TEXT_TO_CARDHOLDER_NUMBER". Email
	// = "EMAIL_TO_CARDHOLDER_ADDRESS"
	ActivationMethodType param.Field[TokenizationResendActivationCodeParamsActivationMethodType] `json:"activation_method_type"`
}

func (TokenizationResendActivationCodeParams) MarshalJSON added in v0.37.0 

func (r TokenizationResendActivationCodeParams) MarshalJSON() (data []byte, err error)

type TokenizationResendActivationCodeParamsActivationMethodType added in v0.37.0 

type TokenizationResendActivationCodeParamsActivationMethodType string

The communication method that the user has selected to use to receive the authentication code. Supported Values: Sms = "TEXT_TO_CARDHOLDER_NUMBER". Email = "EMAIL_TO_CARDHOLDER_ADDRESS" 

const (
	TokenizationResendActivationCodeParamsActivationMethodTypeEmailToCardholderAddress TokenizationResendActivationCodeParamsActivationMethodType = "EMAIL_TO_CARDHOLDER_ADDRESS"
	TokenizationResendActivationCodeParamsActivationMethodTypeTextToCardholderNumber   TokenizationResendActivationCodeParamsActivationMethodType = "TEXT_TO_CARDHOLDER_NUMBER"
)

func (TokenizationResendActivationCodeParamsActivationMethodType) IsKnown added in v0.37.0 

func (r TokenizationResendActivationCodeParamsActivationMethodType) IsKnown() bool

type TokenizationSecret 

type TokenizationSecret struct {
	// The Tokenization Decisioning HMAC secret
	Secret string                 `json:"secret"`
	JSON   tokenizationSecretJSON `json:"-"`
}

func (*TokenizationSecret) UnmarshalJSON 

func (r *TokenizationSecret) UnmarshalJSON(data []byte) (err error)

type TokenizationService added in v0.7.1 

type TokenizationService struct {
	Options []option.RequestOption
}

TokenizationService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenizationService method instead.

func NewTokenizationService added in v0.7.1 

func NewTokenizationService(opts ...option.RequestOption) (r *TokenizationService)

NewTokenizationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TokenizationService) Activate added in v0.37.0 

func (r *TokenizationService) Activate(ctx context.Context, tokenizationToken string, opts ...option.RequestOption) (err error)

This endpoint is used to ask the card network to activate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network activates the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`. This will put the tokenization in an active state, and transactions will be allowed. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

func (*TokenizationService) Deactivate added in v0.37.0 

func (r *TokenizationService) Deactivate(ctx context.Context, tokenizationToken string, opts ...option.RequestOption) (err error)

This endpoint is used to ask the card network to deactivate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network deactivates the tokenization, the state will be updated and a tokenization.updated event will be sent. Authorizations attempted with a deactivated tokenization will be blocked and will not be forwarded to Lithic from the network. Deactivating the token is a permanent operation. If the target is a digital wallet tokenization, it will be removed from its device. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

func (*TokenizationService) Get added in v0.25.0 

func (r *TokenizationService) Get(ctx context.Context, tokenizationToken string, opts ...option.RequestOption) (res *TokenizationGetResponse, err error)

Get tokenization

func (*TokenizationService) List added in v0.25.0 

func (r *TokenizationService) List(ctx context.Context, query TokenizationListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Tokenization], err error)

List card tokenizations

func (*TokenizationService) ListAutoPaging added in v0.25.0 

func (r *TokenizationService) ListAutoPaging(ctx context.Context, query TokenizationListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Tokenization]

List card tokenizations

func (*TokenizationService) Pause added in v0.37.0 

func (r *TokenizationService) Pause(ctx context.Context, tokenizationToken string, opts ...option.RequestOption) (err error)

This endpoint is used to ask the card network to pause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network pauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `ACTIVE`. A paused token will prevent merchants from sending authorizations, and is a temporary status that can be changed. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

func (*TokenizationService) ResendActivationCode added in v0.37.0 

func (r *TokenizationService) ResendActivationCode(ctx context.Context, tokenizationToken string, body TokenizationResendActivationCodeParams, opts ...option.RequestOption) (err error)

This endpoint is used to ask the card network to send another activation code to a cardholder that has already tried tokenizing a card. A successful response indicates that the request was successfully delivered to the card network. The endpoint may only be used on Mastercard digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`. The network will send a new activation code to the one of the contact methods provided in the initial tokenization flow. If a user fails to enter the code correctly 3 times, the contact method will not be eligible for resending the activation code, and the cardholder must restart the provision process. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

func (*TokenizationService) Simulate added in v0.7.1 

func (r *TokenizationService) Simulate(ctx context.Context, body TokenizationSimulateParams, opts ...option.RequestOption) (res *TokenizationSimulateResponse, err error)

This endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem.

func (*TokenizationService) Unpause added in v0.37.0 

func (r *TokenizationService) Unpause(ctx context.Context, tokenizationToken string, opts ...option.RequestOption) (err error)

This endpoint is used to ask the card network to unpause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network unpauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `PAUSED`. This will put the tokenization in an active state, and transactions may resume. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

func (*TokenizationService) UpdateDigitalCardArt added in v0.37.0 

func (r *TokenizationService) UpdateDigitalCardArt(ctx context.Context, tokenizationToken string, body TokenizationUpdateDigitalCardArtParams, opts ...option.RequestOption) (res *TokenizationUpdateDigitalCardArtResponse, err error)

This endpoint is used update the digital card art for a digital wallet tokenization. A successful response indicates that the card network has updated the tokenization's art, and the tokenization's `digital_cart_art_token` field was updated. The endpoint may not be used on tokenizations with status `DEACTIVATED`. Note that this updates the art for one specific tokenization, not all tokenizations for a card. New tokenizations for a card will be created with the art referenced in the card object's `digital_card_art_token` field. Reach out at lithic.com/contact(https://lithic.com/contact) for more information.

type TokenizationSimulateParams added in v0.7.1 

type TokenizationSimulateParams struct {
	// The three digit cvv for the card.
	Cvv param.Field[string] `json:"cvv,required"`
	// The expiration date of the card in 'MM/YY' format.
	ExpirationDate param.Field[string] `json:"expiration_date,required"`
	// The sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// The source of the tokenization request.
	TokenizationSource param.Field[TokenizationSimulateParamsTokenizationSource] `json:"tokenization_source,required"`
	// The account score (1-5) that represents how the Digital Wallet's view on how
	// reputable an end user's account is.
	AccountScore param.Field[int64] `json:"account_score"`
	// The device score (1-5) that represents how the Digital Wallet's view on how
	// reputable an end user's device is.
	DeviceScore param.Field[int64] `json:"device_score"`
	// Optional field to specify the token requestor name for a merchant token
	// simulation. Ignored when tokenization_source is not MERCHANT.
	Entity param.Field[string] `json:"entity"`
	// The decision that the Digital Wallet's recommend
	WalletRecommendedDecision param.Field[TokenizationSimulateParamsWalletRecommendedDecision] `json:"wallet_recommended_decision"`
}

func (TokenizationSimulateParams) MarshalJSON added in v0.7.1 

func (r TokenizationSimulateParams) MarshalJSON() (data []byte, err error)

type TokenizationSimulateParamsTokenizationSource added in v0.7.1 

type TokenizationSimulateParamsTokenizationSource string

The source of the tokenization request. 

const (
	TokenizationSimulateParamsTokenizationSourceApplePay   TokenizationSimulateParamsTokenizationSource = "APPLE_PAY"
	TokenizationSimulateParamsTokenizationSourceGoogle     TokenizationSimulateParamsTokenizationSource = "GOOGLE"
	TokenizationSimulateParamsTokenizationSourceSamsungPay TokenizationSimulateParamsTokenizationSource = "SAMSUNG_PAY"
	TokenizationSimulateParamsTokenizationSourceMerchant   TokenizationSimulateParamsTokenizationSource = "MERCHANT"
)

func (TokenizationSimulateParamsTokenizationSource) IsKnown added in v0.27.0 

func (r TokenizationSimulateParamsTokenizationSource) IsKnown() bool

type TokenizationSimulateParamsWalletRecommendedDecision added in v0.7.1 

type TokenizationSimulateParamsWalletRecommendedDecision string

The decision that the Digital Wallet's recommend 

const (
	TokenizationSimulateParamsWalletRecommendedDecisionApproved                        TokenizationSimulateParamsWalletRecommendedDecision = "APPROVED"
	TokenizationSimulateParamsWalletRecommendedDecisionDeclined                        TokenizationSimulateParamsWalletRecommendedDecision = "DECLINED"
	TokenizationSimulateParamsWalletRecommendedDecisionRequireAdditionalAuthentication TokenizationSimulateParamsWalletRecommendedDecision = "REQUIRE_ADDITIONAL_AUTHENTICATION"
)

func (TokenizationSimulateParamsWalletRecommendedDecision) IsKnown added in v0.27.0 

func (r TokenizationSimulateParamsWalletRecommendedDecision) IsKnown() bool

type TokenizationSimulateResponse added in v0.7.1 

type TokenizationSimulateResponse struct {
	Data []Tokenization                   `json:"data"`
	JSON tokenizationSimulateResponseJSON `json:"-"`
}

func (*TokenizationSimulateResponse) UnmarshalJSON added in v0.7.1 

func (r *TokenizationSimulateResponse) UnmarshalJSON(data []byte) (err error)

type TokenizationStatus added in v0.7.1 

type TokenizationStatus string

The status of the tokenization request 

const (
	TokenizationStatusActive            TokenizationStatus = "ACTIVE"
	TokenizationStatusDeactivated       TokenizationStatus = "DEACTIVATED"
	TokenizationStatusInactive          TokenizationStatus = "INACTIVE"
	TokenizationStatusPaused            TokenizationStatus = "PAUSED"
	TokenizationStatusPending2Fa        TokenizationStatus = "PENDING_2FA"
	TokenizationStatusPendingActivation TokenizationStatus = "PENDING_ACTIVATION"
	TokenizationStatusUnknown           TokenizationStatus = "UNKNOWN"
)

func (TokenizationStatus) IsKnown added in v0.27.0 

func (r TokenizationStatus) IsKnown() bool

type TokenizationTokenRequestorName added in v0.7.1 

type TokenizationTokenRequestorName string

The entity that requested the tokenization. Represents a Digital Wallet or merchant. 

const (
	TokenizationTokenRequestorNameAmazonOne    TokenizationTokenRequestorName = "AMAZON_ONE"
	TokenizationTokenRequestorNameAndroidPay   TokenizationTokenRequestorName = "ANDROID_PAY"
	TokenizationTokenRequestorNameApplePay     TokenizationTokenRequestorName = "APPLE_PAY"
	TokenizationTokenRequestorNameFacebook     TokenizationTokenRequestorName = "FACEBOOK"
	TokenizationTokenRequestorNameFitbitPay    TokenizationTokenRequestorName = "FITBIT_PAY"
	TokenizationTokenRequestorNameGarminPay    TokenizationTokenRequestorName = "GARMIN_PAY"
	TokenizationTokenRequestorNameMicrosoftPay TokenizationTokenRequestorName = "MICROSOFT_PAY"
	TokenizationTokenRequestorNameNetflix      TokenizationTokenRequestorName = "NETFLIX"
	TokenizationTokenRequestorNameSamsungPay   TokenizationTokenRequestorName = "SAMSUNG_PAY"
	TokenizationTokenRequestorNameUnknown      TokenizationTokenRequestorName = "UNKNOWN"
	TokenizationTokenRequestorNameVisaCheckout TokenizationTokenRequestorName = "VISA_CHECKOUT"
)

func (TokenizationTokenRequestorName) IsKnown added in v0.27.0 

func (r TokenizationTokenRequestorName) IsKnown() bool

type TokenizationTokenizationChannel added in v0.38.0 

type TokenizationTokenizationChannel string

The channel through which the tokenization was made. 

const (
	TokenizationTokenizationChannelDigitalWallet TokenizationTokenizationChannel = "DIGITAL_WALLET"
	TokenizationTokenizationChannelMerchant      TokenizationTokenizationChannel = "MERCHANT"
)

func (TokenizationTokenizationChannel) IsKnown added in v0.38.0 

func (r TokenizationTokenizationChannel) IsKnown() bool

type TokenizationUpdateDigitalCardArtParams added in v0.37.0 

type TokenizationUpdateDigitalCardArtParams struct {
	// Specifies the digital card art to be displayed in the user’s digital wallet for
	// a tokenization. This artwork must be approved by the network and configured by
	// Lithic to use. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken param.Field[string] `json:"digital_card_art_token" format:"uuid"`
}

func (TokenizationUpdateDigitalCardArtParams) MarshalJSON added in v0.37.0 

func (r TokenizationUpdateDigitalCardArtParams) MarshalJSON() (data []byte, err error)

type TokenizationUpdateDigitalCardArtResponse added in v0.37.0 

type TokenizationUpdateDigitalCardArtResponse struct {
	Data Tokenization                                 `json:"data"`
	JSON tokenizationUpdateDigitalCardArtResponseJSON `json:"-"`
}

func (*TokenizationUpdateDigitalCardArtResponse) UnmarshalJSON added in v0.37.0 

func (r *TokenizationUpdateDigitalCardArtResponse) UnmarshalJSON(data []byte) (err error)

type Transaction 

type Transaction struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// The token for the account associated with this transaction.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Fee assessed by the merchant and paid for by the cardholder in the smallest unit
	// of the currency. Will be zero if no fee is assessed. Rebates may be transmitted
	// as a negative value to indicate credited fees.
	AcquirerFee int64 `json:"acquirer_fee,required,nullable"`
	// Unique identifier assigned to a transaction by the acquirer that can be used in
	// dispute and chargeback filing.
	AcquirerReferenceNumber string `json:"acquirer_reference_number,required,nullable"`
	// When the transaction is pending, this represents the authorization amount of the
	// transaction in the anticipated settlement currency. Once the transaction has
	// settled, this field represents the settled amount in the settlement currency.
	Amount  int64              `json:"amount,required"`
	Amounts TransactionAmounts `json:"amounts,required"`
	// The authorization amount of the transaction in the anticipated settlement
	// currency.
	AuthorizationAmount int64 `json:"authorization_amount,required,nullable"`
	// A fixed-width 6-digit numeric identifier that can be used to identify a
	// transaction with networks.
	AuthorizationCode string         `json:"authorization_code,required,nullable"`
	Avs               TransactionAvs `json:"avs,required,nullable"`
	// Token for the card used in this transaction.
	CardToken                string                              `json:"card_token,required" format:"uuid"`
	CardholderAuthentication TransactionCardholderAuthentication `json:"cardholder_authentication,required,nullable"`
	// Date and time when the transaction first occurred. UTC time zone.
	Created  time.Time           `json:"created,required" format:"date-time"`
	Merchant TransactionMerchant `json:"merchant,required"`
	// Analogous to the 'amount', but in the merchant currency.
	MerchantAmount int64 `json:"merchant_amount,required,nullable"`
	// Analogous to the 'authorization_amount', but in the merchant currency.
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,required,nullable"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the transaction.
	MerchantCurrency string `json:"merchant_currency,required"`
	// Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
	// `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the
	// network code from the upstream provider.
	Network TransactionNetwork `json:"network,required,nullable"`
	// Network-provided score assessing risk level associated with a given
	// authorization. Scores are on a range of 0-999, with 0 representing the lowest
	// risk and 999 representing the highest risk. For Visa transactions, where the raw
	// score has a range of 0-99, Lithic will normalize the score by multiplying the
	// raw score by 10x.
	NetworkRiskScore int64             `json:"network_risk_score,required,nullable"`
	Pos              TransactionPos    `json:"pos,required"`
	Result           TransactionResult `json:"result,required"`
	// The settled amount of the transaction in the settlement currency.
	SettledAmount int64 `json:"settled_amount,required"`
	// Status of the transaction.
	Status    TransactionStatus    `json:"status,required"`
	TokenInfo TransactionTokenInfo `json:"token_info,required,nullable"`
	// Date and time when the transaction last updated. UTC time zone.
	Updated time.Time          `json:"updated,required" format:"date-time"`
	Events  []TransactionEvent `json:"events"`
	JSON    transactionJSON    `json:"-"`
}

func (*Transaction) UnmarshalJSON 

func (r *Transaction) UnmarshalJSON(data []byte) (err error)

type TransactionAmounts added in v0.50.0 

type TransactionAmounts struct {
	Cardholder TransactionAmountsCardholder `json:"cardholder,required"`
	Hold       TransactionAmountsHold       `json:"hold,required"`
	Merchant   TransactionAmountsMerchant   `json:"merchant,required"`
	Settlement TransactionAmountsSettlement `json:"settlement,required"`
	JSON       transactionAmountsJSON       `json:"-"`
}

func (*TransactionAmounts) UnmarshalJSON added in v0.50.0 

func (r *TransactionAmounts) UnmarshalJSON(data []byte) (err error)

type TransactionAmountsCardholder added in v0.50.0 

type TransactionAmountsCardholder struct {
	// The aggregate settled amount in the cardholder billing currency.
	Amount int64 `json:"amount,required"`
	// The conversion rate used to convert the merchant amount to the cardholder
	// billing amount.
	ConversionRate string `json:"conversion_rate,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                  `json:"currency,required"`
	JSON     transactionAmountsCardholderJSON `json:"-"`
}

func (*TransactionAmountsCardholder) UnmarshalJSON added in v0.50.0 

func (r *TransactionAmountsCardholder) UnmarshalJSON(data []byte) (err error)

type TransactionAmountsHold added in v0.50.0 

type TransactionAmountsHold struct {
	// The aggregate authorization amount of the transaction in the anticipated
	// settlement currency.
	Amount int64 `json:"amount,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency            `json:"currency,required"`
	JSON     transactionAmountsHoldJSON `json:"-"`
}

func (*TransactionAmountsHold) UnmarshalJSON added in v0.50.0 

func (r *TransactionAmountsHold) UnmarshalJSON(data []byte) (err error)

type TransactionAmountsMerchant added in v0.50.0 

type TransactionAmountsMerchant struct {
	// The aggregate settled amount in the merchant currency.
	Amount int64 `json:"amount,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                `json:"currency,required"`
	JSON     transactionAmountsMerchantJSON `json:"-"`
}

func (*TransactionAmountsMerchant) UnmarshalJSON added in v0.50.0 

func (r *TransactionAmountsMerchant) UnmarshalJSON(data []byte) (err error)

type TransactionAmountsSettlement added in v0.50.0 

type TransactionAmountsSettlement struct {
	// The aggregate settled amount in the settlement currency.
	Amount int64 `json:"amount,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                  `json:"currency,required"`
	JSON     transactionAmountsSettlementJSON `json:"-"`
}

func (*TransactionAmountsSettlement) UnmarshalJSON added in v0.50.0 

func (r *TransactionAmountsSettlement) UnmarshalJSON(data []byte) (err error)

type TransactionAvs added in v0.25.0 

type TransactionAvs struct {
	// Cardholder address
	Address string `json:"address,required"`
	// Cardholder ZIP code
	Zipcode string             `json:"zipcode,required"`
	JSON    transactionAvsJSON `json:"-"`
}

func (*TransactionAvs) UnmarshalJSON added in v0.25.0 

func (r *TransactionAvs) UnmarshalJSON(data []byte) (err error)

type TransactionCardholderAuthentication 

type TransactionCardholderAuthentication struct {
	// The 3DS version used for the authentication
	ThreeDSVersion string `json:"3ds_version,required,nullable"`
	// Whether an acquirer exemption applied to the transaction.
	AcquirerExemption TransactionCardholderAuthenticationAcquirerExemption `json:"acquirer_exemption,required"`
	// Indicates what the outcome of the 3DS authentication process is.
	AuthenticationResult TransactionCardholderAuthenticationAuthenticationResult `json:"authentication_result,required"`
	// Indicates which party made the 3DS authentication decision.
	DecisionMadeBy TransactionCardholderAuthenticationDecisionMadeBy `json:"decision_made_by,required"`
	// Indicates whether chargeback liability shift applies to the transaction.
	// Possible enum values:
	//
	//   - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
	//
	//   - `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
	//
	//   - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
	//
	//   - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
	//     cryptography, possibly recurring. Chargeback liability shift to the issuer
	//     applies.
	LiabilityShift TransactionCardholderAuthenticationLiabilityShift `json:"liability_shift,required"`
	// Unique identifier you can use to match a given 3DS authentication (available via
	// the three_ds_authentication.created event webhook) and the transaction. Note
	// that in cases where liability shift does not occur, this token is matched to the
	// transaction on a best-effort basis.
	ThreeDSAuthenticationToken string `json:"three_ds_authentication_token,required,nullable" format:"uuid"`
	// Indicates whether a 3DS challenge flow was used, and if so, what the
	// verification method was. (deprecated, use `authentication_result`)
	VerificationAttempted TransactionCardholderAuthenticationVerificationAttempted `json:"verification_attempted,required"`
	// Indicates whether a transaction is considered 3DS authenticated. (deprecated,
	// use `authentication_result`)
	VerificationResult TransactionCardholderAuthenticationVerificationResult `json:"verification_result,required"`
	JSON               transactionCardholderAuthenticationJSON               `json:"-"`
}

func (*TransactionCardholderAuthentication) UnmarshalJSON 

func (r *TransactionCardholderAuthentication) UnmarshalJSON(data []byte) (err error)

type TransactionCardholderAuthenticationAcquirerExemption 

type TransactionCardholderAuthenticationAcquirerExemption string

Whether an acquirer exemption applied to the transaction. 

const (
	TransactionCardholderAuthenticationAcquirerExemptionAuthenticationOutageException          TransactionCardholderAuthenticationAcquirerExemption = "AUTHENTICATION_OUTAGE_EXCEPTION"
	TransactionCardholderAuthenticationAcquirerExemptionLowValue                               TransactionCardholderAuthenticationAcquirerExemption = "LOW_VALUE"
	TransactionCardholderAuthenticationAcquirerExemptionMerchantInitiatedTransaction           TransactionCardholderAuthenticationAcquirerExemption = "MERCHANT_INITIATED_TRANSACTION"
	TransactionCardholderAuthenticationAcquirerExemptionNone                                   TransactionCardholderAuthenticationAcquirerExemption = "NONE"
	TransactionCardholderAuthenticationAcquirerExemptionRecurringPayment                       TransactionCardholderAuthenticationAcquirerExemption = "RECURRING_PAYMENT"
	TransactionCardholderAuthenticationAcquirerExemptionSecureCorporatePayment                 TransactionCardholderAuthenticationAcquirerExemption = "SECURE_CORPORATE_PAYMENT"
	TransactionCardholderAuthenticationAcquirerExemptionStrongCustomerAuthenticationDelegation TransactionCardholderAuthenticationAcquirerExemption = "STRONG_CUSTOMER_AUTHENTICATION_DELEGATION"
	TransactionCardholderAuthenticationAcquirerExemptionTransactionRiskAnalysis                TransactionCardholderAuthenticationAcquirerExemption = "TRANSACTION_RISK_ANALYSIS"
)

func (TransactionCardholderAuthenticationAcquirerExemption) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationAcquirerExemption) IsKnown() bool

type TransactionCardholderAuthenticationAuthenticationResult added in v0.8.0 

type TransactionCardholderAuthenticationAuthenticationResult string

Indicates what the outcome of the 3DS authentication process is. 

const (
	TransactionCardholderAuthenticationAuthenticationResultAttempts TransactionCardholderAuthenticationAuthenticationResult = "ATTEMPTS"
	TransactionCardholderAuthenticationAuthenticationResultDecline  TransactionCardholderAuthenticationAuthenticationResult = "DECLINE"
	TransactionCardholderAuthenticationAuthenticationResultNone     TransactionCardholderAuthenticationAuthenticationResult = "NONE"
	TransactionCardholderAuthenticationAuthenticationResultSuccess  TransactionCardholderAuthenticationAuthenticationResult = "SUCCESS"
)

func (TransactionCardholderAuthenticationAuthenticationResult) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationAuthenticationResult) IsKnown() bool

type TransactionCardholderAuthenticationDecisionMadeBy added in v0.8.0 

type TransactionCardholderAuthenticationDecisionMadeBy string

Indicates which party made the 3DS authentication decision. 

const (
	TransactionCardholderAuthenticationDecisionMadeByCustomerEndpoint TransactionCardholderAuthenticationDecisionMadeBy = "CUSTOMER_ENDPOINT"
	TransactionCardholderAuthenticationDecisionMadeByLithicDefault    TransactionCardholderAuthenticationDecisionMadeBy = "LITHIC_DEFAULT"
	TransactionCardholderAuthenticationDecisionMadeByLithicRules      TransactionCardholderAuthenticationDecisionMadeBy = "LITHIC_RULES"
	TransactionCardholderAuthenticationDecisionMadeByNetwork          TransactionCardholderAuthenticationDecisionMadeBy = "NETWORK"
	TransactionCardholderAuthenticationDecisionMadeByUnknown          TransactionCardholderAuthenticationDecisionMadeBy = "UNKNOWN"
)

func (TransactionCardholderAuthenticationDecisionMadeBy) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationDecisionMadeBy) IsKnown() bool

type TransactionCardholderAuthenticationLiabilityShift 

type TransactionCardholderAuthenticationLiabilityShift string

Indicates whether chargeback liability shift applies to the transaction. Possible enum values:

  • `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.

  • `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.

  • `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.

  • `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated cryptography, possibly recurring. Chargeback liability shift to the issuer applies. 

const (
	TransactionCardholderAuthenticationLiabilityShift3DSAuthenticated   TransactionCardholderAuthenticationLiabilityShift = "3DS_AUTHENTICATED"
	TransactionCardholderAuthenticationLiabilityShiftAcquirerExemption  TransactionCardholderAuthenticationLiabilityShift = "ACQUIRER_EXEMPTION"
	TransactionCardholderAuthenticationLiabilityShiftNone               TransactionCardholderAuthenticationLiabilityShift = "NONE"
	TransactionCardholderAuthenticationLiabilityShiftTokenAuthenticated TransactionCardholderAuthenticationLiabilityShift = "TOKEN_AUTHENTICATED"
)

func (TransactionCardholderAuthenticationLiabilityShift) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationLiabilityShift) IsKnown() bool

type TransactionCardholderAuthenticationVerificationAttempted 

type TransactionCardholderAuthenticationVerificationAttempted string

Indicates whether a 3DS challenge flow was used, and if so, what the verification method was. (deprecated, use `authentication_result`) 

const (
	TransactionCardholderAuthenticationVerificationAttemptedNone  TransactionCardholderAuthenticationVerificationAttempted = "NONE"
	TransactionCardholderAuthenticationVerificationAttemptedOther TransactionCardholderAuthenticationVerificationAttempted = "OTHER"
)

func (TransactionCardholderAuthenticationVerificationAttempted) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationVerificationAttempted) IsKnown() bool

type TransactionCardholderAuthenticationVerificationResult 

type TransactionCardholderAuthenticationVerificationResult string

Indicates whether a transaction is considered 3DS authenticated. (deprecated, use `authentication_result`) 

const (
	TransactionCardholderAuthenticationVerificationResultCancelled    TransactionCardholderAuthenticationVerificationResult = "CANCELLED"
	TransactionCardholderAuthenticationVerificationResultFailed       TransactionCardholderAuthenticationVerificationResult = "FAILED"
	TransactionCardholderAuthenticationVerificationResultFrictionless TransactionCardholderAuthenticationVerificationResult = "FRICTIONLESS"
	TransactionCardholderAuthenticationVerificationResultNotAttempted TransactionCardholderAuthenticationVerificationResult = "NOT_ATTEMPTED"
	TransactionCardholderAuthenticationVerificationResultRejected     TransactionCardholderAuthenticationVerificationResult = "REJECTED"
	TransactionCardholderAuthenticationVerificationResultSuccess      TransactionCardholderAuthenticationVerificationResult = "SUCCESS"
)

func (TransactionCardholderAuthenticationVerificationResult) IsKnown added in v0.27.0 

func (r TransactionCardholderAuthenticationVerificationResult) IsKnown() bool

type TransactionEnhancedCommercialDataGetResponse added in v0.39.0 

type TransactionEnhancedCommercialDataGetResponse struct {
	Data []EnhancedData                                   `json:"data,required"`
	JSON transactionEnhancedCommercialDataGetResponseJSON `json:"-"`
}

func (*TransactionEnhancedCommercialDataGetResponse) UnmarshalJSON added in v0.39.0 

func (r *TransactionEnhancedCommercialDataGetResponse) UnmarshalJSON(data []byte) (err error)

type TransactionEnhancedCommercialDataService added in v0.39.0 

type TransactionEnhancedCommercialDataService struct {
	Options []option.RequestOption
}

TransactionEnhancedCommercialDataService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionEnhancedCommercialDataService method instead.

func NewTransactionEnhancedCommercialDataService added in v0.39.0 

func NewTransactionEnhancedCommercialDataService(opts ...option.RequestOption) (r *TransactionEnhancedCommercialDataService)

NewTransactionEnhancedCommercialDataService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TransactionEnhancedCommercialDataService) Get added in v0.39.0 

func (r *TransactionEnhancedCommercialDataService) Get(ctx context.Context, transactionToken string, opts ...option.RequestOption) (res *TransactionEnhancedCommercialDataGetResponse, err error)

Get all L2/L3 enhanced commercial data associated with a transaction.

type TransactionEvent added in v0.5.0 

type TransactionEvent struct {
	// Transaction event identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount of the event in the settlement currency.
	Amount  int64                    `json:"amount,required"`
	Amounts TransactionEventsAmounts `json:"amounts,required"`
	// RFC 3339 date and time this event entered the system. UTC time zone.
	Created         time.Time                         `json:"created,required" format:"date-time"`
	DetailedResults []TransactionEventsDetailedResult `json:"detailed_results,required"`
	// Indicates whether the transaction event is a credit or debit to the account.
	EffectivePolarity TransactionEventsEffectivePolarity `json:"effective_polarity,required"`
	Result            TransactionEventsResult            `json:"result,required"`
	// Type of transaction event
	Type TransactionEventsType `json:"type,required"`
	JSON transactionEventJSON  `json:"-"`
}

func (*TransactionEvent) UnmarshalJSON added in v0.5.0 

func (r *TransactionEvent) UnmarshalJSON(data []byte) (err error)

type TransactionEventEnhancedCommercialDataService added in v0.39.0 

type TransactionEventEnhancedCommercialDataService struct {
	Options []option.RequestOption
}

TransactionEventEnhancedCommercialDataService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionEventEnhancedCommercialDataService method instead.

func NewTransactionEventEnhancedCommercialDataService added in v0.39.0 

func NewTransactionEventEnhancedCommercialDataService(opts ...option.RequestOption) (r *TransactionEventEnhancedCommercialDataService)

NewTransactionEventEnhancedCommercialDataService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TransactionEventEnhancedCommercialDataService) Get added in v0.39.0 

func (r *TransactionEventEnhancedCommercialDataService) Get(ctx context.Context, eventToken string, opts ...option.RequestOption) (res *EnhancedData, err error)

Get L2/L3 enhanced commercial data associated with a transaction event.

type TransactionEventService added in v0.39.0 

type TransactionEventService struct {
	Options                []option.RequestOption
	EnhancedCommercialData *TransactionEventEnhancedCommercialDataService
}

TransactionEventService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionEventService method instead.

func NewTransactionEventService added in v0.39.0 

func NewTransactionEventService(opts ...option.RequestOption) (r *TransactionEventService)

NewTransactionEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type TransactionEventsAmounts added in v0.50.0 

type TransactionEventsAmounts struct {
	Cardholder TransactionEventsAmountsCardholder `json:"cardholder,required"`
	Merchant   TransactionEventsAmountsMerchant   `json:"merchant,required"`
	Settlement TransactionEventsAmountsSettlement `json:"settlement,required,nullable"`
	JSON       transactionEventsAmountsJSON       `json:"-"`
}

func (*TransactionEventsAmounts) UnmarshalJSON added in v0.50.0 

func (r *TransactionEventsAmounts) UnmarshalJSON(data []byte) (err error)

type TransactionEventsAmountsCardholder added in v0.50.0 

type TransactionEventsAmountsCardholder struct {
	// The amount in the cardholder billing currency.
	Amount int64 `json:"amount,required"`
	// The conversion rate used to convert the merchant amount to the cardholder
	// billing amount.
	ConversionRate string `json:"conversion_rate,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                        `json:"currency,required"`
	JSON     transactionEventsAmountsCardholderJSON `json:"-"`
}

func (*TransactionEventsAmountsCardholder) UnmarshalJSON added in v0.50.0 

func (r *TransactionEventsAmountsCardholder) UnmarshalJSON(data []byte) (err error)

type TransactionEventsAmountsMerchant added in v0.50.0 

type TransactionEventsAmountsMerchant struct {
	// The amount in the merchant currency.
	Amount int64 `json:"amount,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                      `json:"currency,required"`
	JSON     transactionEventsAmountsMerchantJSON `json:"-"`
}

func (*TransactionEventsAmountsMerchant) UnmarshalJSON added in v0.50.0 

func (r *TransactionEventsAmountsMerchant) UnmarshalJSON(data []byte) (err error)

type TransactionEventsAmountsSettlement added in v0.50.0 

type TransactionEventsAmountsSettlement struct {
	// Amount of the event, if it is financial, in the settlement currency.
	Amount int64 `json:"amount,required"`
	// Conversion rate used to convert the merchant amount to the settlement amount.
	ConversionRate string `json:"conversion_rate,required"`
	// ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some
	// special currencies like `XXX`. Enumerants names are lowercase currency code e.g.
	// `EUR`, `USD`.
	Currency shared.Currency                        `json:"currency,required"`
	JSON     transactionEventsAmountsSettlementJSON `json:"-"`
}

func (*TransactionEventsAmountsSettlement) UnmarshalJSON added in v0.50.0 

func (r *TransactionEventsAmountsSettlement) UnmarshalJSON(data []byte) (err error)

type TransactionEventsDetailedResult added in v0.19.0 

type TransactionEventsDetailedResult string
const (
	TransactionEventsDetailedResultAccountDailySpendLimitExceeded              TransactionEventsDetailedResult = "ACCOUNT_DAILY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountDelinquent                           TransactionEventsDetailedResult = "ACCOUNT_DELINQUENT"
	TransactionEventsDetailedResultAccountInactive                             TransactionEventsDetailedResult = "ACCOUNT_INACTIVE"
	TransactionEventsDetailedResultAccountLifetimeSpendLimitExceeded           TransactionEventsDetailedResult = "ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountMonthlySpendLimitExceeded            TransactionEventsDetailedResult = "ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountUnderReview                          TransactionEventsDetailedResult = "ACCOUNT_UNDER_REVIEW"
	TransactionEventsDetailedResultAddressIncorrect                            TransactionEventsDetailedResult = "ADDRESS_INCORRECT"
	TransactionEventsDetailedResultApproved                                    TransactionEventsDetailedResult = "APPROVED"
	TransactionEventsDetailedResultAuthRuleAllowedCountry                      TransactionEventsDetailedResult = "AUTH_RULE_ALLOWED_COUNTRY"
	TransactionEventsDetailedResultAuthRuleAllowedMcc                          TransactionEventsDetailedResult = "AUTH_RULE_ALLOWED_MCC"
	TransactionEventsDetailedResultAuthRuleBlockedCountry                      TransactionEventsDetailedResult = "AUTH_RULE_BLOCKED_COUNTRY"
	TransactionEventsDetailedResultAuthRuleBlockedMcc                          TransactionEventsDetailedResult = "AUTH_RULE_BLOCKED_MCC"
	TransactionEventsDetailedResultCardClosed                                  TransactionEventsDetailedResult = "CARD_CLOSED"
	TransactionEventsDetailedResultCardCryptogramValidationFailure             TransactionEventsDetailedResult = "CARD_CRYPTOGRAM_VALIDATION_FAILURE"
	TransactionEventsDetailedResultCardExpired                                 TransactionEventsDetailedResult = "CARD_EXPIRED"
	TransactionEventsDetailedResultCardExpiryDateIncorrect                     TransactionEventsDetailedResult = "CARD_EXPIRY_DATE_INCORRECT"
	TransactionEventsDetailedResultCardInvalid                                 TransactionEventsDetailedResult = "CARD_INVALID"
	TransactionEventsDetailedResultCardNotActivated                            TransactionEventsDetailedResult = "CARD_NOT_ACTIVATED"
	TransactionEventsDetailedResultCardPaused                                  TransactionEventsDetailedResult = "CARD_PAUSED"
	TransactionEventsDetailedResultCardPinIncorrect                            TransactionEventsDetailedResult = "CARD_PIN_INCORRECT"
	TransactionEventsDetailedResultCardRestricted                              TransactionEventsDetailedResult = "CARD_RESTRICTED"
	TransactionEventsDetailedResultCardSecurityCodeIncorrect                   TransactionEventsDetailedResult = "CARD_SECURITY_CODE_INCORRECT"
	TransactionEventsDetailedResultCardSpendLimitExceeded                      TransactionEventsDetailedResult = "CARD_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultContactCardIssuer                           TransactionEventsDetailedResult = "CONTACT_CARD_ISSUER"
	TransactionEventsDetailedResultCustomerAsaTimeout                          TransactionEventsDetailedResult = "CUSTOMER_ASA_TIMEOUT"
	TransactionEventsDetailedResultCustomAsaResult                             TransactionEventsDetailedResult = "CUSTOM_ASA_RESULT"
	TransactionEventsDetailedResultDeclined                                    TransactionEventsDetailedResult = "DECLINED"
	TransactionEventsDetailedResultDoNotHonor                                  TransactionEventsDetailedResult = "DO_NOT_HONOR"
	TransactionEventsDetailedResultDriverNumberInvalid                         TransactionEventsDetailedResult = "DRIVER_NUMBER_INVALID"
	TransactionEventsDetailedResultFormatError                                 TransactionEventsDetailedResult = "FORMAT_ERROR"
	TransactionEventsDetailedResultInsufficientFundingSourceBalance            TransactionEventsDetailedResult = "INSUFFICIENT_FUNDING_SOURCE_BALANCE"
	TransactionEventsDetailedResultInsufficientFunds                           TransactionEventsDetailedResult = "INSUFFICIENT_FUNDS"
	TransactionEventsDetailedResultLithicSystemError                           TransactionEventsDetailedResult = "LITHIC_SYSTEM_ERROR"
	TransactionEventsDetailedResultLithicSystemRateLimit                       TransactionEventsDetailedResult = "LITHIC_SYSTEM_RATE_LIMIT"
	TransactionEventsDetailedResultMalformedAsaResponse                        TransactionEventsDetailedResult = "MALFORMED_ASA_RESPONSE"
	TransactionEventsDetailedResultMerchantInvalid                             TransactionEventsDetailedResult = "MERCHANT_INVALID"
	TransactionEventsDetailedResultMerchantLockedCardAttemptedElsewhere        TransactionEventsDetailedResult = "MERCHANT_LOCKED_CARD_ATTEMPTED_ELSEWHERE"
	TransactionEventsDetailedResultMerchantNotPermitted                        TransactionEventsDetailedResult = "MERCHANT_NOT_PERMITTED"
	TransactionEventsDetailedResultOverReversalAttempted                       TransactionEventsDetailedResult = "OVER_REVERSAL_ATTEMPTED"
	TransactionEventsDetailedResultPinBlocked                                  TransactionEventsDetailedResult = "PIN_BLOCKED"
	TransactionEventsDetailedResultProgramCardSpendLimitExceeded               TransactionEventsDetailedResult = "PROGRAM_CARD_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultProgramSuspended                            TransactionEventsDetailedResult = "PROGRAM_SUSPENDED"
	TransactionEventsDetailedResultProgramUsageRestriction                     TransactionEventsDetailedResult = "PROGRAM_USAGE_RESTRICTION"
	TransactionEventsDetailedResultReversalUnmatched                           TransactionEventsDetailedResult = "REVERSAL_UNMATCHED"
	TransactionEventsDetailedResultSecurityViolation                           TransactionEventsDetailedResult = "SECURITY_VIOLATION"
	TransactionEventsDetailedResultSingleUseCardReattempted                    TransactionEventsDetailedResult = "SINGLE_USE_CARD_REATTEMPTED"
	TransactionEventsDetailedResultTransactionInvalid                          TransactionEventsDetailedResult = "TRANSACTION_INVALID"
	TransactionEventsDetailedResultTransactionNotPermittedToAcquirerOrTerminal TransactionEventsDetailedResult = "TRANSACTION_NOT_PERMITTED_TO_ACQUIRER_OR_TERMINAL"
	TransactionEventsDetailedResultTransactionNotPermittedToIssuerOrCardholder TransactionEventsDetailedResult = "TRANSACTION_NOT_PERMITTED_TO_ISSUER_OR_CARDHOLDER"
	TransactionEventsDetailedResultTransactionPreviouslyCompleted              TransactionEventsDetailedResult = "TRANSACTION_PREVIOUSLY_COMPLETED"
	TransactionEventsDetailedResultUnauthorizedMerchant                        TransactionEventsDetailedResult = "UNAUTHORIZED_MERCHANT"
	TransactionEventsDetailedResultVehicleNumberInvalid                        TransactionEventsDetailedResult = "VEHICLE_NUMBER_INVALID"
)

func (TransactionEventsDetailedResult) IsKnown added in v0.27.0 

func (r TransactionEventsDetailedResult) IsKnown() bool

type TransactionEventsEffectivePolarity added in v0.54.0 

type TransactionEventsEffectivePolarity string

Indicates whether the transaction event is a credit or debit to the account. 

const (
	TransactionEventsEffectivePolarityCredit TransactionEventsEffectivePolarity = "CREDIT"
	TransactionEventsEffectivePolarityDebit  TransactionEventsEffectivePolarity = "DEBIT"
)

func (TransactionEventsEffectivePolarity) IsKnown added in v0.54.0 

func (r TransactionEventsEffectivePolarity) IsKnown() bool

type TransactionEventsResult 

type TransactionEventsResult string
const (
	TransactionEventsResultAccountStateTransactionFail TransactionEventsResult = "ACCOUNT_STATE_TRANSACTION_FAIL"
	TransactionEventsResultApproved                    TransactionEventsResult = "APPROVED"
	TransactionEventsResultBankConnectionError         TransactionEventsResult = "BANK_CONNECTION_ERROR"
	TransactionEventsResultBankNotVerified             TransactionEventsResult = "BANK_NOT_VERIFIED"
	TransactionEventsResultCardClosed                  TransactionEventsResult = "CARD_CLOSED"
	TransactionEventsResultCardPaused                  TransactionEventsResult = "CARD_PAUSED"
	TransactionEventsResultDeclined                    TransactionEventsResult = "DECLINED"
	TransactionEventsResultFraudAdvice                 TransactionEventsResult = "FRAUD_ADVICE"
	TransactionEventsResultIgnoredTtlExpiry            TransactionEventsResult = "IGNORED_TTL_EXPIRY"
	TransactionEventsResultInactiveAccount             TransactionEventsResult = "INACTIVE_ACCOUNT"
	TransactionEventsResultIncorrectPin                TransactionEventsResult = "INCORRECT_PIN"
	TransactionEventsResultInvalidCardDetails          TransactionEventsResult = "INVALID_CARD_DETAILS"
	TransactionEventsResultInsufficientFunds           TransactionEventsResult = "INSUFFICIENT_FUNDS"
	TransactionEventsResultInsufficientFundsPreload    TransactionEventsResult = "INSUFFICIENT_FUNDS_PRELOAD"
	TransactionEventsResultInvalidTransaction          TransactionEventsResult = "INVALID_TRANSACTION"
	TransactionEventsResultMerchantBlacklist           TransactionEventsResult = "MERCHANT_BLACKLIST"
	TransactionEventsResultOriginalNotFound            TransactionEventsResult = "ORIGINAL_NOT_FOUND"
	TransactionEventsResultPreviouslyCompleted         TransactionEventsResult = "PREVIOUSLY_COMPLETED"
	TransactionEventsResultSingleUseRecharged          TransactionEventsResult = "SINGLE_USE_RECHARGED"
	TransactionEventsResultSwitchInoperativeAdvice     TransactionEventsResult = "SWITCH_INOPERATIVE_ADVICE"
	TransactionEventsResultUnauthorizedMerchant        TransactionEventsResult = "UNAUTHORIZED_MERCHANT"
	TransactionEventsResultUnknownHostTimeout          TransactionEventsResult = "UNKNOWN_HOST_TIMEOUT"
	TransactionEventsResultUserTransactionLimit        TransactionEventsResult = "USER_TRANSACTION_LIMIT"
)

func (TransactionEventsResult) IsKnown added in v0.27.0 

func (r TransactionEventsResult) IsKnown() bool

type TransactionEventsType 

type TransactionEventsType string

Type of transaction event 

const (
	TransactionEventsTypeAuthorization                TransactionEventsType = "AUTHORIZATION"
	TransactionEventsTypeAuthorizationAdvice          TransactionEventsType = "AUTHORIZATION_ADVICE"
	TransactionEventsTypeAuthorizationExpiry          TransactionEventsType = "AUTHORIZATION_EXPIRY"
	TransactionEventsTypeAuthorizationReversal        TransactionEventsType = "AUTHORIZATION_REVERSAL"
	TransactionEventsTypeBalanceInquiry               TransactionEventsType = "BALANCE_INQUIRY"
	TransactionEventsTypeClearing                     TransactionEventsType = "CLEARING"
	TransactionEventsTypeCorrectionCredit             TransactionEventsType = "CORRECTION_CREDIT"
	TransactionEventsTypeCorrectionDebit              TransactionEventsType = "CORRECTION_DEBIT"
	TransactionEventsTypeCreditAuthorization          TransactionEventsType = "CREDIT_AUTHORIZATION"
	TransactionEventsTypeCreditAuthorizationAdvice    TransactionEventsType = "CREDIT_AUTHORIZATION_ADVICE"
	TransactionEventsTypeFinancialAuthorization       TransactionEventsType = "FINANCIAL_AUTHORIZATION"
	TransactionEventsTypeFinancialCreditAuthorization TransactionEventsType = "FINANCIAL_CREDIT_AUTHORIZATION"
	TransactionEventsTypeReturn                       TransactionEventsType = "RETURN"
	TransactionEventsTypeReturnReversal               TransactionEventsType = "RETURN_REVERSAL"
)

func (TransactionEventsType) IsKnown added in v0.27.0 

func (r TransactionEventsType) IsKnown() bool

type TransactionListParams 

type TransactionListParams struct {
	// Filters for transactions associated with a specific account.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Filters for transactions associated with a specific card.
	CardToken param.Field[string] `query:"card_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// Filters for transactions using transaction result field. Can filter by
	// `APPROVED`, and `DECLINED`.
	Result param.Field[TransactionListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (TransactionListParams) URLQuery 

func (r TransactionListParams) URLQuery() (v url.Values)

URLQuery serializes TransactionListParams's query parameters as `url.Values`.

type TransactionListParamsResult 

type TransactionListParamsResult string

Filters for transactions using transaction result field. Can filter by `APPROVED`, and `DECLINED`. 

const (
	TransactionListParamsResultApproved TransactionListParamsResult = "APPROVED"
	TransactionListParamsResultDeclined TransactionListParamsResult = "DECLINED"
)

func (TransactionListParamsResult) IsKnown added in v0.27.0 

func (r TransactionListParamsResult) IsKnown() bool

type TransactionMerchant 

type TransactionMerchant struct {
	// Unique alphanumeric identifier for the payment card acceptor (merchant).
	AcceptorID string `json:"acceptor_id,required"`
	// Unique numeric identifier of the acquiring institution.
	AcquiringInstitutionID string `json:"acquiring_institution_id,required"`
	// City of card acceptor. Note that in many cases, particularly in card-not-present
	// transactions, merchants may send through a phone number or URL in this field.
	City string `json:"city,required"`
	// Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
	// alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
	Country string `json:"country,required"`
	// Short description of card acceptor.
	Descriptor string `json:"descriptor,required"`
	// Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
	// used to classify a business by the types of goods or services it provides.
	Mcc string `json:"mcc,required"`
	// Geographic state of card acceptor.
	State string                  `json:"state,required"`
	JSON  transactionMerchantJSON `json:"-"`
}

func (*TransactionMerchant) UnmarshalJSON 

func (r *TransactionMerchant) UnmarshalJSON(data []byte) (err error)

type TransactionNetwork 

type TransactionNetwork string

Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`, `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider. 

const (
	TransactionNetworkInterlink  TransactionNetwork = "INTERLINK"
	TransactionNetworkMaestro    TransactionNetwork = "MAESTRO"
	TransactionNetworkMastercard TransactionNetwork = "MASTERCARD"
	TransactionNetworkUnknown    TransactionNetwork = "UNKNOWN"
	TransactionNetworkVisa       TransactionNetwork = "VISA"
)

func (TransactionNetwork) IsKnown added in v0.27.0 

func (r TransactionNetwork) IsKnown() bool

type TransactionPos added in v0.25.0 

type TransactionPos struct {
	EntryMode TransactionPosEntryMode `json:"entry_mode,required"`
	Terminal  TransactionPosTerminal  `json:"terminal,required"`
	JSON      transactionPosJSON      `json:"-"`
}

func (*TransactionPos) UnmarshalJSON added in v0.25.0 

func (r *TransactionPos) UnmarshalJSON(data []byte) (err error)

type TransactionPosEntryMode added in v0.25.0 

type TransactionPosEntryMode struct {
	// Card presence indicator
	Card TransactionPosEntryModeCard `json:"card,required"`
	// Cardholder presence indicator
	Cardholder TransactionPosEntryModeCardholder `json:"cardholder,required"`
	// Method of entry for the PAN
	Pan TransactionPosEntryModePan `json:"pan,required"`
	// Indicates whether the cardholder entered the PIN. True if the PIN was entered.
	PinEntered bool                        `json:"pin_entered,required"`
	JSON       transactionPosEntryModeJSON `json:"-"`
}

func (*TransactionPosEntryMode) UnmarshalJSON added in v0.25.0 

func (r *TransactionPosEntryMode) UnmarshalJSON(data []byte) (err error)

type TransactionPosEntryModeCard added in v0.25.0 

type TransactionPosEntryModeCard string

Card presence indicator 

const (
	TransactionPosEntryModeCardNotPresent    TransactionPosEntryModeCard = "NOT_PRESENT"
	TransactionPosEntryModeCardPreauthorized TransactionPosEntryModeCard = "PREAUTHORIZED"
	TransactionPosEntryModeCardPresent       TransactionPosEntryModeCard = "PRESENT"
	TransactionPosEntryModeCardUnknown       TransactionPosEntryModeCard = "UNKNOWN"
)

func (TransactionPosEntryModeCard) IsKnown added in v0.27.0 

func (r TransactionPosEntryModeCard) IsKnown() bool

type TransactionPosEntryModeCardholder added in v0.25.0 

type TransactionPosEntryModeCardholder string

Cardholder presence indicator 

const (
	TransactionPosEntryModeCardholderDeferredBilling TransactionPosEntryModeCardholder = "DEFERRED_BILLING"
	TransactionPosEntryModeCardholderElectronicOrder TransactionPosEntryModeCardholder = "ELECTRONIC_ORDER"
	TransactionPosEntryModeCardholderInstallment     TransactionPosEntryModeCardholder = "INSTALLMENT"
	TransactionPosEntryModeCardholderMailOrder       TransactionPosEntryModeCardholder = "MAIL_ORDER"
	TransactionPosEntryModeCardholderNotPresent      TransactionPosEntryModeCardholder = "NOT_PRESENT"
	TransactionPosEntryModeCardholderPreauthorized   TransactionPosEntryModeCardholder = "PREAUTHORIZED"
	TransactionPosEntryModeCardholderPresent         TransactionPosEntryModeCardholder = "PRESENT"
	TransactionPosEntryModeCardholderReoccurring     TransactionPosEntryModeCardholder = "REOCCURRING"
	TransactionPosEntryModeCardholderTelephoneOrder  TransactionPosEntryModeCardholder = "TELEPHONE_ORDER"
	TransactionPosEntryModeCardholderUnknown         TransactionPosEntryModeCardholder = "UNKNOWN"
)

func (TransactionPosEntryModeCardholder) IsKnown added in v0.27.0 

func (r TransactionPosEntryModeCardholder) IsKnown() bool

type TransactionPosEntryModePan added in v0.25.0 

type TransactionPosEntryModePan string

Method of entry for the PAN 

const (
	TransactionPosEntryModePanAutoEntry           TransactionPosEntryModePan = "AUTO_ENTRY"
	TransactionPosEntryModePanBarCode             TransactionPosEntryModePan = "BAR_CODE"
	TransactionPosEntryModePanContactless         TransactionPosEntryModePan = "CONTACTLESS"
	TransactionPosEntryModePanCredentialOnFile    TransactionPosEntryModePan = "CREDENTIAL_ON_FILE"
	TransactionPosEntryModePanEcommerce           TransactionPosEntryModePan = "ECOMMERCE"
	TransactionPosEntryModePanErrorKeyed          TransactionPosEntryModePan = "ERROR_KEYED"
	TransactionPosEntryModePanErrorMagneticStripe TransactionPosEntryModePan = "ERROR_MAGNETIC_STRIPE"
	TransactionPosEntryModePanIcc                 TransactionPosEntryModePan = "ICC"
	TransactionPosEntryModePanKeyEntered          TransactionPosEntryModePan = "KEY_ENTERED"
	TransactionPosEntryModePanMagneticStripe      TransactionPosEntryModePan = "MAGNETIC_STRIPE"
	TransactionPosEntryModePanManual              TransactionPosEntryModePan = "MANUAL"
	TransactionPosEntryModePanOcr                 TransactionPosEntryModePan = "OCR"
	TransactionPosEntryModePanSecureCardless      TransactionPosEntryModePan = "SECURE_CARDLESS"
	TransactionPosEntryModePanUnknown             TransactionPosEntryModePan = "UNKNOWN"
	TransactionPosEntryModePanUnspecified         TransactionPosEntryModePan = "UNSPECIFIED"
)

func (TransactionPosEntryModePan) IsKnown added in v0.27.0 

func (r TransactionPosEntryModePan) IsKnown() bool

type TransactionPosTerminal added in v0.25.0 

type TransactionPosTerminal struct {
	// True if a clerk is present at the sale.
	Attended bool `json:"attended,required"`
	// True if the terminal is capable of retaining the card.
	CardRetentionCapable bool `json:"card_retention_capable,required"`
	// True if the sale was made at the place of business (vs. mobile).
	OnPremise bool `json:"on_premise,required"`
	// The person that is designated to swipe the card
	Operator TransactionPosTerminalOperator `json:"operator,required"`
	// True if the terminal is capable of partial approval. Partial approval is when
	// part of a transaction is approved and another payment must be used for the
	// remainder. Example scenario: A $40 transaction is attempted on a prepaid card
	// with a $25 balance. If partial approval is enabled, $25 can be authorized, at
	// which point the POS will prompt the user for an additional payment of $15.
	PartialApprovalCapable bool `json:"partial_approval_capable,required"`
	// Status of whether the POS is able to accept PINs
	PinCapability TransactionPosTerminalPinCapability `json:"pin_capability,required"`
	// POS Type
	Type TransactionPosTerminalType `json:"type,required"`
	JSON transactionPosTerminalJSON `json:"-"`
}

func (*TransactionPosTerminal) UnmarshalJSON added in v0.25.0 

func (r *TransactionPosTerminal) UnmarshalJSON(data []byte) (err error)

type TransactionPosTerminalOperator added in v0.25.0 

type TransactionPosTerminalOperator string

The person that is designated to swipe the card 

const (
	TransactionPosTerminalOperatorAdministrative TransactionPosTerminalOperator = "ADMINISTRATIVE"
	TransactionPosTerminalOperatorCardholder     TransactionPosTerminalOperator = "CARDHOLDER"
	TransactionPosTerminalOperatorCardAcceptor   TransactionPosTerminalOperator = "CARD_ACCEPTOR"
	TransactionPosTerminalOperatorUnknown        TransactionPosTerminalOperator = "UNKNOWN"
)

func (TransactionPosTerminalOperator) IsKnown added in v0.27.0 

func (r TransactionPosTerminalOperator) IsKnown() bool

type TransactionPosTerminalPinCapability added in v0.25.0 

type TransactionPosTerminalPinCapability string

Status of whether the POS is able to accept PINs 

const (
	TransactionPosTerminalPinCapabilityCapable     TransactionPosTerminalPinCapability = "CAPABLE"
	TransactionPosTerminalPinCapabilityInoperative TransactionPosTerminalPinCapability = "INOPERATIVE"
	TransactionPosTerminalPinCapabilityNotCapable  TransactionPosTerminalPinCapability = "NOT_CAPABLE"
	TransactionPosTerminalPinCapabilityUnspecified TransactionPosTerminalPinCapability = "UNSPECIFIED"
)

func (TransactionPosTerminalPinCapability) IsKnown added in v0.27.0 

func (r TransactionPosTerminalPinCapability) IsKnown() bool

type TransactionPosTerminalType added in v0.25.0 

type TransactionPosTerminalType string

POS Type 

const (
	TransactionPosTerminalTypeAdministrative        TransactionPosTerminalType = "ADMINISTRATIVE"
	TransactionPosTerminalTypeAtm                   TransactionPosTerminalType = "ATM"
	TransactionPosTerminalTypeAuthorization         TransactionPosTerminalType = "AUTHORIZATION"
	TransactionPosTerminalTypeCouponMachine         TransactionPosTerminalType = "COUPON_MACHINE"
	TransactionPosTerminalTypeDialTerminal          TransactionPosTerminalType = "DIAL_TERMINAL"
	TransactionPosTerminalTypeEcommerce             TransactionPosTerminalType = "ECOMMERCE"
	TransactionPosTerminalTypeEcr                   TransactionPosTerminalType = "ECR"
	TransactionPosTerminalTypeFuelMachine           TransactionPosTerminalType = "FUEL_MACHINE"
	TransactionPosTerminalTypeHomeTerminal          TransactionPosTerminalType = "HOME_TERMINAL"
	TransactionPosTerminalTypeMicr                  TransactionPosTerminalType = "MICR"
	TransactionPosTerminalTypeOffPremise            TransactionPosTerminalType = "OFF_PREMISE"
	TransactionPosTerminalTypePayment               TransactionPosTerminalType = "PAYMENT"
	TransactionPosTerminalTypePda                   TransactionPosTerminalType = "PDA"
	TransactionPosTerminalTypePhone                 TransactionPosTerminalType = "PHONE"
	TransactionPosTerminalTypePoint                 TransactionPosTerminalType = "POINT"
	TransactionPosTerminalTypePosTerminal           TransactionPosTerminalType = "POS_TERMINAL"
	TransactionPosTerminalTypePublicUtility         TransactionPosTerminalType = "PUBLIC_UTILITY"
	TransactionPosTerminalTypeSelfService           TransactionPosTerminalType = "SELF_SERVICE"
	TransactionPosTerminalTypeTelevision            TransactionPosTerminalType = "TELEVISION"
	TransactionPosTerminalTypeTeller                TransactionPosTerminalType = "TELLER"
	TransactionPosTerminalTypeTravelersCheckMachine TransactionPosTerminalType = "TRAVELERS_CHECK_MACHINE"
	TransactionPosTerminalTypeVending               TransactionPosTerminalType = "VENDING"
	TransactionPosTerminalTypeVoice                 TransactionPosTerminalType = "VOICE"
	TransactionPosTerminalTypeUnknown               TransactionPosTerminalType = "UNKNOWN"
)

func (TransactionPosTerminalType) IsKnown added in v0.27.0 

func (r TransactionPosTerminalType) IsKnown() bool

type TransactionResult 

type TransactionResult string
const (
	TransactionResultAccountStateTransactionFail TransactionResult = "ACCOUNT_STATE_TRANSACTION_FAIL"
	TransactionResultApproved                    TransactionResult = "APPROVED"
	TransactionResultBankConnectionError         TransactionResult = "BANK_CONNECTION_ERROR"
	TransactionResultBankNotVerified             TransactionResult = "BANK_NOT_VERIFIED"
	TransactionResultCardClosed                  TransactionResult = "CARD_CLOSED"
	TransactionResultCardPaused                  TransactionResult = "CARD_PAUSED"
	TransactionResultDeclined                    TransactionResult = "DECLINED"
	TransactionResultFraudAdvice                 TransactionResult = "FRAUD_ADVICE"
	TransactionResultIgnoredTtlExpiry            TransactionResult = "IGNORED_TTL_EXPIRY"
	TransactionResultInactiveAccount             TransactionResult = "INACTIVE_ACCOUNT"
	TransactionResultIncorrectPin                TransactionResult = "INCORRECT_PIN"
	TransactionResultInvalidCardDetails          TransactionResult = "INVALID_CARD_DETAILS"
	TransactionResultInsufficientFunds           TransactionResult = "INSUFFICIENT_FUNDS"
	TransactionResultInsufficientFundsPreload    TransactionResult = "INSUFFICIENT_FUNDS_PRELOAD"
	TransactionResultInvalidTransaction          TransactionResult = "INVALID_TRANSACTION"
	TransactionResultMerchantBlacklist           TransactionResult = "MERCHANT_BLACKLIST"
	TransactionResultOriginalNotFound            TransactionResult = "ORIGINAL_NOT_FOUND"
	TransactionResultPreviouslyCompleted         TransactionResult = "PREVIOUSLY_COMPLETED"
	TransactionResultSingleUseRecharged          TransactionResult = "SINGLE_USE_RECHARGED"
	TransactionResultSwitchInoperativeAdvice     TransactionResult = "SWITCH_INOPERATIVE_ADVICE"
	TransactionResultUnauthorizedMerchant        TransactionResult = "UNAUTHORIZED_MERCHANT"
	TransactionResultUnknownHostTimeout          TransactionResult = "UNKNOWN_HOST_TIMEOUT"
	TransactionResultUserTransactionLimit        TransactionResult = "USER_TRANSACTION_LIMIT"
)

func (TransactionResult) IsKnown added in v0.27.0 

func (r TransactionResult) IsKnown() bool

type TransactionService 

type TransactionService struct {
	Options                []option.RequestOption
	EnhancedCommercialData *TransactionEnhancedCommercialDataService
	Events                 *TransactionEventService
}

TransactionService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionService method instead.

func NewTransactionService 

func NewTransactionService(opts ...option.RequestOption) (r *TransactionService)

NewTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TransactionService) Get 

func (r *TransactionService) Get(ctx context.Context, transactionToken string, opts ...option.RequestOption) (res *Transaction, err error)

Get a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD).

func (*TransactionService) List 

func (r *TransactionService) List(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) (res *pagination.CursorPage[Transaction], err error)

List card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees.

func (*TransactionService) ListAutoPaging 

func (r *TransactionService) ListAutoPaging(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[Transaction]

List card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees.

func (*TransactionService) SimulateAuthorization 

func (r *TransactionService) SimulateAuthorization(ctx context.Context, body TransactionSimulateAuthorizationParams, opts ...option.RequestOption) (res *TransactionSimulateAuthorizationResponse, err error)

Simulates an authorization request from the payment network as if it came from a merchant acquirer. If you're configured for ASA, simulating auths requires your ASA client to be set up properly (respond with a valid JSON to the ASA request). For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. This limit can be modified via the [update account](https://docs.lithic.com/reference/patchaccountbytoken) endpoint.

func (*TransactionService) SimulateAuthorizationAdvice 

func (r *TransactionService) SimulateAuthorizationAdvice(ctx context.Context, body TransactionSimulateAuthorizationAdviceParams, opts ...option.RequestOption) (res *TransactionSimulateAuthorizationAdviceResponse, err error)

Simulates an authorization advice request from the payment network as if it came from a merchant acquirer. An authorization advice request changes the amount of the transaction.

func (*TransactionService) SimulateClearing 

func (r *TransactionService) SimulateClearing(ctx context.Context, body TransactionSimulateClearingParams, opts ...option.RequestOption) (res *TransactionSimulateClearingResponse, err error)

Clears an existing authorization. After this event, the transaction is no longer pending.

If no `amount` is supplied to this endpoint, the amount of the transaction will be captured. Any transaction that has any amount completed at all do not have access to this behavior.

func (*TransactionService) SimulateCreditAuthorization 

func (r *TransactionService) SimulateCreditAuthorization(ctx context.Context, body TransactionSimulateCreditAuthorizationParams, opts ...option.RequestOption) (res *TransactionSimulateCreditAuthorizationResponse, err error)

Simulates a credit authorization advice message from the payment network. This message indicates that a credit authorization was approved on your behalf by the network.

func (*TransactionService) SimulateReturn 

func (r *TransactionService) SimulateReturn(ctx context.Context, body TransactionSimulateReturnParams, opts ...option.RequestOption) (res *TransactionSimulateReturnResponse, err error)

Returns (aka refunds) an amount back to a card. Returns are cleared immediately and do not spend time in a `PENDING` state.

func (*TransactionService) SimulateReturnReversal 

func (r *TransactionService) SimulateReturnReversal(ctx context.Context, body TransactionSimulateReturnReversalParams, opts ...option.RequestOption) (res *TransactionSimulateReturnReversalResponse, err error)

Voids a settled credit transaction – i.e., a transaction with a negative amount and `SETTLED` status. These can be credit authorizations that have already cleared or financial credit authorizations.

func (*TransactionService) SimulateVoid 

func (r *TransactionService) SimulateVoid(ctx context.Context, body TransactionSimulateVoidParams, opts ...option.RequestOption) (res *TransactionSimulateVoidResponse, err error)

Voids an existing, uncleared (aka pending) authorization. If amount is not sent the full amount will be voided. Cannot be used on partially completed transactions, but can be used on partially voided transactions. _Note that simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon._

type TransactionSimulateAuthorizationAdviceParams 

type TransactionSimulateAuthorizationAdviceParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to authorize. This amount will override the transaction's
	// amount that was originally set by /v1/simulate/authorize.
	Amount param.Field[int64] `json:"amount,required"`
}

func (TransactionSimulateAuthorizationAdviceParams) MarshalJSON 

func (r TransactionSimulateAuthorizationAdviceParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateAuthorizationAdviceResponse 

type TransactionSimulateAuthorizationAdviceResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                             `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateAuthorizationAdviceResponseJSON `json:"-"`
}

func (*TransactionSimulateAuthorizationAdviceResponse) UnmarshalJSON 

func (r *TransactionSimulateAuthorizationAdviceResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateAuthorizationParams 

type TransactionSimulateAuthorizationParams struct {
	// Amount (in cents) to authorize. For credit authorizations and financial credit
	// authorizations, any value entered will be converted into a negative amount in
	// the simulated transaction. For example, entering 100 in this field will appear
	// as a -100 amount in the transaction. For balance inquiries, this field must be
	// set to 0.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc"`
	// Unique identifier to identify the payment card acceptor.
	MerchantAcceptorID param.Field[string] `json:"merchant_acceptor_id"`
	// Amount of the transaction to be simulated in currency specified in
	// merchant_currency, including any acquirer fees.
	MerchantAmount param.Field[int64] `json:"merchant_amount"`
	// 3-digit alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
	// GBP, EUR and defaults to GBP if another ISO 4217 code is provided
	MerchantCurrency param.Field[string] `json:"merchant_currency"`
	// Set to true if the terminal is capable of partial approval otherwise false.
	// Partial approval is when part of a transaction is approved and another payment
	// must be used for the remainder.
	PartialApprovalCapable param.Field[bool] `json:"partial_approval_capable"`
	// Type of event to simulate.
	//
	//   - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
	//     clearing step is required to settle the transaction.
	//   - `BALANCE_INQUIRY` is a $0 authorization that includes a request for the
	//     balance held on the card, and is most typically seen when a cardholder
	//     requests to view a card's balance at an ATM.
	//   - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
	//     a refund or credit, meaning a subsequent clearing step is required to settle
	//     the transaction.
	//   - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
	//     funds immediately (such as an ATM withdrawal), and no subsequent clearing is
	//     required to settle the transaction.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
	//     to credit funds immediately, and no subsequent clearing is required to settle
	//     the transaction.
	Status param.Field[TransactionSimulateAuthorizationParamsStatus] `json:"status"`
}

func (TransactionSimulateAuthorizationParams) MarshalJSON 

func (r TransactionSimulateAuthorizationParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateAuthorizationParamsStatus 

type TransactionSimulateAuthorizationParamsStatus string

Type of event to simulate.

  • `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent clearing step is required to settle the transaction.
  • `BALANCE_INQUIRY` is a $0 authorization that includes a request for the balance held on the card, and is most typically seen when a cardholder requests to view a card's balance at an ATM.
  • `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize a refund or credit, meaning a subsequent clearing step is required to settle the transaction.
  • `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit funds immediately (such as an ATM withdrawal), and no subsequent clearing is required to settle the transaction.
  • `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant to credit funds immediately, and no subsequent clearing is required to settle the transaction.
const (
	TransactionSimulateAuthorizationParamsStatusAuthorization                TransactionSimulateAuthorizationParamsStatus = "AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusBalanceInquiry               TransactionSimulateAuthorizationParamsStatus = "BALANCE_INQUIRY"
	TransactionSimulateAuthorizationParamsStatusCreditAuthorization          TransactionSimulateAuthorizationParamsStatus = "CREDIT_AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusFinancialAuthorization       TransactionSimulateAuthorizationParamsStatus = "FINANCIAL_AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusFinancialCreditAuthorization TransactionSimulateAuthorizationParamsStatus = "FINANCIAL_CREDIT_AUTHORIZATION"
)

func (TransactionSimulateAuthorizationParamsStatus) IsKnown added in v0.27.0 

func (r TransactionSimulateAuthorizationParamsStatus) IsKnown() bool

type TransactionSimulateAuthorizationResponse 

type TransactionSimulateAuthorizationResponse struct {
	// A unique token to reference this transaction with later calls to void or clear
	// the authorization.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                       `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateAuthorizationResponseJSON `json:"-"`
}

func (*TransactionSimulateAuthorizationResponse) UnmarshalJSON 

func (r *TransactionSimulateAuthorizationResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateClearingParams 

type TransactionSimulateClearingParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to complete. Typically this will match the original
	// authorization, but may be more or less.
	//
	// If no amount is supplied to this endpoint, the amount of the transaction will be
	// captured. Any transaction that has any amount completed at all do not have
	// access to this behavior.
	Amount param.Field[int64] `json:"amount"`
}

func (TransactionSimulateClearingParams) MarshalJSON 

func (r TransactionSimulateClearingParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateClearingResponse 

type TransactionSimulateClearingResponse struct {
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                  `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateClearingResponseJSON `json:"-"`
}

func (*TransactionSimulateClearingResponse) UnmarshalJSON 

func (r *TransactionSimulateClearingResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateCreditAuthorizationParams 

type TransactionSimulateCreditAuthorizationParams struct {
	// Amount (in cents). Any value entered will be converted into a negative amount in
	// the simulated transaction. For example, entering 100 in this field will appear
	// as a -100 amount in the transaction.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc"`
	// Unique identifier to identify the payment card acceptor.
	MerchantAcceptorID param.Field[string] `json:"merchant_acceptor_id"`
}

func (TransactionSimulateCreditAuthorizationParams) MarshalJSON 

func (r TransactionSimulateCreditAuthorizationParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateCreditAuthorizationResponse 

type TransactionSimulateCreditAuthorizationResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                             `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateCreditAuthorizationResponseJSON `json:"-"`
}

func (*TransactionSimulateCreditAuthorizationResponse) UnmarshalJSON 

func (r *TransactionSimulateCreditAuthorizationResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateReturnParams 

type TransactionSimulateReturnParams struct {
	// Amount (in cents) to authorize.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
}

func (TransactionSimulateReturnParams) MarshalJSON 

func (r TransactionSimulateReturnParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateReturnResponse 

type TransactionSimulateReturnResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateReturnResponseJSON `json:"-"`
}

func (*TransactionSimulateReturnResponse) UnmarshalJSON 

func (r *TransactionSimulateReturnResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateReturnReversalParams 

type TransactionSimulateReturnReversalParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
}

func (TransactionSimulateReturnReversalParams) MarshalJSON 

func (r TransactionSimulateReturnReversalParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateReturnReversalResponse 

type TransactionSimulateReturnReversalResponse struct {
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                        `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateReturnReversalResponseJSON `json:"-"`
}

func (*TransactionSimulateReturnReversalResponse) UnmarshalJSON 

func (r *TransactionSimulateReturnReversalResponse) UnmarshalJSON(data []byte) (err error)

type TransactionSimulateVoidParams 

type TransactionSimulateVoidParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to void. Typically this will match the original authorization,
	// but may be less.
	Amount param.Field[int64] `json:"amount"`
	// Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
	//
	//   - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
	//     by Lithic.
	//   - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
	Type param.Field[TransactionSimulateVoidParamsType] `json:"type"`
}

func (TransactionSimulateVoidParams) MarshalJSON 

func (r TransactionSimulateVoidParams) MarshalJSON() (data []byte, err error)

type TransactionSimulateVoidParamsType 

type TransactionSimulateVoidParamsType string

Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.

  • `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
const (
	TransactionSimulateVoidParamsTypeAuthorizationExpiry   TransactionSimulateVoidParamsType = "AUTHORIZATION_EXPIRY"
	TransactionSimulateVoidParamsTypeAuthorizationReversal TransactionSimulateVoidParamsType = "AUTHORIZATION_REVERSAL"
)

func (TransactionSimulateVoidParamsType) IsKnown added in v0.27.0 

func (r TransactionSimulateVoidParamsType) IsKnown() bool

type TransactionSimulateVoidResponse 

type TransactionSimulateVoidResponse struct {
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                              `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateVoidResponseJSON `json:"-"`
}

func (*TransactionSimulateVoidResponse) UnmarshalJSON 

func (r *TransactionSimulateVoidResponse) UnmarshalJSON(data []byte) (err error)

type TransactionStatus 

type TransactionStatus string

Status of the transaction. 

const (
	TransactionStatusDeclined TransactionStatus = "DECLINED"
	TransactionStatusExpired  TransactionStatus = "EXPIRED"
	TransactionStatusPending  TransactionStatus = "PENDING"
	TransactionStatusSettled  TransactionStatus = "SETTLED"
	TransactionStatusVoided   TransactionStatus = "VOIDED"
)

func (TransactionStatus) IsKnown added in v0.27.0 

func (r TransactionStatus) IsKnown() bool

type TransactionTokenInfo added in v0.25.0 

type TransactionTokenInfo struct {
	// The wallet_type field will indicate the source of the token. Possible token
	// sources include digital wallets (Apple, Google, or Samsung Pay), merchant
	// tokenization, and “other” sources like in-flight commerce. Masterpass is not
	// currently supported and is included for future use.
	WalletType TransactionTokenInfoWalletType `json:"wallet_type,required"`
	JSON       transactionTokenInfoJSON       `json:"-"`
}

func (*TransactionTokenInfo) UnmarshalJSON added in v0.25.0 

func (r *TransactionTokenInfo) UnmarshalJSON(data []byte) (err error)

type TransactionTokenInfoWalletType added in v0.25.0 

type TransactionTokenInfoWalletType string

The wallet_type field will indicate the source of the token. Possible token sources include digital wallets (Apple, Google, or Samsung Pay), merchant tokenization, and “other” sources like in-flight commerce. Masterpass is not currently supported and is included for future use. 

const (
	TransactionTokenInfoWalletTypeApplePay   TransactionTokenInfoWalletType = "APPLE_PAY"
	TransactionTokenInfoWalletTypeGooglePay  TransactionTokenInfoWalletType = "GOOGLE_PAY"
	TransactionTokenInfoWalletTypeMasterpass TransactionTokenInfoWalletType = "MASTERPASS"
	TransactionTokenInfoWalletTypeMerchant   TransactionTokenInfoWalletType = "MERCHANT"
	TransactionTokenInfoWalletTypeOther      TransactionTokenInfoWalletType = "OTHER"
	TransactionTokenInfoWalletTypeSamsungPay TransactionTokenInfoWalletType = "SAMSUNG_PAY"
)

func (TransactionTokenInfoWalletType) IsKnown added in v0.27.0 

func (r TransactionTokenInfoWalletType) IsKnown() bool

type Transfer 

type Transfer struct {
	// Globally unique identifier for the transfer event.
	Token string `json:"token" format:"uuid"`
	// Status types:
	//
	//   - `TRANSFER` - Internal transfer of funds between financial accounts in your
	//     program.
	Category TransferCategory `json:"category"`
	// Date and time when the transfer occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction.
	Currency string `json:"currency"`
	// A string that provides a description of the transfer; may be useful to display
	// to users.
	Descriptor string `json:"descriptor"`
	// A list of all financial events that have modified this trasnfer.
	Events []TransferEvent `json:"events"`
	// The updated balance of the sending financial account.
	FromBalance []Balance `json:"from_balance"`
	// Pending amount of the transaction in the currency's smallest unit (e.g., cents),
	// including any acquirer fees. The value of this field will go to zero over time
	// once the financial transaction is settled.
	PendingAmount int64 `json:"pending_amount"`
	// APPROVED transactions were successful while DECLINED transactions were declined
	// by user, Lithic, or the network.
	Result TransferResult `json:"result"`
	// Amount of the transaction that has been settled in the currency's smallest unit
	// (e.g., cents).
	SettledAmount int64 `json:"settled_amount"`
	// Status types:
	//
	// - `DECLINED` - The transfer was declined.
	// - `EXPIRED` - The transfer was held in pending for too long and expired.
	// - `PENDING` - The transfer is pending release from a hold.
	// - `SETTLED` - The transfer is completed.
	// - `VOIDED` - The transfer was reversed before it settled.
	Status TransferStatus `json:"status"`
	// The updated balance of the receiving financial account.
	ToBalance []Balance `json:"to_balance"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated time.Time    `json:"updated" format:"date-time"`
	JSON    transferJSON `json:"-"`
}

func (*Transfer) UnmarshalJSON 

func (r *Transfer) UnmarshalJSON(data []byte) (err error)

type TransferCategory 

type TransferCategory string

Status types:

  • `TRANSFER` - Internal transfer of funds between financial accounts in your program.
const (
	TransferCategoryTransfer TransferCategory = "TRANSFER"
)

func (TransferCategory) IsKnown added in v0.27.0 

func (r TransferCategory) IsKnown() bool

type TransferEvent added in v0.5.0 

type TransferEvent struct {
	// Globally unique identifier.
	Token string `json:"token" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result TransferEventsResult `json:"result"`
	Type   TransferEventsType   `json:"type"`
	JSON   transferEventJSON    `json:"-"`
}

func (*TransferEvent) UnmarshalJSON added in v0.5.0 

func (r *TransferEvent) UnmarshalJSON(data []byte) (err error)

type TransferEventsResult 

type TransferEventsResult string

APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network. 

const (
	TransferEventsResultApproved TransferEventsResult = "APPROVED"
	TransferEventsResultDeclined TransferEventsResult = "DECLINED"
)

func (TransferEventsResult) IsKnown added in v0.27.0 

func (r TransferEventsResult) IsKnown() bool

type TransferEventsType 

type TransferEventsType string
const (
	TransferEventsTypeACHOriginationCancelled      TransferEventsType = "ACH_ORIGINATION_CANCELLED"
	TransferEventsTypeACHOriginationInitiated      TransferEventsType = "ACH_ORIGINATION_INITIATED"
	TransferEventsTypeACHOriginationProcessed      TransferEventsType = "ACH_ORIGINATION_PROCESSED"
	TransferEventsTypeACHOriginationReleased       TransferEventsType = "ACH_ORIGINATION_RELEASED"
	TransferEventsTypeACHOriginationReviewed       TransferEventsType = "ACH_ORIGINATION_REVIEWED"
	TransferEventsTypeACHOriginationSettled        TransferEventsType = "ACH_ORIGINATION_SETTLED"
	TransferEventsTypeACHReceiptProcessed          TransferEventsType = "ACH_RECEIPT_PROCESSED"
	TransferEventsTypeACHReceiptSettled            TransferEventsType = "ACH_RECEIPT_SETTLED"
	TransferEventsTypeACHReturnInitiated           TransferEventsType = "ACH_RETURN_INITIATED"
	TransferEventsTypeACHReturnProcessed           TransferEventsType = "ACH_RETURN_PROCESSED"
	TransferEventsTypeAuthorization                TransferEventsType = "AUTHORIZATION"
	TransferEventsTypeAuthorizationAdvice          TransferEventsType = "AUTHORIZATION_ADVICE"
	TransferEventsTypeAuthorizationExpiry          TransferEventsType = "AUTHORIZATION_EXPIRY"
	TransferEventsTypeAuthorizationReversal        TransferEventsType = "AUTHORIZATION_REVERSAL"
	TransferEventsTypeBalanceInquiry               TransferEventsType = "BALANCE_INQUIRY"
	TransferEventsTypeBillingError                 TransferEventsType = "BILLING_ERROR"
	TransferEventsTypeBillingErrorReversal         TransferEventsType = "BILLING_ERROR_REVERSAL"
	TransferEventsTypeCardToCard                   TransferEventsType = "CARD_TO_CARD"
	TransferEventsTypeCashBack                     TransferEventsType = "CASH_BACK"
	TransferEventsTypeCashBackReversal             TransferEventsType = "CASH_BACK_REVERSAL"
	TransferEventsTypeClearing                     TransferEventsType = "CLEARING"
	TransferEventsTypeCorrectionCredit             TransferEventsType = "CORRECTION_CREDIT"
	TransferEventsTypeCorrectionDebit              TransferEventsType = "CORRECTION_DEBIT"
	TransferEventsTypeCreditAuthorization          TransferEventsType = "CREDIT_AUTHORIZATION"
	TransferEventsTypeCreditAuthorizationAdvice    TransferEventsType = "CREDIT_AUTHORIZATION_ADVICE"
	TransferEventsTypeCurrencyConversion           TransferEventsType = "CURRENCY_CONVERSION"
	TransferEventsTypeCurrencyConversionReversal   TransferEventsType = "CURRENCY_CONVERSION_REVERSAL"
	TransferEventsTypeDisputeWon                   TransferEventsType = "DISPUTE_WON"
	TransferEventsTypeExternalACHCanceled          TransferEventsType = "EXTERNAL_ACH_CANCELED"
	TransferEventsTypeExternalACHInitiated         TransferEventsType = "EXTERNAL_ACH_INITIATED"
	TransferEventsTypeExternalACHReleased          TransferEventsType = "EXTERNAL_ACH_RELEASED"
	TransferEventsTypeExternalACHReversed          TransferEventsType = "EXTERNAL_ACH_REVERSED"
	TransferEventsTypeExternalACHSettled           TransferEventsType = "EXTERNAL_ACH_SETTLED"
	TransferEventsTypeExternalCheckCanceled        TransferEventsType = "EXTERNAL_CHECK_CANCELED"
	TransferEventsTypeExternalCheckInitiated       TransferEventsType = "EXTERNAL_CHECK_INITIATED"
	TransferEventsTypeExternalCheckReleased        TransferEventsType = "EXTERNAL_CHECK_RELEASED"
	TransferEventsTypeExternalCheckReversed        TransferEventsType = "EXTERNAL_CHECK_REVERSED"
	TransferEventsTypeExternalCheckSettled         TransferEventsType = "EXTERNAL_CHECK_SETTLED"
	TransferEventsTypeExternalTransferCanceled     TransferEventsType = "EXTERNAL_TRANSFER_CANCELED"
	TransferEventsTypeExternalTransferInitiated    TransferEventsType = "EXTERNAL_TRANSFER_INITIATED"
	TransferEventsTypeExternalTransferReleased     TransferEventsType = "EXTERNAL_TRANSFER_RELEASED"
	TransferEventsTypeExternalTransferReversed     TransferEventsType = "EXTERNAL_TRANSFER_REVERSED"
	TransferEventsTypeExternalTransferSettled      TransferEventsType = "EXTERNAL_TRANSFER_SETTLED"
	TransferEventsTypeExternalWireCanceled         TransferEventsType = "EXTERNAL_WIRE_CANCELED"
	TransferEventsTypeExternalWireInitiated        TransferEventsType = "EXTERNAL_WIRE_INITIATED"
	TransferEventsTypeExternalWireReleased         TransferEventsType = "EXTERNAL_WIRE_RELEASED"
	TransferEventsTypeExternalWireReversed         TransferEventsType = "EXTERNAL_WIRE_REVERSED"
	TransferEventsTypeExternalWireSettled          TransferEventsType = "EXTERNAL_WIRE_SETTLED"
	TransferEventsTypeFinancialAuthorization       TransferEventsType = "FINANCIAL_AUTHORIZATION"
	TransferEventsTypeFinancialCreditAuthorization TransferEventsType = "FINANCIAL_CREDIT_AUTHORIZATION"
	TransferEventsTypeInterest                     TransferEventsType = "INTEREST"
	TransferEventsTypeInterestReversal             TransferEventsType = "INTEREST_REVERSAL"
	TransferEventsTypeLatePayment                  TransferEventsType = "LATE_PAYMENT"
	TransferEventsTypeLatePaymentReversal          TransferEventsType = "LATE_PAYMENT_REVERSAL"
	TransferEventsTypeProvisionalCredit            TransferEventsType = "PROVISIONAL_CREDIT"
	TransferEventsTypeProvisionalCreditReversal    TransferEventsType = "PROVISIONAL_CREDIT_REVERSAL"
	TransferEventsTypeReturn                       TransferEventsType = "RETURN"
	TransferEventsTypeReturnReversal               TransferEventsType = "RETURN_REVERSAL"
	TransferEventsTypeTransfer                     TransferEventsType = "TRANSFER"
	TransferEventsTypeTransferInsufficientFunds    TransferEventsType = "TRANSFER_INSUFFICIENT_FUNDS"
)

func (TransferEventsType) IsKnown added in v0.27.0 

func (r TransferEventsType) IsKnown() bool

type TransferNewParams 

type TransferNewParams struct {
	// Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
	// This should always be a positive value.
	Amount param.Field[int64] `json:"amount,required"`
	// Globally unique identifier for the financial account or card that will send the
	// funds. Accepted type dependent on the program's use case.
	From param.Field[string] `json:"from,required" format:"uuid"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case.
	To param.Field[string] `json:"to,required" format:"uuid"`
	// Customer-provided token that will serve as an idempotency token. This token will
	// become the transaction token.
	Token param.Field[string] `json:"token" format:"uuid"`
	// Optional descriptor for the transfer.
	Memo param.Field[string] `json:"memo"`
}

func (TransferNewParams) MarshalJSON 

func (r TransferNewParams) MarshalJSON() (data []byte, err error)

type TransferResult 

type TransferResult string

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. 

const (
	TransferResultApproved TransferResult = "APPROVED"
	TransferResultDeclined TransferResult = "DECLINED"
)

func (TransferResult) IsKnown added in v0.27.0 

func (r TransferResult) IsKnown() bool

type TransferService 

type TransferService struct {
	Options []option.RequestOption
}

TransferService contains methods and other services that help with interacting with the lithic API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransferService method instead.

func NewTransferService 

func NewTransferService(opts ...option.RequestOption) (r *TransferService)

NewTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TransferService) New 

func (r *TransferService) New(ctx context.Context, body TransferNewParams, opts ...option.RequestOption) (res *Transfer, err error)

Transfer funds between two financial accounts or between a financial account and card

type TransferStatus 

type TransferStatus string

Status types:

- `DECLINED` - The transfer was declined. - `EXPIRED` - The transfer was held in pending for too long and expired. - `PENDING` - The transfer is pending release from a hold. - `SETTLED` - The transfer is completed. - `VOIDED` - The transfer was reversed before it settled. 

const (
	TransferStatusDeclined TransferStatus = "DECLINED"
	TransferStatusExpired  TransferStatus = "EXPIRED"
	TransferStatusPending  TransferStatus = "PENDING"
	TransferStatusSettled  TransferStatus = "SETTLED"
	TransferStatusVoided   TransferStatus = "VOIDED"
)

func (TransferStatus) IsKnown added in v0.27.0 

func (r TransferStatus) IsKnown() bool

type VelocityLimitParams added in v0.51.0 

type VelocityLimitParams = shared.VelocityLimitParams

This is an alias to an internal type.

type VelocityLimitParamsFilters added in v0.51.0 

type VelocityLimitParamsFilters = shared.VelocityLimitParamsFilters

This is an alias to an internal type.

type VelocityLimitParamsPeriodUnion added in v0.51.0 

type VelocityLimitParamsPeriodUnion = shared.VelocityLimitParamsPeriodUnion

The size of the trailing window to calculate Spend Velocity over in seconds. The minimum value is 10 seconds, and the maximum value is 2678400 seconds.

This is an alias to an internal type.

type VelocityLimitParamsPeriodWindow added in v0.51.0 

type VelocityLimitParamsPeriodWindow = shared.VelocityLimitParamsPeriodWindow

The window of time to calculate Spend Velocity over.

  • `DAY`: Velocity over the current day since midnight Eastern Time.
  • `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of the month in Eastern Time.

This is an alias to an internal type.

type VelocityLimitParamsScope added in v0.51.0 

type VelocityLimitParamsScope = shared.VelocityLimitParamsScope

This is an alias to an internal type.

type VerificationMethod added in v0.6.5 

type VerificationMethod string
const (
	VerificationMethodManual             VerificationMethod = "MANUAL"
	VerificationMethodMicroDeposit       VerificationMethod = "MICRO_DEPOSIT"
	VerificationMethodPlaid              VerificationMethod = "PLAID"
	VerificationMethodPrenote            VerificationMethod = "PRENOTE"
	VerificationMethodExternallyVerified VerificationMethod = "EXTERNALLY_VERIFIED"
)

func (VerificationMethod) IsKnown added in v0.27.0 

func (r VerificationMethod) IsKnown() bool

type WebhookService 

type WebhookService struct {
	Options []option.RequestOption
}

WebhookService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWebhookService method instead.

func NewWebhookService 

func NewWebhookService(opts ...option.RequestOption) (r *WebhookService)

NewWebhookService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WebhookService) VerifySignature 

func (r *WebhookService) VerifySignature(payload []byte, headers http.Header, secret string, now time.Time) (err error)

Validates whether or not the webhook payload was sent by Lithic.

An error will be raised if the webhook payload was not sent by Lithic.

type WebhookVerifySignatureParams added in v0.3.1 

type WebhookVerifySignatureParams struct {
}

Source Files

View all Source files

Directories

Path Synopsis
examples
card_embed_html
dispute_upload
union
integrations
pagination
apierror
apiform
apijson
apiquery
param
requestconfig
testutil
packages
pagination

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.