lithic

package module
v0.99.0 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2026 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.

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.99.0'

Requirements

This library requires Go 1.22+.

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 response 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() {
	nonPCICard := iter.Current()
	fmt.Printf("%+v\n", nonPCICard)
}
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.CardNewParamsTypeMerchantLocked),
})
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),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
card, err := client.Cards.New(
	context.TODO(),
	lithic.CardNewParams{
		Type: lithic.F(lithic.CardNewParamsTypeSingleUse),
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", card)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   lithic.F("id_xxxx"),
    Data: lithic.F(FooNewParamsData{
        FirstName: lithic.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Webhooks

Lithic uses webhooks to notify your application when events happen. The library provides signature verification using the standard-webhooks dependency which is already included.

Parsing and verifying webhooks
// Verifies signature and returns typed event
event, err := client.Webhooks.Parse(
	payload,
	request.Header,
	// optionally pass option.WithWebhookSecret(secret), otherwise reads from client config
)
if err != nil {
	log.Fatal(err)
}

// Use type switch on AsUnion() to handle different event types
switch e := event.AsUnion().(type) {
case lithic.CardCreatedWebhookEvent:
	fmt.Printf("Card created: %s\n", e.CardToken)
case lithic.AccountHolderCreatedWebhookEvent:
	fmt.Printf("Account holder created: %s\n", e.Token)
default:
	fmt.Printf("Unknown event type: %T\n", e)
}
Parsing without verification
// Parse only - skips signature verification (not recommended for production)
event, err := client.Webhooks.ParseUnsafe(payload)
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 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 DocumentDocumentTypeFincenBoiReport = shared.DocumentDocumentTypeFincenBoiReport

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 FinancialEventResultApproved = shared.FinancialEventResultApproved

This is an alias to an internal value.

View Source 
const FinancialEventResultDeclined = shared.FinancialEventResultDeclined

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationCancelled = shared.FinancialEventTypeACHOriginationCancelled

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationInitiated = shared.FinancialEventTypeACHOriginationInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationProcessed = shared.FinancialEventTypeACHOriginationProcessed

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationRejected = shared.FinancialEventTypeACHOriginationRejected

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationReleased = shared.FinancialEventTypeACHOriginationReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationReviewed = shared.FinancialEventTypeACHOriginationReviewed

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHOriginationSettled = shared.FinancialEventTypeACHOriginationSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReceiptProcessed = shared.FinancialEventTypeACHReceiptProcessed

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReceiptReleased = shared.FinancialEventTypeACHReceiptReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReceiptSettled = shared.FinancialEventTypeACHReceiptSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReturnInitiated = shared.FinancialEventTypeACHReturnInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReturnProcessed = shared.FinancialEventTypeACHReturnProcessed

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReturnRejected = shared.FinancialEventTypeACHReturnRejected

This is an alias to an internal value.

View Source 
const FinancialEventTypeACHReturnSettled = shared.FinancialEventTypeACHReturnSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeAnnual = shared.FinancialEventTypeAnnual

This is an alias to an internal value.

View Source 
const FinancialEventTypeAnnualReversal = shared.FinancialEventTypeAnnualReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeAuthorization = shared.FinancialEventTypeAuthorization

This is an alias to an internal value.

View Source 
const FinancialEventTypeAuthorizationAdvice = shared.FinancialEventTypeAuthorizationAdvice

This is an alias to an internal value.

View Source 
const FinancialEventTypeAuthorizationExpiry = shared.FinancialEventTypeAuthorizationExpiry

This is an alias to an internal value.

View Source 
const FinancialEventTypeAuthorizationReversal = shared.FinancialEventTypeAuthorizationReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeBalanceInquiry = shared.FinancialEventTypeBalanceInquiry

This is an alias to an internal value.

View Source 
const FinancialEventTypeBillingError = shared.FinancialEventTypeBillingError

This is an alias to an internal value.

View Source 
const FinancialEventTypeBillingErrorReversal = shared.FinancialEventTypeBillingErrorReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeCardToCard = shared.FinancialEventTypeCardToCard

This is an alias to an internal value.

View Source 
const FinancialEventTypeCashBack = shared.FinancialEventTypeCashBack

This is an alias to an internal value.

View Source 
const FinancialEventTypeCashBackReversal = shared.FinancialEventTypeCashBackReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeClearing = shared.FinancialEventTypeClearing

This is an alias to an internal value.

View Source 
const FinancialEventTypeCollection = shared.FinancialEventTypeCollection

This is an alias to an internal value.

View Source 
const FinancialEventTypeCorrectionCredit = shared.FinancialEventTypeCorrectionCredit

This is an alias to an internal value.

View Source 
const FinancialEventTypeCorrectionDebit = shared.FinancialEventTypeCorrectionDebit

This is an alias to an internal value.

View Source 
const FinancialEventTypeCreditAuthorization = shared.FinancialEventTypeCreditAuthorization

This is an alias to an internal value.

View Source 
const FinancialEventTypeCreditAuthorizationAdvice = shared.FinancialEventTypeCreditAuthorizationAdvice

This is an alias to an internal value.

View Source 
const FinancialEventTypeCurrencyConversion = shared.FinancialEventTypeCurrencyConversion

This is an alias to an internal value.

View Source 
const FinancialEventTypeCurrencyConversionReversal = shared.FinancialEventTypeCurrencyConversionReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeDisputeWon = shared.FinancialEventTypeDisputeWon

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalACHCanceled = shared.FinancialEventTypeExternalACHCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalACHInitiated = shared.FinancialEventTypeExternalACHInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalACHReleased = shared.FinancialEventTypeExternalACHReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalACHReversed = shared.FinancialEventTypeExternalACHReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalACHSettled = shared.FinancialEventTypeExternalACHSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalCheckCanceled = shared.FinancialEventTypeExternalCheckCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalCheckInitiated = shared.FinancialEventTypeExternalCheckInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalCheckReleased = shared.FinancialEventTypeExternalCheckReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalCheckReversed = shared.FinancialEventTypeExternalCheckReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalCheckSettled = shared.FinancialEventTypeExternalCheckSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalFednowCanceled = shared.FinancialEventTypeExternalFednowCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalFednowInitiated = shared.FinancialEventTypeExternalFednowInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalFednowReleased = shared.FinancialEventTypeExternalFednowReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalFednowReversed = shared.FinancialEventTypeExternalFednowReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalFednowSettled = shared.FinancialEventTypeExternalFednowSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalRtpCanceled = shared.FinancialEventTypeExternalRtpCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalRtpInitiated = shared.FinancialEventTypeExternalRtpInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalRtpReleased = shared.FinancialEventTypeExternalRtpReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalRtpReversed = shared.FinancialEventTypeExternalRtpReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalRtpSettled = shared.FinancialEventTypeExternalRtpSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalTransferCanceled = shared.FinancialEventTypeExternalTransferCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalTransferInitiated = shared.FinancialEventTypeExternalTransferInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalTransferReleased = shared.FinancialEventTypeExternalTransferReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalTransferReversed = shared.FinancialEventTypeExternalTransferReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalTransferSettled = shared.FinancialEventTypeExternalTransferSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalWireCanceled = shared.FinancialEventTypeExternalWireCanceled

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalWireInitiated = shared.FinancialEventTypeExternalWireInitiated

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalWireReleased = shared.FinancialEventTypeExternalWireReleased

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalWireReversed = shared.FinancialEventTypeExternalWireReversed

This is an alias to an internal value.

View Source 
const FinancialEventTypeExternalWireSettled = shared.FinancialEventTypeExternalWireSettled

This is an alias to an internal value.

View Source 
const FinancialEventTypeFinancialAuthorization = shared.FinancialEventTypeFinancialAuthorization

This is an alias to an internal value.

View Source 
const FinancialEventTypeFinancialCreditAuthorization = shared.FinancialEventTypeFinancialCreditAuthorization

This is an alias to an internal value.

View Source 
const FinancialEventTypeInterest = shared.FinancialEventTypeInterest

This is an alias to an internal value.

View Source 
const FinancialEventTypeInterestReversal = shared.FinancialEventTypeInterestReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeInternalAdjustment = shared.FinancialEventTypeInternalAdjustment

This is an alias to an internal value.

View Source 
const FinancialEventTypeLatePayment = shared.FinancialEventTypeLatePayment

This is an alias to an internal value.

View Source 
const FinancialEventTypeLatePaymentReversal = shared.FinancialEventTypeLatePaymentReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeLithicNetworkPayment = shared.FinancialEventTypeLithicNetworkPayment

This is an alias to an internal value.

View Source 
const FinancialEventTypeLossWriteOff = shared.FinancialEventTypeLossWriteOff

This is an alias to an internal value.

View Source 
const FinancialEventTypeMonthly = shared.FinancialEventTypeMonthly

This is an alias to an internal value.

View Source 
const FinancialEventTypeMonthlyReversal = shared.FinancialEventTypeMonthlyReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeProvisionalCredit = shared.FinancialEventTypeProvisionalCredit

This is an alias to an internal value.

View Source 
const FinancialEventTypeProvisionalCreditReversal = shared.FinancialEventTypeProvisionalCreditReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeQuarterly = shared.FinancialEventTypeQuarterly

This is an alias to an internal value.

View Source 
const FinancialEventTypeQuarterlyReversal = shared.FinancialEventTypeQuarterlyReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeReturn = shared.FinancialEventTypeReturn

This is an alias to an internal value.

View Source 
const FinancialEventTypeReturnReversal = shared.FinancialEventTypeReturnReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeReturnedPayment = shared.FinancialEventTypeReturnedPayment

This is an alias to an internal value.

View Source 
const FinancialEventTypeReturnedPaymentReversal = shared.FinancialEventTypeReturnedPaymentReversal

This is an alias to an internal value.

View Source 
const FinancialEventTypeService = shared.FinancialEventTypeService

This is an alias to an internal value.

View Source 
const FinancialEventTypeTransfer = shared.FinancialEventTypeTransfer

This is an alias to an internal value.

View Source 
const FinancialEventTypeTransferInsufficientFunds = shared.FinancialEventTypeTransferInsufficientFunds

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 DefaultClientOptions added in v0.70.0 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (LITHIC_API_KEY, LITHIC_WEBHOOK_SECRET, LITHIC_BASE_URL). This should be used to initialize new clients.

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.
	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 unable to be transitioned to `ACTIVE` or `PAUSED` states.
	//     Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
	//     failure to pass KYB/KYC or for risk/compliance reasons. Please contact
	//     [support@lithic.com](mailto:support@lithic.com) if you believe this was done
	//     by mistake.
	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.
	//
	// Deprecated: deprecated
	AuthRuleTokens []string `json:"auth_rule_tokens"`
	// 3-character alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency string `json:"cardholder_currency"`
	// Additional context or information related to the account.
	Comment string `json:"comment"`
	// Account state substatus values:
	//
	//   - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
	//     with stolen or fabricated identity information, encompassing both true
	//     identity theft and synthetic identities.
	//   - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
	//     unauthorized access or fraudulent transactions, necessitating further
	//     investigation.
	//   - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
	//     legitimate account holder. Examples include disputing valid transactions
	//     without cause, falsely claiming non-receipt of goods, or engaging in
	//     intentional bust-out schemes to exploit account services.
	//   - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
	//     of the account for personal reasons. This encompasses situations such as
	//     bankruptcy, other financial considerations, or the account holder's death.
	//   - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
	//     business strategy, risk management, inactivity, product changes, regulatory
	//     concerns, or violations of terms and conditions.
	//   - `NOT_ACTIVE` - The account has not had any transactions or payment activity
	//     within a specified period. This status applies to accounts that are paused or
	//     closed due to inactivity.
	//   - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
	//     review. In future implementations, this status may prevent clients from
	//     activating the account via APIs until the review is completed.
	//   - `OTHER` - The reason for the account's current status does not fall into any
	//     of the above categories. A comment should be provided to specify the
	//     particular reason.
	Substatus AccountSubstatus `json:"substatus"`
	// Deprecated: deprecated
	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 AccountActivityGetTransactionResponse added in v0.87.0 

type AccountActivityGetTransactionResponse struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// The status of the transaction
	Status AccountActivityGetTransactionResponseStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// The token for the account associated with this transaction.
	AccountToken string `json:"account_token" 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,nullable"`
	// Unique identifier assigned to a transaction by the acquirer that can be used in
	// dispute and chargeback filing. This field has been deprecated in favor of the
	// `acquirer_reference_number` that resides in the event-level `network_info`.
	//
	// Deprecated: deprecated
	AcquirerReferenceNumber string `json:"acquirer_reference_number,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.
	//
	// Deprecated: deprecated
	Amount int64 `json:"amount"`
	// This field can have the runtime type of [TransactionAmounts].
	Amounts interface{} `json:"amounts"`
	// The authorization amount of the transaction in the anticipated settlement
	// currency.
	//
	// Deprecated: deprecated
	AuthorizationAmount int64 `json:"authorization_amount,nullable"`
	// A fixed-width 6-digit numeric identifier that can be used to identify a
	// transaction with networks.
	AuthorizationCode string `json:"authorization_code,nullable"`
	// This field can have the runtime type of [TransactionAvs].
	Avs interface{} `json:"avs"`
	// Token for the card used in this transaction.
	CardToken                string                   `json:"card_token" format:"uuid"`
	CardholderAuthentication CardholderAuthentication `json:"cardholder_authentication,nullable"`
	// Transaction category
	Category AccountActivityGetTransactionResponseCategory `json:"category"`
	// Currency of the transaction, represented in ISO 4217 format
	Currency string `json:"currency"`
	// Transaction descriptor
	Descriptor string `json:"descriptor"`
	// Transfer direction
	Direction AccountActivityGetTransactionResponseDirection `json:"direction"`
	// This field can have the runtime type of [[]shared.FinancialEvent],
	// [[]BookTransferResponseEvent], [[]TransactionEvent], [[]PaymentEvent],
	// [[]ExternalPaymentEvent], [[]ManagementOperationTransactionEvent].
	Events interface{} `json:"events"`
	// Expected release date for the transaction
	ExpectedReleaseDate time.Time `json:"expected_release_date,nullable" format:"date"`
	// External bank account token
	ExternalBankAccountToken string `json:"external_bank_account_token,nullable" format:"uuid"`
	// External ID defined by the customer
	ExternalID string `json:"external_id,nullable"`
	// External resource associated with the management operation
	ExternalResource ExternalResource `json:"external_resource,nullable"`
	// INTERNAL - Financial Transaction
	Family AccountActivityGetTransactionResponseFamily `json:"family"`
	// Financial account token associated with the transaction
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// 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" format:"uuid"`
	Merchant                  shared.Merchant `json:"merchant"`
	// Analogous to the 'amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAmount int64 `json:"merchant_amount,nullable"`
	// Analogous to the 'authorization_amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,nullable"`
	// 3-character alphabetic ISO 4217 code for the local currency of the transaction.
	//
	// Deprecated: deprecated
	MerchantCurrency string `json:"merchant_currency"`
	// Transfer method
	Method AccountActivityGetTransactionResponseMethod `json:"method"`
	// This field can have the runtime type of [PaymentMethodAttributes].
	MethodAttributes interface{} `json:"method_attributes"`
	// Card network of the authorization. Value is `UNKNOWN` when Lithic cannot
	// determine the network code from the upstream provider.
	Network AccountActivityGetTransactionResponseNetwork `json:"network,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,nullable"`
	PaymentType      AccountActivityGetTransactionResponsePaymentType `json:"payment_type"`
	// Pending amount in cents
	PendingAmount int64 `json:"pending_amount"`
	// This field can have the runtime type of [TransactionPos].
	Pos interface{} `json:"pos"`
	// This field can have the runtime type of [PaymentRelatedAccountTokens].
	RelatedAccountTokens interface{} `json:"related_account_tokens"`
	// Transaction result
	Result AccountActivityGetTransactionResponseResult `json:"result"`
	// Settled amount in cents
	SettledAmount int64 `json:"settled_amount"`
	// Transaction source
	Source AccountActivityGetTransactionResponseSource `json:"source"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case
	ToFinancialAccountToken string    `json:"to_financial_account_token" format:"uuid"`
	TokenInfo               TokenInfo `json:"token_info,nullable"`
	// This field can have the runtime type of [BookTransferResponseTransactionSeries],
	// [ManagementOperationTransactionTransactionSeries].
	TransactionSeries interface{}                               `json:"transaction_series"`
	Type              AccountActivityGetTransactionResponseType `json:"type"`
	// User-defined identifier
	UserDefinedID string                                    `json:"user_defined_id,nullable"`
	JSON          accountActivityGetTransactionResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

Response containing multiple transaction types. The `family` field determines which transaction type is returned: INTERNAL returns FinancialTransaction, TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse, and MANAGEMENT_OPERATION returns ManagementOperationTransaction

func (AccountActivityGetTransactionResponse) AsUnion added in v0.87.0 

func (r AccountActivityGetTransactionResponse) AsUnion() AccountActivityGetTransactionResponseUnion

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

Possible runtime types of the union are AccountActivityGetTransactionResponseFinancialTransaction, BookTransferResponse, AccountActivityGetTransactionResponseCardTransaction, Payment, ExternalPayment, ManagementOperationTransaction.

func (*AccountActivityGetTransactionResponse) UnmarshalJSON added in v0.87.0 

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

type AccountActivityGetTransactionResponseCardTransaction added in v0.87.0 

type AccountActivityGetTransactionResponseCardTransaction struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// CARD - Card Transaction
	Family AccountActivityGetTransactionResponseCardTransactionFamily `json:"family,required"`
	// The status of the transaction
	Status AccountActivityGetTransactionResponseCardTransactionStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time                                                `json:"updated,required" format:"date-time"`
	JSON    accountActivityGetTransactionResponseCardTransactionJSON `json:"-"`
	Transaction
}

Card transaction with ledger base properties

func (*AccountActivityGetTransactionResponseCardTransaction) UnmarshalJSON added in v0.87.0 

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

type AccountActivityGetTransactionResponseCardTransactionFamily added in v0.87.0 

type AccountActivityGetTransactionResponseCardTransactionFamily string

CARD - Card Transaction 

const (
	AccountActivityGetTransactionResponseCardTransactionFamilyCard AccountActivityGetTransactionResponseCardTransactionFamily = "CARD"
)

func (AccountActivityGetTransactionResponseCardTransactionFamily) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseCardTransactionFamily) IsKnown() bool

type AccountActivityGetTransactionResponseCardTransactionStatus added in v0.87.0 

type AccountActivityGetTransactionResponseCardTransactionStatus string

The status of the transaction 

const (
	AccountActivityGetTransactionResponseCardTransactionStatusPending  AccountActivityGetTransactionResponseCardTransactionStatus = "PENDING"
	AccountActivityGetTransactionResponseCardTransactionStatusSettled  AccountActivityGetTransactionResponseCardTransactionStatus = "SETTLED"
	AccountActivityGetTransactionResponseCardTransactionStatusDeclined AccountActivityGetTransactionResponseCardTransactionStatus = "DECLINED"
	AccountActivityGetTransactionResponseCardTransactionStatusReversed AccountActivityGetTransactionResponseCardTransactionStatus = "REVERSED"
	AccountActivityGetTransactionResponseCardTransactionStatusCanceled AccountActivityGetTransactionResponseCardTransactionStatus = "CANCELED"
	AccountActivityGetTransactionResponseCardTransactionStatusReturned AccountActivityGetTransactionResponseCardTransactionStatus = "RETURNED"
)

func (AccountActivityGetTransactionResponseCardTransactionStatus) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseCardTransactionStatus) IsKnown() bool

type AccountActivityGetTransactionResponseCategory added in v0.87.0 

type AccountActivityGetTransactionResponseCategory string

Transaction category 

const (
	AccountActivityGetTransactionResponseCategoryACH                    AccountActivityGetTransactionResponseCategory = "ACH"
	AccountActivityGetTransactionResponseCategoryBalanceOrFunding       AccountActivityGetTransactionResponseCategory = "BALANCE_OR_FUNDING"
	AccountActivityGetTransactionResponseCategoryFee                    AccountActivityGetTransactionResponseCategory = "FEE"
	AccountActivityGetTransactionResponseCategoryReward                 AccountActivityGetTransactionResponseCategory = "REWARD"
	AccountActivityGetTransactionResponseCategoryAdjustment             AccountActivityGetTransactionResponseCategory = "ADJUSTMENT"
	AccountActivityGetTransactionResponseCategoryDerecognition          AccountActivityGetTransactionResponseCategory = "DERECOGNITION"
	AccountActivityGetTransactionResponseCategoryDispute                AccountActivityGetTransactionResponseCategory = "DISPUTE"
	AccountActivityGetTransactionResponseCategoryCard                   AccountActivityGetTransactionResponseCategory = "CARD"
	AccountActivityGetTransactionResponseCategoryExternalACH            AccountActivityGetTransactionResponseCategory = "EXTERNAL_ACH"
	AccountActivityGetTransactionResponseCategoryExternalCheck          AccountActivityGetTransactionResponseCategory = "EXTERNAL_CHECK"
	AccountActivityGetTransactionResponseCategoryExternalFednow         AccountActivityGetTransactionResponseCategory = "EXTERNAL_FEDNOW"
	AccountActivityGetTransactionResponseCategoryExternalRtp            AccountActivityGetTransactionResponseCategory = "EXTERNAL_RTP"
	AccountActivityGetTransactionResponseCategoryExternalTransfer       AccountActivityGetTransactionResponseCategory = "EXTERNAL_TRANSFER"
	AccountActivityGetTransactionResponseCategoryExternalWire           AccountActivityGetTransactionResponseCategory = "EXTERNAL_WIRE"
	AccountActivityGetTransactionResponseCategoryManagementAdjustment   AccountActivityGetTransactionResponseCategory = "MANAGEMENT_ADJUSTMENT"
	AccountActivityGetTransactionResponseCategoryManagementDispute      AccountActivityGetTransactionResponseCategory = "MANAGEMENT_DISPUTE"
	AccountActivityGetTransactionResponseCategoryManagementFee          AccountActivityGetTransactionResponseCategory = "MANAGEMENT_FEE"
	AccountActivityGetTransactionResponseCategoryManagementReward       AccountActivityGetTransactionResponseCategory = "MANAGEMENT_REWARD"
	AccountActivityGetTransactionResponseCategoryManagementDisbursement AccountActivityGetTransactionResponseCategory = "MANAGEMENT_DISBURSEMENT"
	AccountActivityGetTransactionResponseCategoryProgramFunding         AccountActivityGetTransactionResponseCategory = "PROGRAM_FUNDING"
	AccountActivityGetTransactionResponseCategoryInternal               AccountActivityGetTransactionResponseCategory = "INTERNAL"
	AccountActivityGetTransactionResponseCategoryTransfer               AccountActivityGetTransactionResponseCategory = "TRANSFER"
)

func (AccountActivityGetTransactionResponseCategory) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseCategory) IsKnown() bool

type AccountActivityGetTransactionResponseDirection added in v0.87.0 

type AccountActivityGetTransactionResponseDirection string

Transfer direction 

const (
	AccountActivityGetTransactionResponseDirectionCredit AccountActivityGetTransactionResponseDirection = "CREDIT"
	AccountActivityGetTransactionResponseDirectionDebit  AccountActivityGetTransactionResponseDirection = "DEBIT"
)

func (AccountActivityGetTransactionResponseDirection) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseDirection) IsKnown() bool

type AccountActivityGetTransactionResponseFamily added in v0.87.0 

type AccountActivityGetTransactionResponseFamily string

INTERNAL - Financial Transaction 

const (
	AccountActivityGetTransactionResponseFamilyInternal            AccountActivityGetTransactionResponseFamily = "INTERNAL"
	AccountActivityGetTransactionResponseFamilyTransfer            AccountActivityGetTransactionResponseFamily = "TRANSFER"
	AccountActivityGetTransactionResponseFamilyCard                AccountActivityGetTransactionResponseFamily = "CARD"
	AccountActivityGetTransactionResponseFamilyPayment             AccountActivityGetTransactionResponseFamily = "PAYMENT"
	AccountActivityGetTransactionResponseFamilyExternalPayment     AccountActivityGetTransactionResponseFamily = "EXTERNAL_PAYMENT"
	AccountActivityGetTransactionResponseFamilyManagementOperation AccountActivityGetTransactionResponseFamily = "MANAGEMENT_OPERATION"
)

func (AccountActivityGetTransactionResponseFamily) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseFamily) IsKnown() bool

type AccountActivityGetTransactionResponseFinancialTransaction added in v0.87.0 

type AccountActivityGetTransactionResponseFinancialTransaction struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// Transaction category
	Category AccountActivityGetTransactionResponseFinancialTransactionCategory `json:"category,required"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// Currency of the transaction, represented in ISO 4217 format
	Currency string `json:"currency,required"`
	// Transaction descriptor
	Descriptor string `json:"descriptor,required"`
	// List of transaction events
	Events []shared.FinancialEvent `json:"events,required"`
	// INTERNAL - Financial Transaction
	Family AccountActivityGetTransactionResponseFinancialTransactionFamily `json:"family,required"`
	// Financial account token associated with the transaction
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Pending amount in cents
	PendingAmount int64 `json:"pending_amount,required"`
	// Transaction result
	Result AccountActivityGetTransactionResponseFinancialTransactionResult `json:"result,required"`
	// Settled amount in cents
	SettledAmount int64 `json:"settled_amount,required"`
	// The status of the transaction
	Status AccountActivityGetTransactionResponseFinancialTransactionStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time                                                     `json:"updated,required" format:"date-time"`
	JSON    accountActivityGetTransactionResponseFinancialTransactionJSON `json:"-"`
}

Financial transaction with inheritance from unified base transaction

func (*AccountActivityGetTransactionResponseFinancialTransaction) UnmarshalJSON added in v0.87.0 

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

type AccountActivityGetTransactionResponseFinancialTransactionCategory added in v0.87.0 

type AccountActivityGetTransactionResponseFinancialTransactionCategory string

Transaction category 

const (
	AccountActivityGetTransactionResponseFinancialTransactionCategoryACH                    AccountActivityGetTransactionResponseFinancialTransactionCategory = "ACH"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryBalanceOrFunding       AccountActivityGetTransactionResponseFinancialTransactionCategory = "BALANCE_OR_FUNDING"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryFee                    AccountActivityGetTransactionResponseFinancialTransactionCategory = "FEE"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryReward                 AccountActivityGetTransactionResponseFinancialTransactionCategory = "REWARD"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryAdjustment             AccountActivityGetTransactionResponseFinancialTransactionCategory = "ADJUSTMENT"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryDerecognition          AccountActivityGetTransactionResponseFinancialTransactionCategory = "DERECOGNITION"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryDispute                AccountActivityGetTransactionResponseFinancialTransactionCategory = "DISPUTE"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryCard                   AccountActivityGetTransactionResponseFinancialTransactionCategory = "CARD"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalACH            AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_ACH"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalCheck          AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_CHECK"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalFednow         AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_FEDNOW"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalRtp            AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_RTP"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalTransfer       AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_TRANSFER"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryExternalWire           AccountActivityGetTransactionResponseFinancialTransactionCategory = "EXTERNAL_WIRE"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryManagementAdjustment   AccountActivityGetTransactionResponseFinancialTransactionCategory = "MANAGEMENT_ADJUSTMENT"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryManagementDispute      AccountActivityGetTransactionResponseFinancialTransactionCategory = "MANAGEMENT_DISPUTE"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryManagementFee          AccountActivityGetTransactionResponseFinancialTransactionCategory = "MANAGEMENT_FEE"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryManagementReward       AccountActivityGetTransactionResponseFinancialTransactionCategory = "MANAGEMENT_REWARD"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryManagementDisbursement AccountActivityGetTransactionResponseFinancialTransactionCategory = "MANAGEMENT_DISBURSEMENT"
	AccountActivityGetTransactionResponseFinancialTransactionCategoryProgramFunding         AccountActivityGetTransactionResponseFinancialTransactionCategory = "PROGRAM_FUNDING"
)

func (AccountActivityGetTransactionResponseFinancialTransactionCategory) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseFinancialTransactionCategory) IsKnown() bool

type AccountActivityGetTransactionResponseFinancialTransactionFamily added in v0.87.0 

type AccountActivityGetTransactionResponseFinancialTransactionFamily string

INTERNAL - Financial Transaction 

const (
	AccountActivityGetTransactionResponseFinancialTransactionFamilyInternal AccountActivityGetTransactionResponseFinancialTransactionFamily = "INTERNAL"
)

func (AccountActivityGetTransactionResponseFinancialTransactionFamily) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseFinancialTransactionFamily) IsKnown() bool

type AccountActivityGetTransactionResponseFinancialTransactionResult added in v0.87.0 

type AccountActivityGetTransactionResponseFinancialTransactionResult string

Transaction result 

const (
	AccountActivityGetTransactionResponseFinancialTransactionResultApproved AccountActivityGetTransactionResponseFinancialTransactionResult = "APPROVED"
	AccountActivityGetTransactionResponseFinancialTransactionResultDeclined AccountActivityGetTransactionResponseFinancialTransactionResult = "DECLINED"
)

func (AccountActivityGetTransactionResponseFinancialTransactionResult) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseFinancialTransactionResult) IsKnown() bool

type AccountActivityGetTransactionResponseFinancialTransactionStatus added in v0.87.0 

type AccountActivityGetTransactionResponseFinancialTransactionStatus string

The status of the transaction 

const (
	AccountActivityGetTransactionResponseFinancialTransactionStatusPending  AccountActivityGetTransactionResponseFinancialTransactionStatus = "PENDING"
	AccountActivityGetTransactionResponseFinancialTransactionStatusSettled  AccountActivityGetTransactionResponseFinancialTransactionStatus = "SETTLED"
	AccountActivityGetTransactionResponseFinancialTransactionStatusDeclined AccountActivityGetTransactionResponseFinancialTransactionStatus = "DECLINED"
	AccountActivityGetTransactionResponseFinancialTransactionStatusReversed AccountActivityGetTransactionResponseFinancialTransactionStatus = "REVERSED"
	AccountActivityGetTransactionResponseFinancialTransactionStatusCanceled AccountActivityGetTransactionResponseFinancialTransactionStatus = "CANCELED"
	AccountActivityGetTransactionResponseFinancialTransactionStatusReturned AccountActivityGetTransactionResponseFinancialTransactionStatus = "RETURNED"
)

func (AccountActivityGetTransactionResponseFinancialTransactionStatus) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseFinancialTransactionStatus) IsKnown() bool

type AccountActivityGetTransactionResponseMethod added in v0.87.0 

type AccountActivityGetTransactionResponseMethod string

Transfer method 

const (
	AccountActivityGetTransactionResponseMethodACHNextDay AccountActivityGetTransactionResponseMethod = "ACH_NEXT_DAY"
	AccountActivityGetTransactionResponseMethodACHSameDay AccountActivityGetTransactionResponseMethod = "ACH_SAME_DAY"
	AccountActivityGetTransactionResponseMethodWire       AccountActivityGetTransactionResponseMethod = "WIRE"
)

func (AccountActivityGetTransactionResponseMethod) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseMethod) IsKnown() bool

type AccountActivityGetTransactionResponseNetwork added in v0.87.0 

type AccountActivityGetTransactionResponseNetwork string

Card network of the authorization. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider. 

const (
	AccountActivityGetTransactionResponseNetworkAmex       AccountActivityGetTransactionResponseNetwork = "AMEX"
	AccountActivityGetTransactionResponseNetworkInterlink  AccountActivityGetTransactionResponseNetwork = "INTERLINK"
	AccountActivityGetTransactionResponseNetworkMaestro    AccountActivityGetTransactionResponseNetwork = "MAESTRO"
	AccountActivityGetTransactionResponseNetworkMastercard AccountActivityGetTransactionResponseNetwork = "MASTERCARD"
	AccountActivityGetTransactionResponseNetworkUnknown    AccountActivityGetTransactionResponseNetwork = "UNKNOWN"
	AccountActivityGetTransactionResponseNetworkVisa       AccountActivityGetTransactionResponseNetwork = "VISA"
)

func (AccountActivityGetTransactionResponseNetwork) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseNetwork) IsKnown() bool

type AccountActivityGetTransactionResponsePaymentType added in v0.87.0 

type AccountActivityGetTransactionResponsePaymentType string
const (
	AccountActivityGetTransactionResponsePaymentTypeDeposit    AccountActivityGetTransactionResponsePaymentType = "DEPOSIT"
	AccountActivityGetTransactionResponsePaymentTypeWithdrawal AccountActivityGetTransactionResponsePaymentType = "WITHDRAWAL"
)

func (AccountActivityGetTransactionResponsePaymentType) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponsePaymentType) IsKnown() bool

type AccountActivityGetTransactionResponseResult added in v0.87.0 

type AccountActivityGetTransactionResponseResult string

Transaction result 

const (
	AccountActivityGetTransactionResponseResultApproved                    AccountActivityGetTransactionResponseResult = "APPROVED"
	AccountActivityGetTransactionResponseResultDeclined                    AccountActivityGetTransactionResponseResult = "DECLINED"
	AccountActivityGetTransactionResponseResultAccountPaused               AccountActivityGetTransactionResponseResult = "ACCOUNT_PAUSED"
	AccountActivityGetTransactionResponseResultAccountStateTransactionFail AccountActivityGetTransactionResponseResult = "ACCOUNT_STATE_TRANSACTION_FAIL"
	AccountActivityGetTransactionResponseResultBankConnectionError         AccountActivityGetTransactionResponseResult = "BANK_CONNECTION_ERROR"
	AccountActivityGetTransactionResponseResultBankNotVerified             AccountActivityGetTransactionResponseResult = "BANK_NOT_VERIFIED"
	AccountActivityGetTransactionResponseResultCardClosed                  AccountActivityGetTransactionResponseResult = "CARD_CLOSED"
	AccountActivityGetTransactionResponseResultCardPaused                  AccountActivityGetTransactionResponseResult = "CARD_PAUSED"
	AccountActivityGetTransactionResponseResultFraudAdvice                 AccountActivityGetTransactionResponseResult = "FRAUD_ADVICE"
	AccountActivityGetTransactionResponseResultIgnoredTtlExpiry            AccountActivityGetTransactionResponseResult = "IGNORED_TTL_EXPIRY"
	AccountActivityGetTransactionResponseResultSuspectedFraud              AccountActivityGetTransactionResponseResult = "SUSPECTED_FRAUD"
	AccountActivityGetTransactionResponseResultInactiveAccount             AccountActivityGetTransactionResponseResult = "INACTIVE_ACCOUNT"
	AccountActivityGetTransactionResponseResultIncorrectPin                AccountActivityGetTransactionResponseResult = "INCORRECT_PIN"
	AccountActivityGetTransactionResponseResultInvalidCardDetails          AccountActivityGetTransactionResponseResult = "INVALID_CARD_DETAILS"
	AccountActivityGetTransactionResponseResultInsufficientFunds           AccountActivityGetTransactionResponseResult = "INSUFFICIENT_FUNDS"
	AccountActivityGetTransactionResponseResultInsufficientFundsPreload    AccountActivityGetTransactionResponseResult = "INSUFFICIENT_FUNDS_PRELOAD"
	AccountActivityGetTransactionResponseResultInvalidTransaction          AccountActivityGetTransactionResponseResult = "INVALID_TRANSACTION"
	AccountActivityGetTransactionResponseResultMerchantBlacklist           AccountActivityGetTransactionResponseResult = "MERCHANT_BLACKLIST"
	AccountActivityGetTransactionResponseResultOriginalNotFound            AccountActivityGetTransactionResponseResult = "ORIGINAL_NOT_FOUND"
	AccountActivityGetTransactionResponseResultPreviouslyCompleted         AccountActivityGetTransactionResponseResult = "PREVIOUSLY_COMPLETED"
	AccountActivityGetTransactionResponseResultSingleUseRecharged          AccountActivityGetTransactionResponseResult = "SINGLE_USE_RECHARGED"
	AccountActivityGetTransactionResponseResultSwitchInoperativeAdvice     AccountActivityGetTransactionResponseResult = "SWITCH_INOPERATIVE_ADVICE"
	AccountActivityGetTransactionResponseResultUnauthorizedMerchant        AccountActivityGetTransactionResponseResult = "UNAUTHORIZED_MERCHANT"
	AccountActivityGetTransactionResponseResultUnknownHostTimeout          AccountActivityGetTransactionResponseResult = "UNKNOWN_HOST_TIMEOUT"
	AccountActivityGetTransactionResponseResultUserTransactionLimit        AccountActivityGetTransactionResponseResult = "USER_TRANSACTION_LIMIT"
)

func (AccountActivityGetTransactionResponseResult) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseResult) IsKnown() bool

type AccountActivityGetTransactionResponseSource added in v0.87.0 

type AccountActivityGetTransactionResponseSource string

Transaction source 

const (
	AccountActivityGetTransactionResponseSourceLithic   AccountActivityGetTransactionResponseSource = "LITHIC"
	AccountActivityGetTransactionResponseSourceExternal AccountActivityGetTransactionResponseSource = "EXTERNAL"
	AccountActivityGetTransactionResponseSourceCustomer AccountActivityGetTransactionResponseSource = "CUSTOMER"
)

func (AccountActivityGetTransactionResponseSource) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseSource) IsKnown() bool

type AccountActivityGetTransactionResponseStatus added in v0.87.0 

type AccountActivityGetTransactionResponseStatus string

The status of the transaction 

const (
	AccountActivityGetTransactionResponseStatusPending  AccountActivityGetTransactionResponseStatus = "PENDING"
	AccountActivityGetTransactionResponseStatusSettled  AccountActivityGetTransactionResponseStatus = "SETTLED"
	AccountActivityGetTransactionResponseStatusDeclined AccountActivityGetTransactionResponseStatus = "DECLINED"
	AccountActivityGetTransactionResponseStatusReversed AccountActivityGetTransactionResponseStatus = "REVERSED"
	AccountActivityGetTransactionResponseStatusCanceled AccountActivityGetTransactionResponseStatus = "CANCELED"
	AccountActivityGetTransactionResponseStatusReturned AccountActivityGetTransactionResponseStatus = "RETURNED"
	AccountActivityGetTransactionResponseStatusExpired  AccountActivityGetTransactionResponseStatus = "EXPIRED"
	AccountActivityGetTransactionResponseStatusVoided   AccountActivityGetTransactionResponseStatus = "VOIDED"
)

func (AccountActivityGetTransactionResponseStatus) IsKnown added in v0.87.0 

func (r AccountActivityGetTransactionResponseStatus) IsKnown() bool

type AccountActivityGetTransactionResponseType added in v0.90.0 

type AccountActivityGetTransactionResponseType string
const (
	AccountActivityGetTransactionResponseTypeOriginationCredit   AccountActivityGetTransactionResponseType = "ORIGINATION_CREDIT"
	AccountActivityGetTransactionResponseTypeOriginationDebit    AccountActivityGetTransactionResponseType = "ORIGINATION_DEBIT"
	AccountActivityGetTransactionResponseTypeReceiptCredit       AccountActivityGetTransactionResponseType = "RECEIPT_CREDIT"
	AccountActivityGetTransactionResponseTypeReceiptDebit        AccountActivityGetTransactionResponseType = "RECEIPT_DEBIT"
	AccountActivityGetTransactionResponseTypeWireInboundPayment  AccountActivityGetTransactionResponseType = "WIRE_INBOUND_PAYMENT"
	AccountActivityGetTransactionResponseTypeWireInboundAdmin    AccountActivityGetTransactionResponseType = "WIRE_INBOUND_ADMIN"
	AccountActivityGetTransactionResponseTypeWireOutboundPayment AccountActivityGetTransactionResponseType = "WIRE_OUTBOUND_PAYMENT"
	AccountActivityGetTransactionResponseTypeWireOutboundAdmin   AccountActivityGetTransactionResponseType = "WIRE_OUTBOUND_ADMIN"
	AccountActivityGetTransactionResponseTypeWireDrawdownRequest AccountActivityGetTransactionResponseType = "WIRE_DRAWDOWN_REQUEST"
)

func (AccountActivityGetTransactionResponseType) IsKnown added in v0.90.0 

func (r AccountActivityGetTransactionResponseType) IsKnown() bool

type AccountActivityGetTransactionResponseUnion added in v0.87.0 

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

Response containing multiple transaction types. The `family` field determines which transaction type is returned: INTERNAL returns FinancialTransaction, TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse, and MANAGEMENT_OPERATION returns ManagementOperationTransaction

Union satisfied by AccountActivityGetTransactionResponseFinancialTransaction, BookTransferResponse, AccountActivityGetTransactionResponseCardTransaction, Payment, ExternalPayment or ManagementOperationTransaction.

type AccountActivityListParams added in v0.87.0 

type AccountActivityListParams struct {
	// Filter by account token
	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"`
	// Filter by business account token
	BusinessAccountToken param.Field[string] `query:"business_account_token" format:"uuid"`
	// Filter by transaction category
	Category param.Field[AccountActivityListParamsCategory] `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"`
	// Filter by financial account token
	FinancialAccountToken param.Field[string] `query:"financial_account_token" format:"uuid"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// Filter by transaction result
	Result param.Field[AccountActivityListParamsResult] `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"`
	// Filter by transaction status
	Status param.Field[AccountActivityListParamsStatus] `query:"status"`
}

func (AccountActivityListParams) URLQuery added in v0.87.0 

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

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

type AccountActivityListParamsCategory added in v0.87.0 

type AccountActivityListParamsCategory string

Filter by transaction category 

const (
	AccountActivityListParamsCategoryACH                    AccountActivityListParamsCategory = "ACH"
	AccountActivityListParamsCategoryBalanceOrFunding       AccountActivityListParamsCategory = "BALANCE_OR_FUNDING"
	AccountActivityListParamsCategoryFee                    AccountActivityListParamsCategory = "FEE"
	AccountActivityListParamsCategoryReward                 AccountActivityListParamsCategory = "REWARD"
	AccountActivityListParamsCategoryAdjustment             AccountActivityListParamsCategory = "ADJUSTMENT"
	AccountActivityListParamsCategoryDerecognition          AccountActivityListParamsCategory = "DERECOGNITION"
	AccountActivityListParamsCategoryDispute                AccountActivityListParamsCategory = "DISPUTE"
	AccountActivityListParamsCategoryCard                   AccountActivityListParamsCategory = "CARD"
	AccountActivityListParamsCategoryExternalACH            AccountActivityListParamsCategory = "EXTERNAL_ACH"
	AccountActivityListParamsCategoryExternalCheck          AccountActivityListParamsCategory = "EXTERNAL_CHECK"
	AccountActivityListParamsCategoryExternalFednow         AccountActivityListParamsCategory = "EXTERNAL_FEDNOW"
	AccountActivityListParamsCategoryExternalRtp            AccountActivityListParamsCategory = "EXTERNAL_RTP"
	AccountActivityListParamsCategoryExternalTransfer       AccountActivityListParamsCategory = "EXTERNAL_TRANSFER"
	AccountActivityListParamsCategoryExternalWire           AccountActivityListParamsCategory = "EXTERNAL_WIRE"
	AccountActivityListParamsCategoryManagementAdjustment   AccountActivityListParamsCategory = "MANAGEMENT_ADJUSTMENT"
	AccountActivityListParamsCategoryManagementDispute      AccountActivityListParamsCategory = "MANAGEMENT_DISPUTE"
	AccountActivityListParamsCategoryManagementFee          AccountActivityListParamsCategory = "MANAGEMENT_FEE"
	AccountActivityListParamsCategoryManagementReward       AccountActivityListParamsCategory = "MANAGEMENT_REWARD"
	AccountActivityListParamsCategoryManagementDisbursement AccountActivityListParamsCategory = "MANAGEMENT_DISBURSEMENT"
	AccountActivityListParamsCategoryProgramFunding         AccountActivityListParamsCategory = "PROGRAM_FUNDING"
)

func (AccountActivityListParamsCategory) IsKnown added in v0.87.0 

func (r AccountActivityListParamsCategory) IsKnown() bool

type AccountActivityListParamsResult added in v0.87.0 

type AccountActivityListParamsResult string

Filter by transaction result 

const (
	AccountActivityListParamsResultApproved AccountActivityListParamsResult = "APPROVED"
	AccountActivityListParamsResultDeclined AccountActivityListParamsResult = "DECLINED"
)

func (AccountActivityListParamsResult) IsKnown added in v0.87.0 

func (r AccountActivityListParamsResult) IsKnown() bool

type AccountActivityListParamsStatus added in v0.87.0 

type AccountActivityListParamsStatus string

Filter by transaction status 

const (
	AccountActivityListParamsStatusDeclined AccountActivityListParamsStatus = "DECLINED"
	AccountActivityListParamsStatusExpired  AccountActivityListParamsStatus = "EXPIRED"
	AccountActivityListParamsStatusPending  AccountActivityListParamsStatus = "PENDING"
	AccountActivityListParamsStatusReturned AccountActivityListParamsStatus = "RETURNED"
	AccountActivityListParamsStatusReversed AccountActivityListParamsStatus = "REVERSED"
	AccountActivityListParamsStatusSettled  AccountActivityListParamsStatus = "SETTLED"
	AccountActivityListParamsStatusVoided   AccountActivityListParamsStatus = "VOIDED"
)

func (AccountActivityListParamsStatus) IsKnown added in v0.87.0 

func (r AccountActivityListParamsStatus) IsKnown() bool

type AccountActivityListResponse added in v0.87.0 

type AccountActivityListResponse struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// The status of the transaction
	Status AccountActivityListResponseStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// The token for the account associated with this transaction.
	AccountToken string `json:"account_token" 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,nullable"`
	// Unique identifier assigned to a transaction by the acquirer that can be used in
	// dispute and chargeback filing. This field has been deprecated in favor of the
	// `acquirer_reference_number` that resides in the event-level `network_info`.
	//
	// Deprecated: deprecated
	AcquirerReferenceNumber string `json:"acquirer_reference_number,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.
	//
	// Deprecated: deprecated
	Amount int64 `json:"amount"`
	// This field can have the runtime type of [TransactionAmounts].
	Amounts interface{} `json:"amounts"`
	// The authorization amount of the transaction in the anticipated settlement
	// currency.
	//
	// Deprecated: deprecated
	AuthorizationAmount int64 `json:"authorization_amount,nullable"`
	// A fixed-width 6-digit numeric identifier that can be used to identify a
	// transaction with networks.
	AuthorizationCode string `json:"authorization_code,nullable"`
	// This field can have the runtime type of [TransactionAvs].
	Avs interface{} `json:"avs"`
	// Token for the card used in this transaction.
	CardToken                string                   `json:"card_token" format:"uuid"`
	CardholderAuthentication CardholderAuthentication `json:"cardholder_authentication,nullable"`
	// Transaction category
	Category AccountActivityListResponseCategory `json:"category"`
	// Currency of the transaction, represented in ISO 4217 format
	Currency string `json:"currency"`
	// Transaction descriptor
	Descriptor string `json:"descriptor"`
	// Transfer direction
	Direction AccountActivityListResponseDirection `json:"direction"`
	// This field can have the runtime type of [[]shared.FinancialEvent],
	// [[]BookTransferResponseEvent], [[]TransactionEvent], [[]PaymentEvent],
	// [[]ExternalPaymentEvent], [[]ManagementOperationTransactionEvent].
	Events interface{} `json:"events"`
	// Expected release date for the transaction
	ExpectedReleaseDate time.Time `json:"expected_release_date,nullable" format:"date"`
	// External bank account token
	ExternalBankAccountToken string `json:"external_bank_account_token,nullable" format:"uuid"`
	// External ID defined by the customer
	ExternalID string `json:"external_id,nullable"`
	// External resource associated with the management operation
	ExternalResource ExternalResource `json:"external_resource,nullable"`
	// INTERNAL - Financial Transaction
	Family AccountActivityListResponseFamily `json:"family"`
	// Financial account token associated with the transaction
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// 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" format:"uuid"`
	Merchant                  shared.Merchant `json:"merchant"`
	// Analogous to the 'amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAmount int64 `json:"merchant_amount,nullable"`
	// Analogous to the 'authorization_amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,nullable"`
	// 3-character alphabetic ISO 4217 code for the local currency of the transaction.
	//
	// Deprecated: deprecated
	MerchantCurrency string `json:"merchant_currency"`
	// Transfer method
	Method AccountActivityListResponseMethod `json:"method"`
	// This field can have the runtime type of [PaymentMethodAttributes].
	MethodAttributes interface{} `json:"method_attributes"`
	// Card network of the authorization. Value is `UNKNOWN` when Lithic cannot
	// determine the network code from the upstream provider.
	Network AccountActivityListResponseNetwork `json:"network,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,nullable"`
	PaymentType      AccountActivityListResponsePaymentType `json:"payment_type"`
	// Pending amount in cents
	PendingAmount int64 `json:"pending_amount"`
	// This field can have the runtime type of [TransactionPos].
	Pos interface{} `json:"pos"`
	// This field can have the runtime type of [PaymentRelatedAccountTokens].
	RelatedAccountTokens interface{} `json:"related_account_tokens"`
	// Transaction result
	Result AccountActivityListResponseResult `json:"result"`
	// Settled amount in cents
	SettledAmount int64 `json:"settled_amount"`
	// Transaction source
	Source AccountActivityListResponseSource `json:"source"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case
	ToFinancialAccountToken string    `json:"to_financial_account_token" format:"uuid"`
	TokenInfo               TokenInfo `json:"token_info,nullable"`
	// This field can have the runtime type of [BookTransferResponseTransactionSeries],
	// [ManagementOperationTransactionTransactionSeries].
	TransactionSeries interface{}                     `json:"transaction_series"`
	Type              AccountActivityListResponseType `json:"type"`
	// User-defined identifier
	UserDefinedID string                          `json:"user_defined_id,nullable"`
	JSON          accountActivityListResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

Response containing multiple transaction types. The `family` field determines which transaction type is returned: INTERNAL returns FinancialTransaction, TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse, and MANAGEMENT_OPERATION returns ManagementOperationTransaction

func (AccountActivityListResponse) AsUnion added in v0.87.0 

func (r AccountActivityListResponse) AsUnion() AccountActivityListResponseUnion

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

Possible runtime types of the union are AccountActivityListResponseFinancialTransaction, BookTransferResponse, AccountActivityListResponseCardTransaction, Payment, ExternalPayment, ManagementOperationTransaction.

func (*AccountActivityListResponse) UnmarshalJSON added in v0.87.0 

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

type AccountActivityListResponseCardTransaction added in v0.87.0 

type AccountActivityListResponseCardTransaction struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// CARD - Card Transaction
	Family AccountActivityListResponseCardTransactionFamily `json:"family,required"`
	// The status of the transaction
	Status AccountActivityListResponseCardTransactionStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time                                      `json:"updated,required" format:"date-time"`
	JSON    accountActivityListResponseCardTransactionJSON `json:"-"`
	Transaction
}

Card transaction with ledger base properties

func (*AccountActivityListResponseCardTransaction) UnmarshalJSON added in v0.87.0 

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

type AccountActivityListResponseCardTransactionFamily added in v0.87.0 

type AccountActivityListResponseCardTransactionFamily string

CARD - Card Transaction 

const (
	AccountActivityListResponseCardTransactionFamilyCard AccountActivityListResponseCardTransactionFamily = "CARD"
)

func (AccountActivityListResponseCardTransactionFamily) IsKnown added in v0.87.0 

func (r AccountActivityListResponseCardTransactionFamily) IsKnown() bool

type AccountActivityListResponseCardTransactionStatus added in v0.87.0 

type AccountActivityListResponseCardTransactionStatus string

The status of the transaction 

const (
	AccountActivityListResponseCardTransactionStatusPending  AccountActivityListResponseCardTransactionStatus = "PENDING"
	AccountActivityListResponseCardTransactionStatusSettled  AccountActivityListResponseCardTransactionStatus = "SETTLED"
	AccountActivityListResponseCardTransactionStatusDeclined AccountActivityListResponseCardTransactionStatus = "DECLINED"
	AccountActivityListResponseCardTransactionStatusReversed AccountActivityListResponseCardTransactionStatus = "REVERSED"
	AccountActivityListResponseCardTransactionStatusCanceled AccountActivityListResponseCardTransactionStatus = "CANCELED"
	AccountActivityListResponseCardTransactionStatusReturned AccountActivityListResponseCardTransactionStatus = "RETURNED"
)

func (AccountActivityListResponseCardTransactionStatus) IsKnown added in v0.87.0 

func (r AccountActivityListResponseCardTransactionStatus) IsKnown() bool

type AccountActivityListResponseCategory added in v0.87.0 

type AccountActivityListResponseCategory string

Transaction category 

const (
	AccountActivityListResponseCategoryACH                    AccountActivityListResponseCategory = "ACH"
	AccountActivityListResponseCategoryBalanceOrFunding       AccountActivityListResponseCategory = "BALANCE_OR_FUNDING"
	AccountActivityListResponseCategoryFee                    AccountActivityListResponseCategory = "FEE"
	AccountActivityListResponseCategoryReward                 AccountActivityListResponseCategory = "REWARD"
	AccountActivityListResponseCategoryAdjustment             AccountActivityListResponseCategory = "ADJUSTMENT"
	AccountActivityListResponseCategoryDerecognition          AccountActivityListResponseCategory = "DERECOGNITION"
	AccountActivityListResponseCategoryDispute                AccountActivityListResponseCategory = "DISPUTE"
	AccountActivityListResponseCategoryCard                   AccountActivityListResponseCategory = "CARD"
	AccountActivityListResponseCategoryExternalACH            AccountActivityListResponseCategory = "EXTERNAL_ACH"
	AccountActivityListResponseCategoryExternalCheck          AccountActivityListResponseCategory = "EXTERNAL_CHECK"
	AccountActivityListResponseCategoryExternalFednow         AccountActivityListResponseCategory = "EXTERNAL_FEDNOW"
	AccountActivityListResponseCategoryExternalRtp            AccountActivityListResponseCategory = "EXTERNAL_RTP"
	AccountActivityListResponseCategoryExternalTransfer       AccountActivityListResponseCategory = "EXTERNAL_TRANSFER"
	AccountActivityListResponseCategoryExternalWire           AccountActivityListResponseCategory = "EXTERNAL_WIRE"
	AccountActivityListResponseCategoryManagementAdjustment   AccountActivityListResponseCategory = "MANAGEMENT_ADJUSTMENT"
	AccountActivityListResponseCategoryManagementDispute      AccountActivityListResponseCategory = "MANAGEMENT_DISPUTE"
	AccountActivityListResponseCategoryManagementFee          AccountActivityListResponseCategory = "MANAGEMENT_FEE"
	AccountActivityListResponseCategoryManagementReward       AccountActivityListResponseCategory = "MANAGEMENT_REWARD"
	AccountActivityListResponseCategoryManagementDisbursement AccountActivityListResponseCategory = "MANAGEMENT_DISBURSEMENT"
	AccountActivityListResponseCategoryProgramFunding         AccountActivityListResponseCategory = "PROGRAM_FUNDING"
	AccountActivityListResponseCategoryInternal               AccountActivityListResponseCategory = "INTERNAL"
	AccountActivityListResponseCategoryTransfer               AccountActivityListResponseCategory = "TRANSFER"
)

func (AccountActivityListResponseCategory) IsKnown added in v0.87.0 

func (r AccountActivityListResponseCategory) IsKnown() bool

type AccountActivityListResponseDirection added in v0.87.0 

type AccountActivityListResponseDirection string

Transfer direction 

const (
	AccountActivityListResponseDirectionCredit AccountActivityListResponseDirection = "CREDIT"
	AccountActivityListResponseDirectionDebit  AccountActivityListResponseDirection = "DEBIT"
)

func (AccountActivityListResponseDirection) IsKnown added in v0.87.0 

func (r AccountActivityListResponseDirection) IsKnown() bool

type AccountActivityListResponseFamily added in v0.87.0 

type AccountActivityListResponseFamily string

INTERNAL - Financial Transaction 

const (
	AccountActivityListResponseFamilyInternal            AccountActivityListResponseFamily = "INTERNAL"
	AccountActivityListResponseFamilyTransfer            AccountActivityListResponseFamily = "TRANSFER"
	AccountActivityListResponseFamilyCard                AccountActivityListResponseFamily = "CARD"
	AccountActivityListResponseFamilyPayment             AccountActivityListResponseFamily = "PAYMENT"
	AccountActivityListResponseFamilyExternalPayment     AccountActivityListResponseFamily = "EXTERNAL_PAYMENT"
	AccountActivityListResponseFamilyManagementOperation AccountActivityListResponseFamily = "MANAGEMENT_OPERATION"
)

func (AccountActivityListResponseFamily) IsKnown added in v0.87.0 

func (r AccountActivityListResponseFamily) IsKnown() bool

type AccountActivityListResponseFinancialTransaction added in v0.87.0 

type AccountActivityListResponseFinancialTransaction struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// Transaction category
	Category AccountActivityListResponseFinancialTransactionCategory `json:"category,required"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// Currency of the transaction, represented in ISO 4217 format
	Currency string `json:"currency,required"`
	// Transaction descriptor
	Descriptor string `json:"descriptor,required"`
	// List of transaction events
	Events []shared.FinancialEvent `json:"events,required"`
	// INTERNAL - Financial Transaction
	Family AccountActivityListResponseFinancialTransactionFamily `json:"family,required"`
	// Financial account token associated with the transaction
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Pending amount in cents
	PendingAmount int64 `json:"pending_amount,required"`
	// Transaction result
	Result AccountActivityListResponseFinancialTransactionResult `json:"result,required"`
	// Settled amount in cents
	SettledAmount int64 `json:"settled_amount,required"`
	// The status of the transaction
	Status AccountActivityListResponseFinancialTransactionStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time                                           `json:"updated,required" format:"date-time"`
	JSON    accountActivityListResponseFinancialTransactionJSON `json:"-"`
}

Financial transaction with inheritance from unified base transaction

func (*AccountActivityListResponseFinancialTransaction) UnmarshalJSON added in v0.87.0 

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

type AccountActivityListResponseFinancialTransactionCategory added in v0.87.0 

type AccountActivityListResponseFinancialTransactionCategory string

Transaction category 

const (
	AccountActivityListResponseFinancialTransactionCategoryACH                    AccountActivityListResponseFinancialTransactionCategory = "ACH"
	AccountActivityListResponseFinancialTransactionCategoryBalanceOrFunding       AccountActivityListResponseFinancialTransactionCategory = "BALANCE_OR_FUNDING"
	AccountActivityListResponseFinancialTransactionCategoryFee                    AccountActivityListResponseFinancialTransactionCategory = "FEE"
	AccountActivityListResponseFinancialTransactionCategoryReward                 AccountActivityListResponseFinancialTransactionCategory = "REWARD"
	AccountActivityListResponseFinancialTransactionCategoryAdjustment             AccountActivityListResponseFinancialTransactionCategory = "ADJUSTMENT"
	AccountActivityListResponseFinancialTransactionCategoryDerecognition          AccountActivityListResponseFinancialTransactionCategory = "DERECOGNITION"
	AccountActivityListResponseFinancialTransactionCategoryDispute                AccountActivityListResponseFinancialTransactionCategory = "DISPUTE"
	AccountActivityListResponseFinancialTransactionCategoryCard                   AccountActivityListResponseFinancialTransactionCategory = "CARD"
	AccountActivityListResponseFinancialTransactionCategoryExternalACH            AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_ACH"
	AccountActivityListResponseFinancialTransactionCategoryExternalCheck          AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_CHECK"
	AccountActivityListResponseFinancialTransactionCategoryExternalFednow         AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_FEDNOW"
	AccountActivityListResponseFinancialTransactionCategoryExternalRtp            AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_RTP"
	AccountActivityListResponseFinancialTransactionCategoryExternalTransfer       AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_TRANSFER"
	AccountActivityListResponseFinancialTransactionCategoryExternalWire           AccountActivityListResponseFinancialTransactionCategory = "EXTERNAL_WIRE"
	AccountActivityListResponseFinancialTransactionCategoryManagementAdjustment   AccountActivityListResponseFinancialTransactionCategory = "MANAGEMENT_ADJUSTMENT"
	AccountActivityListResponseFinancialTransactionCategoryManagementDispute      AccountActivityListResponseFinancialTransactionCategory = "MANAGEMENT_DISPUTE"
	AccountActivityListResponseFinancialTransactionCategoryManagementFee          AccountActivityListResponseFinancialTransactionCategory = "MANAGEMENT_FEE"
	AccountActivityListResponseFinancialTransactionCategoryManagementReward       AccountActivityListResponseFinancialTransactionCategory = "MANAGEMENT_REWARD"
	AccountActivityListResponseFinancialTransactionCategoryManagementDisbursement AccountActivityListResponseFinancialTransactionCategory = "MANAGEMENT_DISBURSEMENT"
	AccountActivityListResponseFinancialTransactionCategoryProgramFunding         AccountActivityListResponseFinancialTransactionCategory = "PROGRAM_FUNDING"
)

func (AccountActivityListResponseFinancialTransactionCategory) IsKnown added in v0.87.0 

func (r AccountActivityListResponseFinancialTransactionCategory) IsKnown() bool

type AccountActivityListResponseFinancialTransactionFamily added in v0.87.0 

type AccountActivityListResponseFinancialTransactionFamily string

INTERNAL - Financial Transaction 

const (
	AccountActivityListResponseFinancialTransactionFamilyInternal AccountActivityListResponseFinancialTransactionFamily = "INTERNAL"
)

func (AccountActivityListResponseFinancialTransactionFamily) IsKnown added in v0.87.0 

func (r AccountActivityListResponseFinancialTransactionFamily) IsKnown() bool

type AccountActivityListResponseFinancialTransactionResult added in v0.87.0 

type AccountActivityListResponseFinancialTransactionResult string

Transaction result 

const (
	AccountActivityListResponseFinancialTransactionResultApproved AccountActivityListResponseFinancialTransactionResult = "APPROVED"
	AccountActivityListResponseFinancialTransactionResultDeclined AccountActivityListResponseFinancialTransactionResult = "DECLINED"
)

func (AccountActivityListResponseFinancialTransactionResult) IsKnown added in v0.87.0 

func (r AccountActivityListResponseFinancialTransactionResult) IsKnown() bool

type AccountActivityListResponseFinancialTransactionStatus added in v0.87.0 

type AccountActivityListResponseFinancialTransactionStatus string

The status of the transaction 

const (
	AccountActivityListResponseFinancialTransactionStatusPending  AccountActivityListResponseFinancialTransactionStatus = "PENDING"
	AccountActivityListResponseFinancialTransactionStatusSettled  AccountActivityListResponseFinancialTransactionStatus = "SETTLED"
	AccountActivityListResponseFinancialTransactionStatusDeclined AccountActivityListResponseFinancialTransactionStatus = "DECLINED"
	AccountActivityListResponseFinancialTransactionStatusReversed AccountActivityListResponseFinancialTransactionStatus = "REVERSED"
	AccountActivityListResponseFinancialTransactionStatusCanceled AccountActivityListResponseFinancialTransactionStatus = "CANCELED"
	AccountActivityListResponseFinancialTransactionStatusReturned AccountActivityListResponseFinancialTransactionStatus = "RETURNED"
)

func (AccountActivityListResponseFinancialTransactionStatus) IsKnown added in v0.87.0 

func (r AccountActivityListResponseFinancialTransactionStatus) IsKnown() bool

type AccountActivityListResponseMethod added in v0.87.0 

type AccountActivityListResponseMethod string

Transfer method 

const (
	AccountActivityListResponseMethodACHNextDay AccountActivityListResponseMethod = "ACH_NEXT_DAY"
	AccountActivityListResponseMethodACHSameDay AccountActivityListResponseMethod = "ACH_SAME_DAY"
	AccountActivityListResponseMethodWire       AccountActivityListResponseMethod = "WIRE"
)

func (AccountActivityListResponseMethod) IsKnown added in v0.87.0 

func (r AccountActivityListResponseMethod) IsKnown() bool

type AccountActivityListResponseNetwork added in v0.87.0 

type AccountActivityListResponseNetwork string

Card network of the authorization. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider. 

const (
	AccountActivityListResponseNetworkAmex       AccountActivityListResponseNetwork = "AMEX"
	AccountActivityListResponseNetworkInterlink  AccountActivityListResponseNetwork = "INTERLINK"
	AccountActivityListResponseNetworkMaestro    AccountActivityListResponseNetwork = "MAESTRO"
	AccountActivityListResponseNetworkMastercard AccountActivityListResponseNetwork = "MASTERCARD"
	AccountActivityListResponseNetworkUnknown    AccountActivityListResponseNetwork = "UNKNOWN"
	AccountActivityListResponseNetworkVisa       AccountActivityListResponseNetwork = "VISA"
)

func (AccountActivityListResponseNetwork) IsKnown added in v0.87.0 

func (r AccountActivityListResponseNetwork) IsKnown() bool

type AccountActivityListResponsePaymentType added in v0.87.0 

type AccountActivityListResponsePaymentType string
const (
	AccountActivityListResponsePaymentTypeDeposit    AccountActivityListResponsePaymentType = "DEPOSIT"
	AccountActivityListResponsePaymentTypeWithdrawal AccountActivityListResponsePaymentType = "WITHDRAWAL"
)

func (AccountActivityListResponsePaymentType) IsKnown added in v0.87.0 

func (r AccountActivityListResponsePaymentType) IsKnown() bool

type AccountActivityListResponseResult added in v0.87.0 

type AccountActivityListResponseResult string

Transaction result 

const (
	AccountActivityListResponseResultApproved                    AccountActivityListResponseResult = "APPROVED"
	AccountActivityListResponseResultDeclined                    AccountActivityListResponseResult = "DECLINED"
	AccountActivityListResponseResultAccountPaused               AccountActivityListResponseResult = "ACCOUNT_PAUSED"
	AccountActivityListResponseResultAccountStateTransactionFail AccountActivityListResponseResult = "ACCOUNT_STATE_TRANSACTION_FAIL"
	AccountActivityListResponseResultBankConnectionError         AccountActivityListResponseResult = "BANK_CONNECTION_ERROR"
	AccountActivityListResponseResultBankNotVerified             AccountActivityListResponseResult = "BANK_NOT_VERIFIED"
	AccountActivityListResponseResultCardClosed                  AccountActivityListResponseResult = "CARD_CLOSED"
	AccountActivityListResponseResultCardPaused                  AccountActivityListResponseResult = "CARD_PAUSED"
	AccountActivityListResponseResultFraudAdvice                 AccountActivityListResponseResult = "FRAUD_ADVICE"
	AccountActivityListResponseResultIgnoredTtlExpiry            AccountActivityListResponseResult = "IGNORED_TTL_EXPIRY"
	AccountActivityListResponseResultSuspectedFraud              AccountActivityListResponseResult = "SUSPECTED_FRAUD"
	AccountActivityListResponseResultInactiveAccount             AccountActivityListResponseResult = "INACTIVE_ACCOUNT"
	AccountActivityListResponseResultIncorrectPin                AccountActivityListResponseResult = "INCORRECT_PIN"
	AccountActivityListResponseResultInvalidCardDetails          AccountActivityListResponseResult = "INVALID_CARD_DETAILS"
	AccountActivityListResponseResultInsufficientFunds           AccountActivityListResponseResult = "INSUFFICIENT_FUNDS"
	AccountActivityListResponseResultInsufficientFundsPreload    AccountActivityListResponseResult = "INSUFFICIENT_FUNDS_PRELOAD"
	AccountActivityListResponseResultInvalidTransaction          AccountActivityListResponseResult = "INVALID_TRANSACTION"
	AccountActivityListResponseResultMerchantBlacklist           AccountActivityListResponseResult = "MERCHANT_BLACKLIST"
	AccountActivityListResponseResultOriginalNotFound            AccountActivityListResponseResult = "ORIGINAL_NOT_FOUND"
	AccountActivityListResponseResultPreviouslyCompleted         AccountActivityListResponseResult = "PREVIOUSLY_COMPLETED"
	AccountActivityListResponseResultSingleUseRecharged          AccountActivityListResponseResult = "SINGLE_USE_RECHARGED"
	AccountActivityListResponseResultSwitchInoperativeAdvice     AccountActivityListResponseResult = "SWITCH_INOPERATIVE_ADVICE"
	AccountActivityListResponseResultUnauthorizedMerchant        AccountActivityListResponseResult = "UNAUTHORIZED_MERCHANT"
	AccountActivityListResponseResultUnknownHostTimeout          AccountActivityListResponseResult = "UNKNOWN_HOST_TIMEOUT"
	AccountActivityListResponseResultUserTransactionLimit        AccountActivityListResponseResult = "USER_TRANSACTION_LIMIT"
)

func (AccountActivityListResponseResult) IsKnown added in v0.87.0 

func (r AccountActivityListResponseResult) IsKnown() bool

type AccountActivityListResponseSource added in v0.87.0 

type AccountActivityListResponseSource string

Transaction source 

const (
	AccountActivityListResponseSourceLithic   AccountActivityListResponseSource = "LITHIC"
	AccountActivityListResponseSourceExternal AccountActivityListResponseSource = "EXTERNAL"
	AccountActivityListResponseSourceCustomer AccountActivityListResponseSource = "CUSTOMER"
)

func (AccountActivityListResponseSource) IsKnown added in v0.87.0 

func (r AccountActivityListResponseSource) IsKnown() bool

type AccountActivityListResponseStatus added in v0.87.0 

type AccountActivityListResponseStatus string

The status of the transaction 

const (
	AccountActivityListResponseStatusPending  AccountActivityListResponseStatus = "PENDING"
	AccountActivityListResponseStatusSettled  AccountActivityListResponseStatus = "SETTLED"
	AccountActivityListResponseStatusDeclined AccountActivityListResponseStatus = "DECLINED"
	AccountActivityListResponseStatusReversed AccountActivityListResponseStatus = "REVERSED"
	AccountActivityListResponseStatusCanceled AccountActivityListResponseStatus = "CANCELED"
	AccountActivityListResponseStatusReturned AccountActivityListResponseStatus = "RETURNED"
	AccountActivityListResponseStatusExpired  AccountActivityListResponseStatus = "EXPIRED"
	AccountActivityListResponseStatusVoided   AccountActivityListResponseStatus = "VOIDED"
)

func (AccountActivityListResponseStatus) IsKnown added in v0.87.0 

func (r AccountActivityListResponseStatus) IsKnown() bool

type AccountActivityListResponseType added in v0.90.0 

type AccountActivityListResponseType string
const (
	AccountActivityListResponseTypeOriginationCredit   AccountActivityListResponseType = "ORIGINATION_CREDIT"
	AccountActivityListResponseTypeOriginationDebit    AccountActivityListResponseType = "ORIGINATION_DEBIT"
	AccountActivityListResponseTypeReceiptCredit       AccountActivityListResponseType = "RECEIPT_CREDIT"
	AccountActivityListResponseTypeReceiptDebit        AccountActivityListResponseType = "RECEIPT_DEBIT"
	AccountActivityListResponseTypeWireInboundPayment  AccountActivityListResponseType = "WIRE_INBOUND_PAYMENT"
	AccountActivityListResponseTypeWireInboundAdmin    AccountActivityListResponseType = "WIRE_INBOUND_ADMIN"
	AccountActivityListResponseTypeWireOutboundPayment AccountActivityListResponseType = "WIRE_OUTBOUND_PAYMENT"
	AccountActivityListResponseTypeWireOutboundAdmin   AccountActivityListResponseType = "WIRE_OUTBOUND_ADMIN"
	AccountActivityListResponseTypeWireDrawdownRequest AccountActivityListResponseType = "WIRE_DRAWDOWN_REQUEST"
)

func (AccountActivityListResponseType) IsKnown added in v0.90.0 

func (r AccountActivityListResponseType) IsKnown() bool

type AccountActivityListResponseUnion added in v0.87.0 

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

Response containing multiple transaction types. The `family` field determines which transaction type is returned: INTERNAL returns FinancialTransaction, TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse, and MANAGEMENT_OPERATION returns ManagementOperationTransaction

Union satisfied by AccountActivityListResponseFinancialTransaction, BookTransferResponse, AccountActivityListResponseCardTransaction, Payment, ExternalPayment or ManagementOperationTransaction.

type AccountActivityService added in v0.87.0 

type AccountActivityService struct {
	Options []option.RequestOption
}

AccountActivityService 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 NewAccountActivityService method instead.

func NewAccountActivityService added in v0.87.0 

func NewAccountActivityService(opts ...option.RequestOption) (r *AccountActivityService)

NewAccountActivityService 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 (*AccountActivityService) GetTransaction added in v0.87.0 

func (r *AccountActivityService) GetTransaction(ctx context.Context, transactionToken string, opts ...option.RequestOption) (res *AccountActivityGetTransactionResponse, err error)

Retrieve a single transaction

func (*AccountActivityService) List added in v0.87.0 

func (r *AccountActivityService) List(ctx context.Context, query AccountActivityListParams, opts ...option.RequestOption) (res *pagination.CursorPage[AccountActivityListResponse], err error)

Retrieve a list of transactions across all public accounts.

func (*AccountActivityService) ListAutoPaging added in v0.87.0 

func (r *AccountActivityService) ListAutoPaging(ctx context.Context, query AccountActivityListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[AccountActivityListResponse]

Retrieve a list of transactions across all public accounts.

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"`
	// Deprecated.
	//
	// Deprecated: deprecated
	BeneficialOwnerEntities []AccountHolderBeneficialOwnerEntity `json:"beneficial_owner_entities"`
	// Only present when user_type == "BUSINESS". You must submit a list of all direct
	// and indirect individuals with 25% or more ownership in the company. A maximum of
	// 4 beneficial owners can be submitted. If no individual owns 25% of the company
	// you do not need to send beneficial owner information. 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.
	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"`
	// 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"`
	// (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" workflow. 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_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", "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"`
	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 AccountHolderCreatedWebhookEvent added in v0.98.0 

type AccountHolderCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType AccountHolderCreatedWebhookEventEventType `json:"event_type,required"`
	// The token of the account_holder that was created.
	Token string `json:"token" format:"uuid"`
	// The token of the account that was created.
	AccountToken string `json:"account_token" format:"uuid"`
	// When the account_holder was created
	Created           time.Time          `json:"created" format:"date-time"`
	RequiredDocuments []RequiredDocument `json:"required_documents"`
	// The status of the account_holder that was created.
	Status       AccountHolderCreatedWebhookEventStatus `json:"status"`
	StatusReason []string                               `json:"status_reason"`
	JSON         accountHolderCreatedWebhookEventJSON   `json:"-"`
}

func (*AccountHolderCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type AccountHolderCreatedWebhookEventEventType added in v0.98.0 

type AccountHolderCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	AccountHolderCreatedWebhookEventEventTypeAccountHolderCreated AccountHolderCreatedWebhookEventEventType = "account_holder.created"
)

func (AccountHolderCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r AccountHolderCreatedWebhookEventEventType) IsKnown() bool

type AccountHolderCreatedWebhookEventStatus added in v0.98.0 

type AccountHolderCreatedWebhookEventStatus string

The status of the account_holder that was created. 

const (
	AccountHolderCreatedWebhookEventStatusAccepted      AccountHolderCreatedWebhookEventStatus = "ACCEPTED"
	AccountHolderCreatedWebhookEventStatusPendingReview AccountHolderCreatedWebhookEventStatus = "PENDING_REVIEW"
)

func (AccountHolderCreatedWebhookEventStatus) IsKnown added in v0.98.0 

func (r AccountHolderCreatedWebhookEventStatus) IsKnown() bool

type AccountHolderDocumentUpdatedWebhookEvent added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType AccountHolderDocumentUpdatedWebhookEventEventType `json:"event_type,required"`
	// The token of the account holder document
	Token string `json:"token" format:"uuid"`
	// The token of the account_holder that the document belongs to
	AccountHolderToken string `json:"account_holder_token" format:"uuid"`
	// When the account_holder was created
	Created time.Time `json:"created" format:"date-time"`
	// Type of documentation to be submitted for verification of an account holder
	DocumentType AccountHolderDocumentUpdatedWebhookEventDocumentType `json:"document_type"`
	// The token of the entity that the document belongs to
	EntityToken             string                                                           `json:"entity_token" format:"uuid"`
	RequiredDocumentUploads []AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUpload `json:"required_document_uploads"`
	JSON                    accountHolderDocumentUpdatedWebhookEventJSON                     `json:"-"`
}

func (*AccountHolderDocumentUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type AccountHolderDocumentUpdatedWebhookEventDocumentType added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEventDocumentType string

Type of documentation to be submitted for verification of an account holder 

const (
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeDriversLicense            AccountHolderDocumentUpdatedWebhookEventDocumentType = "DRIVERS_LICENSE"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypePassport                  AccountHolderDocumentUpdatedWebhookEventDocumentType = "PASSPORT"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypePassportCard              AccountHolderDocumentUpdatedWebhookEventDocumentType = "PASSPORT_CARD"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeEinLetter                 AccountHolderDocumentUpdatedWebhookEventDocumentType = "EIN_LETTER"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeTaxReturn                 AccountHolderDocumentUpdatedWebhookEventDocumentType = "TAX_RETURN"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeOperatingAgreement        AccountHolderDocumentUpdatedWebhookEventDocumentType = "OPERATING_AGREEMENT"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeCertificateOfFormation    AccountHolderDocumentUpdatedWebhookEventDocumentType = "CERTIFICATE_OF_FORMATION"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeCertificateOfGoodStanding AccountHolderDocumentUpdatedWebhookEventDocumentType = "CERTIFICATE_OF_GOOD_STANDING"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeArticlesOfIncorporation   AccountHolderDocumentUpdatedWebhookEventDocumentType = "ARTICLES_OF_INCORPORATION"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeArticlesOfOrganization    AccountHolderDocumentUpdatedWebhookEventDocumentType = "ARTICLES_OF_ORGANIZATION"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeBylaws                    AccountHolderDocumentUpdatedWebhookEventDocumentType = "BYLAWS"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeGovernmentBusinessLicense AccountHolderDocumentUpdatedWebhookEventDocumentType = "GOVERNMENT_BUSINESS_LICENSE"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypePartnershipAgreement      AccountHolderDocumentUpdatedWebhookEventDocumentType = "PARTNERSHIP_AGREEMENT"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeSs4Form                   AccountHolderDocumentUpdatedWebhookEventDocumentType = "SS4_FORM"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeBankStatement             AccountHolderDocumentUpdatedWebhookEventDocumentType = "BANK_STATEMENT"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeUtilityBillStatement      AccountHolderDocumentUpdatedWebhookEventDocumentType = "UTILITY_BILL_STATEMENT"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeSsnCard                   AccountHolderDocumentUpdatedWebhookEventDocumentType = "SSN_CARD"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeItinLetter                AccountHolderDocumentUpdatedWebhookEventDocumentType = "ITIN_LETTER"
	AccountHolderDocumentUpdatedWebhookEventDocumentTypeFincenBoiReport           AccountHolderDocumentUpdatedWebhookEventDocumentType = "FINCEN_BOI_REPORT"
)

func (AccountHolderDocumentUpdatedWebhookEventDocumentType) IsKnown added in v0.98.0 

func (r AccountHolderDocumentUpdatedWebhookEventDocumentType) IsKnown() bool

type AccountHolderDocumentUpdatedWebhookEventEventType added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	AccountHolderDocumentUpdatedWebhookEventEventTypeAccountHolderDocumentUpdated AccountHolderDocumentUpdatedWebhookEventEventType = "account_holder_document.updated"
)

func (AccountHolderDocumentUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r AccountHolderDocumentUpdatedWebhookEventEventType) IsKnown() bool

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUpload added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUpload struct {
	// The token of the document upload
	Token                       string   `json:"token" format:"uuid"`
	AcceptedEntityStatusReasons []string `json:"accepted_entity_status_reasons"`
	// When the document upload was created
	Created time.Time `json:"created" format:"date-time"`
	// The type of image that was uploaded
	ImageType                   AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType `json:"image_type"`
	RejectedEntityStatusReasons []string                                                                 `json:"rejected_entity_status_reasons"`
	// The status of the document upload
	Status        AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus `json:"status"`
	StatusReasons []string                                                              `json:"status_reasons"`
	// When the document upload was last updated
	Updated time.Time                                                          `json:"updated" format:"date-time"`
	JSON    accountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadJSON `json:"-"`
}

A document upload that belongs to the overall account holder document

func (*AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUpload) UnmarshalJSON added in v0.98.0 

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

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType string

The type of image that was uploaded 

const (
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageTypeFront AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType = "FRONT"
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageTypeBack  AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType = "BACK"
)

func (AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType) IsKnown added in v0.98.0 

func (r AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsImageType) IsKnown() bool

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus added in v0.98.0 

type AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus string

The status of the document upload 

const (
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatusAccepted        AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus = "ACCEPTED"
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatusRejected        AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus = "REJECTED"
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatusPendingUpload   AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus = "PENDING_UPLOAD"
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatusUploaded        AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus = "UPLOADED"
	AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatusPartialApproval AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus = "PARTIAL_APPROVAL"
)

func (AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus) IsKnown added in v0.98.0 

func (r AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUploadsStatus) IsKnown() bool

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 {
	// 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 KYB 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, entered in E.164 format.
	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"`
	// Specifies the type of KYB workflow to run.
	Workflow param.Field[AccountHolderNewParamsBodyWorkflow] `json:"workflow"`
}

func (AccountHolderNewParamsBody) MarshalJSON added in v0.29.0 

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

type AccountHolderNewParamsBodyKYBDelegated added in v0.90.0 

type AccountHolderNewParamsBodyKYBDelegated struct {
	// Information for business for which the account is being opened.
	BusinessEntity param.Field[AccountHolderNewParamsBodyKYBDelegatedBusinessEntity] `json:"business_entity,required"`
	// You can submit a list of all direct and indirect individuals with 25% or more
	// ownership in the company. A maximum of 4 beneficial owners can be submitted. If
	// no individual owns 25% of the company you do not need to send beneficial owner
	// information. 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.
	BeneficialOwnerIndividuals param.Field[[]AccountHolderNewParamsBodyKYBDelegatedBeneficialOwnerIndividual] `json:"beneficial_owner_individuals"`
	// 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[AccountHolderNewParamsBodyKYBDelegatedControlPerson] `json:"control_person"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness param.Field[string] `json:"nature_of_business"`
	// 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"`
	// Specifies the type of KYB workflow to run.
	Workflow param.Field[AccountHolderNewParamsBodyKYBDelegatedWorkflow] `json:"workflow"`
}

func (AccountHolderNewParamsBodyKYBDelegated) MarshalJSON added in v0.90.0 

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

type AccountHolderNewParamsBodyKYBDelegatedBeneficialOwnerIndividual added in v0.90.0 

type AccountHolderNewParamsBodyKYBDelegatedBeneficialOwnerIndividual 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 (AccountHolderNewParamsBodyKYBDelegatedBeneficialOwnerIndividual) MarshalJSON added in v0.90.0 

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

type AccountHolderNewParamsBodyKYBDelegatedBusinessEntity added in v0.90.0 

type AccountHolderNewParamsBodyKYBDelegatedBusinessEntity 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"`
	// Legal (formal) business name.
	LegalBusinessName param.Field[string] `json:"legal_business_name,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"`
	// 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"`
	// Parent company name (if applicable).
	ParentCompany param.Field[string] `json:"parent_company"`
	// 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"`
}

Information for business for which the account is being opened.

func (AccountHolderNewParamsBodyKYBDelegatedBusinessEntity) MarshalJSON added in v0.90.0 

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

type AccountHolderNewParamsBodyKYBDelegatedControlPerson added in v0.90.0 

type AccountHolderNewParamsBodyKYBDelegatedControlPerson 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 (AccountHolderNewParamsBodyKYBDelegatedControlPerson) MarshalJSON added in v0.90.0 

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

type AccountHolderNewParamsBodyKYBDelegatedWorkflow added in v0.90.0 

type AccountHolderNewParamsBodyKYBDelegatedWorkflow string

Specifies the type of KYB workflow to run. 

const (
	AccountHolderNewParamsBodyKYBDelegatedWorkflowKYBDelegated AccountHolderNewParamsBodyKYBDelegatedWorkflow = "KYB_DELEGATED"
)

func (AccountHolderNewParamsBodyKYBDelegatedWorkflow) IsKnown added in v0.90.0 

func (r AccountHolderNewParamsBodyKYBDelegatedWorkflow) IsKnown() bool

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, AccountHolderNewParamsBodyKYBDelegated, 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"
	AccountHolderNewParamsBodyWorkflowKYBDelegated AccountHolderNewParamsBodyWorkflow = "KYB_DELEGATED"
	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_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"`
	// Only present for "KYB_BASIC" workflow. 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_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 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)

Create an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is successfully created an associated account is also created. All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation 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) 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`.

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 (including business owners and control persons associated to a business account). If Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required). All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on existing accounts that are part of the program that the calling API key manages.

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"`
	// Deprecated.
	BeneficialOwnerEntities []KYBBusinessEntity `json:"beneficial_owner_entities"`
	// Only present when user_type == "BUSINESS". You must submit a list of all direct
	// and indirect individuals with 25% or more ownership in the company. A maximum of
	// 4 beneficial owners can be submitted. If no individual owns 25% of the company
	// you do not need to send beneficial owner information. 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.
	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,nullable" 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 KYBBusinessEntity `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"`
	// 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"`
	// (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", "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"`
	JSON       accountHolderSimulateEnrollmentReviewResponseJSON `json:"-"`
}

func (*AccountHolderSimulateEnrollmentReviewResponse) UnmarshalJSON added in v0.41.0 

func (r *AccountHolderSimulateEnrollmentReviewResponse) 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 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", "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"`
	// Timestamp of when the application passed the verification process. Only present
	// if `status` is `ACCEPTED`
	KyPassedAt time.Time                                                                `json:"ky_passed_at" 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_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 {
	// The KYB request payload for updating a business.
	Body AccountHolderUpdateParamsBodyUnion `json:"body,required"`
}

func (AccountHolderUpdateParams) MarshalJSON 

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

type AccountHolderUpdateParamsBody added in v0.68.0 

type AccountHolderUpdateParamsBody struct {
	// Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
	Address                    param.Field[AddressUpdateParam] `json:"address"`
	BeneficialOwnerEntities    param.Field[interface{}]        `json:"beneficial_owner_entities"`
	BeneficialOwnerIndividuals param.Field[interface{}]        `json:"beneficial_owner_individuals"`
	// Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
	// account holder is associated.
	BusinessAccountToken param.Field[string]      `json:"business_account_token"`
	BusinessEntity       param.Field[interface{}] `json:"business_entity"`
	ControlPerson        param.Field[interface{}] `json:"control_person"`
	// Allowed for all Account Holders. 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"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
	FirstName  param.Field[string]      `json:"first_name"`
	Individual param.Field[interface{}] `json:"individual"`
	// Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
	LastName param.Field[string] `json:"last_name"`
	// Allowed for BYO-KYB. Legal business name of the account holder.
	LegalBusinessName param.Field[string] `json:"legal_business_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"`
	// Allowed for all Account Holders. 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"`
	// Company website URL.
	WebsiteURL param.Field[string] `json:"website_url"`
}

The KYB request payload for updating a business.

func (AccountHolderUpdateParamsBody) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYBPatchRequest added in v0.68.0 

type AccountHolderUpdateParamsBodyKYBPatchRequest struct {
	// Deprecated.
	//
	// Deprecated: deprecated
	BeneficialOwnerEntities param.Field[[]AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerEntity] `json:"beneficial_owner_entities"`
	// You must submit a list of all direct and indirect individuals with 25% or more
	// ownership in the company. A maximum of 4 beneficial owners can be submitted. If
	// no individual owns 25% of the company you do not need to send beneficial owner
	// information. 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.
	BeneficialOwnerIndividuals param.Field[[]AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerIndividual] `json:"beneficial_owner_individuals"`
	// Information for business for which the account is being opened and KYB is being
	// run.
	BusinessEntity param.Field[AccountHolderUpdateParamsBodyKYBPatchRequestBusinessEntity] `json:"business_entity"`
	// 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[AccountHolderUpdateParamsBodyKYBPatchRequestControlPerson] `json:"control_person"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness param.Field[string] `json:"nature_of_business"`
	// Company website URL.
	WebsiteURL param.Field[string] `json:"website_url"`
}

The KYB request payload for updating a business.

func (AccountHolderUpdateParamsBodyKYBPatchRequest) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerEntity added in v0.68.0 

type AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerEntity struct {
	// Globally unique identifier for an entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
	// Business”s physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address param.Field[AddressUpdateParam] `json:"address"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName param.Field[string] `json:"dba_business_name"`
	// 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"`
	// Legal (formal) business name.
	LegalBusinessName param.Field[string] `json:"legal_business_name"`
	// Parent company name (if applicable).
	ParentCompany param.Field[string] `json:"parent_company"`
	// 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"`
}

func (AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerEntity) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerIndividual added in v0.68.0 

type AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerIndividual struct {
	// Globally unique identifier for an entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
	// 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[AddressUpdateParam] `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[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 param.Field[string] `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name"`
	// 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"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name"`
	// 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 (AccountHolderUpdateParamsBodyKYBPatchRequestBeneficialOwnerIndividual) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYBPatchRequestBusinessEntity added in v0.68.0 

type AccountHolderUpdateParamsBodyKYBPatchRequestBusinessEntity struct {
	// Globally unique identifier for an entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
	// Business”s physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address param.Field[AddressUpdateParam] `json:"address"`
	// Any name that the business operates under that is not its legal business name
	// (if applicable).
	DbaBusinessName param.Field[string] `json:"dba_business_name"`
	// 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"`
	// Legal (formal) business name.
	LegalBusinessName param.Field[string] `json:"legal_business_name"`
	// Parent company name (if applicable).
	ParentCompany param.Field[string] `json:"parent_company"`
	// 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"`
}

Information for business for which the account is being opened and KYB is being run.

func (AccountHolderUpdateParamsBodyKYBPatchRequestBusinessEntity) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYBPatchRequestControlPerson added in v0.68.0 

type AccountHolderUpdateParamsBodyKYBPatchRequestControlPerson struct {
	// Globally unique identifier for an entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
	// 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[AddressUpdateParam] `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[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 param.Field[string] `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name"`
	// 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"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name"`
	// 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 (AccountHolderUpdateParamsBodyKYBPatchRequestControlPerson) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYCPatchRequest added in v0.68.0 

type AccountHolderUpdateParamsBodyKYCPatchRequest struct {
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// Information on the individual for whom the account is being opened and KYC is
	// being run.
	Individual param.Field[AccountHolderUpdateParamsBodyKYCPatchRequestIndividual] `json:"individual"`
}

The KYC request payload for updating an account holder.

func (AccountHolderUpdateParamsBodyKYCPatchRequest) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyKYCPatchRequestIndividual added in v0.68.0 

type AccountHolderUpdateParamsBodyKYCPatchRequestIndividual struct {
	// Globally unique identifier for an entity.
	EntityToken param.Field[string] `json:"entity_token,required" format:"uuid"`
	// 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[AddressUpdateParam] `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob param.Field[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 param.Field[string] `json:"email"`
	// Individual's first name, as it appears on government-issued identity documents.
	FirstName param.Field[string] `json:"first_name"`
	// 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"`
	// Individual's last name, as it appears on government-issued identity documents.
	LastName param.Field[string] `json:"last_name"`
	// Individual's phone number, entered in E.164 format.
	PhoneNumber param.Field[string] `json:"phone_number"`
}

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

func (AccountHolderUpdateParamsBodyKYCPatchRequestIndividual) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyPatchRequest added in v0.68.0 

type AccountHolderUpdateParamsBodyPatchRequest struct {
	// Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
	Address param.Field[AddressUpdateParam] `json:"address"`
	// Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
	// account holder is associated.
	BusinessAccountToken param.Field[string] `json:"business_account_token"`
	// Allowed for all Account Holders. 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"`
	// Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
	FirstName param.Field[string] `json:"first_name"`
	// Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
	LastName param.Field[string] `json:"last_name"`
	// Allowed for BYO-KYB. Legal business name of the account holder.
	LegalBusinessName param.Field[string] `json:"legal_business_name"`
	// Allowed for all Account Holders. 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"`
}

The legacy request for updating an account holder.

func (AccountHolderUpdateParamsBodyPatchRequest) MarshalJSON added in v0.68.0 

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

type AccountHolderUpdateParamsBodyUnion added in v0.68.0 

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

The KYB request payload for updating a business.

Satisfied by AccountHolderUpdateParamsBodyKYBPatchRequest, AccountHolderUpdateParamsBodyKYCPatchRequest, AccountHolderUpdateParamsBodyPatchRequest, AccountHolderUpdateParamsBody.

type AccountHolderUpdateResponse 

type AccountHolderUpdateResponse 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"`
	// This field can have the runtime type of
	// [AccountHolderUpdateResponsePatchResponseAddress].
	Address interface{} `json:"address"`
	// This field can have the runtime type of [[]KYBBusinessEntity].
	BeneficialOwnerEntities interface{} `json:"beneficial_owner_entities"`
	// This field can have the runtime type of
	// [[]AccountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividual].
	BeneficialOwnerIndividuals 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 string `json:"business_account_token,nullable" 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 KYBBusinessEntity `json:"business_entity"`
	// This field can have the runtime type of
	// [AccountHolderUpdateResponseKYBKYCPatchResponseControlPerson].
	ControlPerson interface{} `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 AccountHolderUpdateResponseExemptionType `json:"exemption_type"`
	// Customer-provided token that indicates a relationship with an object outside of
	// the Lithic ecosystem.
	ExternalID string `json:"external_id"`
	// The first name for the account holder
	FirstName string `json:"first_name"`
	// This field can have the runtime type of
	// [AccountHolderUpdateResponseKYBKYCPatchResponseIndividual].
	Individual interface{} `json:"individual"`
	// The last name for the account holder
	LastName string `json:"last_name"`
	// The legal business name for the account holder
	LegalBusinessName string `json:"legal_business_name"`
	// Only present when user_type == "BUSINESS". User-submitted description of the
	// business.
	NatureOfBusiness string `json:"nature_of_business"`
	// (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"`
	// This field can have the runtime type of [[]RequiredDocument].
	RequiredDocuments interface{} `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 AccountHolderUpdateResponseStatus `json:"status"`
	// This field can have the runtime type of
	// [[]AccountHolderUpdateResponseKybkycPatchResponseStatusReason].
	StatusReasons interface{} `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", "nature_of_business", and "website_url"
	// attributes will be present.
	UserType AccountHolderUpdateResponseUserType `json:"user_type"`
	// This field can have the runtime type of
	// [AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplication].
	VerificationApplication interface{} `json:"verification_application"`
	// Only present when user_type == "BUSINESS". Business's primary website.
	WebsiteURL string                          `json:"website_url"`
	JSON       accountHolderUpdateResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (AccountHolderUpdateResponse) AsUnion added in v0.68.0 

func (r AccountHolderUpdateResponse) AsUnion() AccountHolderUpdateResponseUnion

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

Possible runtime types of the union are AccountHolderUpdateResponseKYBKYCPatchResponse, AccountHolderUpdateResponsePatchResponse.

func (*AccountHolderUpdateResponse) UnmarshalJSON 

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

type AccountHolderUpdateResponseExemptionType added in v0.68.0 

type AccountHolderUpdateResponseExemptionType string

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

const (
	AccountHolderUpdateResponseExemptionTypeAuthorizedUser  AccountHolderUpdateResponseExemptionType = "AUTHORIZED_USER"
	AccountHolderUpdateResponseExemptionTypePrepaidCardUser AccountHolderUpdateResponseExemptionType = "PREPAID_CARD_USER"
)

func (AccountHolderUpdateResponseExemptionType) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseExemptionType) IsKnown() bool

type AccountHolderUpdateResponseKYBKYCPatchResponse added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponse 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"`
	// Deprecated.
	BeneficialOwnerEntities []KYBBusinessEntity `json:"beneficial_owner_entities"`
	// Only present when user_type == "BUSINESS". You must submit a list of all direct
	// and indirect individuals with 25% or more ownership in the company. A maximum of
	// 4 beneficial owners can be submitted. If no individual owns 25% of the company
	// you do not need to send beneficial owner information. 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.
	BeneficialOwnerIndividuals []AccountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividual `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,nullable" 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 KYBBusinessEntity `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 AccountHolderUpdateResponseKYBKYCPatchResponseControlPerson `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 AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType `json:"exemption_type"`
	// Customer-provided token that indicates a relationship with an object outside of
	// the Lithic ecosystem.
	ExternalID string `json:"external_id"`
	// Only present when user_type == "INDIVIDUAL". Information about the individual
	// for which the account is being opened and KYC is being run.
	Individual AccountHolderUpdateResponseKYBKYCPatchResponseIndividual `json:"individual"`
	// Only present when user_type == "BUSINESS". User-submitted description of the
	// business.
	NatureOfBusiness string `json:"nature_of_business"`
	// (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 AccountHolderUpdateResponseKYBKYCPatchResponseStatus `json:"status"`
	// (Deprecated. Use verification_application.status_reasons) Reason for the
	// evaluation status.
	StatusReasons []AccountHolderUpdateResponseKybkycPatchResponseStatusReason `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", "nature_of_business", and "website_url"
	// attributes will be present.
	UserType AccountHolderUpdateResponseKYBKYCPatchResponseUserType `json:"user_type"`
	// Information about the most recent identity verification attempt
	VerificationApplication AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplication `json:"verification_application"`
	// Only present when user_type == "BUSINESS". Business's primary website.
	WebsiteURL string                                             `json:"website_url"`
	JSON       accountHolderUpdateResponseKybkycPatchResponseJSON `json:"-"`
}

func (*AccountHolderUpdateResponseKYBKYCPatchResponse) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseBeneficialOwnerIndividualsAddress added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseBeneficialOwnerIndividualsAddress 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     accountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividualsAddressJSON `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 (*AccountHolderUpdateResponseKYBKYCPatchResponseBeneficialOwnerIndividualsAddress) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseControlPerson added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseControlPerson 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 AccountHolderUpdateResponseKYBKYCPatchResponseControlPersonAddress `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        accountHolderUpdateResponseKybkycPatchResponseControlPersonJSON `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 (*AccountHolderUpdateResponseKYBKYCPatchResponseControlPerson) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseControlPersonAddress added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseControlPersonAddress 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     accountHolderUpdateResponseKybkycPatchResponseControlPersonAddressJSON `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 (*AccountHolderUpdateResponseKYBKYCPatchResponseControlPersonAddress) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType string

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

const (
	AccountHolderUpdateResponseKYBKYCPatchResponseExemptionTypeAuthorizedUser  AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType = "AUTHORIZED_USER"
	AccountHolderUpdateResponseKYBKYCPatchResponseExemptionTypePrepaidCardUser AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType = "PREPAID_CARD_USER"
)

func (AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKYBKYCPatchResponseExemptionType) IsKnown() bool

type AccountHolderUpdateResponseKYBKYCPatchResponseIndividual added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseIndividual 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 AccountHolderUpdateResponseKYBKYCPatchResponseIndividualAddress `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        accountHolderUpdateResponseKybkycPatchResponseIndividualJSON `json:"-"`
}

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

func (*AccountHolderUpdateResponseKYBKYCPatchResponseIndividual) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseIndividualAddress added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseIndividualAddress 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     accountHolderUpdateResponseKybkycPatchResponseIndividualAddressJSON `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 (*AccountHolderUpdateResponseKYBKYCPatchResponseIndividualAddress) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseStatus added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseStatus 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 (
	AccountHolderUpdateResponseKYBKYCPatchResponseStatusAccepted        AccountHolderUpdateResponseKYBKYCPatchResponseStatus = "ACCEPTED"
	AccountHolderUpdateResponseKYBKYCPatchResponseStatusPendingDocument AccountHolderUpdateResponseKYBKYCPatchResponseStatus = "PENDING_DOCUMENT"
	AccountHolderUpdateResponseKYBKYCPatchResponseStatusPendingResubmit AccountHolderUpdateResponseKYBKYCPatchResponseStatus = "PENDING_RESUBMIT"
	AccountHolderUpdateResponseKYBKYCPatchResponseStatusRejected        AccountHolderUpdateResponseKYBKYCPatchResponseStatus = "REJECTED"
)

func (AccountHolderUpdateResponseKYBKYCPatchResponseStatus) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKYBKYCPatchResponseStatus) IsKnown() bool

type AccountHolderUpdateResponseKYBKYCPatchResponseUserType added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseUserType 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", "nature_of_business", and "website_url" attributes will be present. 

const (
	AccountHolderUpdateResponseKYBKYCPatchResponseUserTypeBusiness   AccountHolderUpdateResponseKYBKYCPatchResponseUserType = "BUSINESS"
	AccountHolderUpdateResponseKYBKYCPatchResponseUserTypeIndividual AccountHolderUpdateResponseKYBKYCPatchResponseUserType = "INDIVIDUAL"
)

func (AccountHolderUpdateResponseKYBKYCPatchResponseUserType) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKYBKYCPatchResponseUserType) IsKnown() bool

type AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplication added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplication 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 AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus `json:"status,required"`
	// Reason for the evaluation status.
	StatusReasons []AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason `json:"status_reasons,required"`
	// Timestamp of when the application was last updated.
	Updated time.Time `json:"updated,required" format:"date-time"`
	// Timestamp of when the application passed the verification process. Only present
	// if `status` is `ACCEPTED`
	KyPassedAt time.Time                                                                 `json:"ky_passed_at" format:"date-time"`
	JSON       accountHolderUpdateResponseKybkycPatchResponseVerificationApplicationJSON `json:"-"`
}

Information about the most recent identity verification attempt

func (*AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplication) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus added in v0.68.0 

type AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus string

KYC and KYB evaluation states.

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

const (
	AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatusAccepted        AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus = "ACCEPTED"
	AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatusPendingDocument AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus = "PENDING_DOCUMENT"
	AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatusPendingResubmit AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus = "PENDING_RESUBMIT"
	AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatusRejected        AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus = "REJECTED"
)

func (AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKYBKYCPatchResponseVerificationApplicationStatus) IsKnown() bool

type AccountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividual added in v0.68.0 

type AccountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividual 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 AccountHolderUpdateResponseKYBKYCPatchResponseBeneficialOwnerIndividualsAddress `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        accountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividualJSON `json:"-"`
}

func (*AccountHolderUpdateResponseKybkycPatchResponseBeneficialOwnerIndividual) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseKybkycPatchResponseStatusReason added in v0.68.0 

type AccountHolderUpdateResponseKybkycPatchResponseStatusReason string

Status Reasons for KYC/KYB enrollment states 

const (
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonAddressVerificationFailure                      AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonAgeThresholdFailure                             AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonCompleteVerificationFailure                     AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonDobVerificationFailure                          AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonIDVerificationFailure                           AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonMaxDocumentAttempts                             AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonMaxResubmissionAttempts                         AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonNameVerificationFailure                         AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonOtherVerificationFailure                        AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonRiskThresholdFailure                            AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonWatchlistAlertFailure                           AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "WATCHLIST_ALERT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityIDVerificationFailure      AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityAddressVerificationFailure AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityNameVerificationFailure    AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntitySosFilingInactive          AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntitySosNotMatched              AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityCmraFailure                AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityWatchlistFailure           AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonPrimaryBusinessEntityRegisteredAgentFailure     AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonControlPersonBlocklistAlertFailure              AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonControlPersonIDVerificationFailure              AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonControlPersonDobVerificationFailure             AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseStatusReasonControlPersonNameVerificationFailure            AccountHolderUpdateResponseKybkycPatchResponseStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderUpdateResponseKybkycPatchResponseStatusReason) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKybkycPatchResponseStatusReason) IsKnown() bool

type AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason added in v0.68.0 

type AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason string

Status Reasons for KYC/KYB enrollment states 

const (
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonAddressVerificationFailure                      AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "ADDRESS_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonAgeThresholdFailure                             AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "AGE_THRESHOLD_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonCompleteVerificationFailure                     AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "COMPLETE_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonDobVerificationFailure                          AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "DOB_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonIDVerificationFailure                           AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonMaxDocumentAttempts                             AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "MAX_DOCUMENT_ATTEMPTS"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonMaxResubmissionAttempts                         AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "MAX_RESUBMISSION_ATTEMPTS"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonNameVerificationFailure                         AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "NAME_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonOtherVerificationFailure                        AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "OTHER_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonRiskThresholdFailure                            AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "RISK_THRESHOLD_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonWatchlistAlertFailure                           AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "WATCHLIST_ALERT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityIDVerificationFailure      AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityAddressVerificationFailure AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityNameVerificationFailure    AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityBusinessOfficersNotMatched AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntitySosFilingInactive          AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntitySosNotMatched              AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityCmraFailure                AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityWatchlistFailure           AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonPrimaryBusinessEntityRegisteredAgentFailure     AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonControlPersonBlocklistAlertFailure              AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonControlPersonIDVerificationFailure              AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "CONTROL_PERSON_ID_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonControlPersonDobVerificationFailure             AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
	AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReasonControlPersonNameVerificationFailure            AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason = "CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
)

func (AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseKybkycPatchResponseVerificationApplicationStatusReason) IsKnown() bool

type AccountHolderUpdateResponsePatchResponse added in v0.68.0 

type AccountHolderUpdateResponsePatchResponse struct {
	// The token for the account holder that was updated
	Token string `json:"token"`
	// The address for the account holder
	Address AccountHolderUpdateResponsePatchResponseAddress `json:"address"`
	// The token for the business account that the account holder is associated with
	BusinessAccountToken string `json:"business_account_token,nullable"`
	// The email for the account holder
	Email string `json:"email"`
	// The first name for the account holder
	FirstName string `json:"first_name"`
	// The last name for the account holder
	LastName string `json:"last_name"`
	// The legal business name for the account holder
	LegalBusinessName string `json:"legal_business_name"`
	// The phone_number for the account holder
	PhoneNumber string                                       `json:"phone_number"`
	JSON        accountHolderUpdateResponsePatchResponseJSON `json:"-"`
}

func (*AccountHolderUpdateResponsePatchResponse) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponsePatchResponseAddress added in v0.68.0 

type AccountHolderUpdateResponsePatchResponseAddress 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     accountHolderUpdateResponsePatchResponseAddressJSON `json:"-"`
}

The address for the account holder

func (*AccountHolderUpdateResponsePatchResponseAddress) UnmarshalJSON added in v0.68.0 

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

type AccountHolderUpdateResponseStatus added in v0.68.0 

type AccountHolderUpdateResponseStatus 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 (
	AccountHolderUpdateResponseStatusAccepted        AccountHolderUpdateResponseStatus = "ACCEPTED"
	AccountHolderUpdateResponseStatusPendingDocument AccountHolderUpdateResponseStatus = "PENDING_DOCUMENT"
	AccountHolderUpdateResponseStatusPendingResubmit AccountHolderUpdateResponseStatus = "PENDING_RESUBMIT"
	AccountHolderUpdateResponseStatusRejected        AccountHolderUpdateResponseStatus = "REJECTED"
)

func (AccountHolderUpdateResponseStatus) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseStatus) IsKnown() bool

type AccountHolderUpdateResponseUnion added in v0.68.0 

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

Union satisfied by AccountHolderUpdateResponseKYBKYCPatchResponse or AccountHolderUpdateResponsePatchResponse.

type AccountHolderUpdateResponseUserType added in v0.68.0 

type AccountHolderUpdateResponseUserType 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", "nature_of_business", and "website_url" attributes will be present. 

const (
	AccountHolderUpdateResponseUserTypeBusiness   AccountHolderUpdateResponseUserType = "BUSINESS"
	AccountHolderUpdateResponseUserTypeIndividual AccountHolderUpdateResponseUserType = "INDIVIDUAL"
)

func (AccountHolderUpdateResponseUserType) IsKnown added in v0.68.0 

func (r AccountHolderUpdateResponseUserType) IsKnown() bool

type AccountHolderUpdatedWebhookEvent added in v0.98.0 

type AccountHolderUpdatedWebhookEvent struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// If applicable, represents the business account token associated with the
	// account_holder.
	BusinessAccountToken string `json:"business_account_token,nullable" format:"uuid"`
	// When the account_holder updated event was created
	Created time.Time `json:"created" format:"date-time"`
	// If updated, the newly updated email associated with the account_holder otherwise
	// the existing email is provided.
	Email string `json:"email"`
	// The type of event that occurred.
	EventType AccountHolderUpdatedWebhookEventEventType `json:"event_type"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string `json:"external_id,nullable"`
	// If applicable, represents the account_holder's first name.
	FirstName string `json:"first_name"`
	// If applicable, represents the account_holder's last name.
	LastName string `json:"last_name"`
	// If applicable, represents the account_holder's business name.
	LegalBusinessName string `json:"legal_business_name"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness string `json:"nature_of_business"`
	// If updated, the newly updated phone_number associated with the account_holder
	// otherwise the existing phone_number is provided.
	PhoneNumber string `json:"phone_number"`
	// This field can have the runtime type of
	// [AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequest],
	// [AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequest].
	UpdateRequest interface{} `json:"update_request"`
	// Company website URL.
	WebsiteURL string                               `json:"website_url"`
	JSON       accountHolderUpdatedWebhookEventJSON `json:"-"`
	// contains filtered or unexported fields
}

KYB payload for an updated account holder.

func (AccountHolderUpdatedWebhookEvent) AsUnion added in v0.98.0 

func (r AccountHolderUpdatedWebhookEvent) AsUnion() AccountHolderUpdatedWebhookEventUnion

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

Possible runtime types of the union are AccountHolderUpdatedWebhookEventKYBPayload, AccountHolderUpdatedWebhookEventKYCPayload, AccountHolderUpdatedWebhookEventLegacyPayload.

func (*AccountHolderUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventEventType added in v0.98.0 

type AccountHolderUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	AccountHolderUpdatedWebhookEventEventTypeAccountHolderUpdated AccountHolderUpdatedWebhookEventEventType = "account_holder.updated"
)

func (AccountHolderUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r AccountHolderUpdatedWebhookEventEventType) IsKnown() bool

type AccountHolderUpdatedWebhookEventKYBPayload added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// Original request to update the account holder.
	UpdateRequest AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequest `json:"update_request,required"`
	// The type of event that occurred.
	EventType AccountHolderUpdatedWebhookEventKYBPayloadEventType `json:"event_type"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string `json:"external_id"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness string `json:"nature_of_business"`
	// Company website URL.
	WebsiteURL string                                         `json:"website_url"`
	JSON       accountHolderUpdatedWebhookEventKYBPayloadJSON `json:"-"`
}

KYB payload for an updated account holder.

func (*AccountHolderUpdatedWebhookEventKYBPayload) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYBPayloadEventType added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadEventType string

The type of event that occurred. 

const (
	AccountHolderUpdatedWebhookEventKYBPayloadEventTypeAccountHolderUpdated AccountHolderUpdatedWebhookEventKYBPayloadEventType = "account_holder.updated"
)

func (AccountHolderUpdatedWebhookEventKYBPayloadEventType) IsKnown added in v0.98.0 

func (r AccountHolderUpdatedWebhookEventKYBPayloadEventType) IsKnown() bool

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequest added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequest struct {
	// Deprecated.
	//
	// Deprecated: deprecated
	BeneficialOwnerEntities []KYBBusinessEntity `json:"beneficial_owner_entities"`
	// You must submit a list of all direct and indirect individuals with 25% or more
	// ownership in the company. A maximum of 4 beneficial owners can be submitted. If
	// no individual owns 25% of the company you do not need to send beneficial owner
	// information. 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.
	BeneficialOwnerIndividuals []AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual `json:"beneficial_owner_individuals"`
	// Information for business for which the account is being opened and KYB is being
	// run.
	BusinessEntity KYBBusinessEntity `json:"business_entity"`
	// 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 AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPerson `json:"control_person"`
	JSON          accountHolderUpdatedWebhookEventKYBPayloadUpdateRequestJSON          `json:"-"`
}

Original request to update the account holder.

func (*AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequest) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual 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 AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress `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        accountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualJSON `json:"-"`
}

func (*AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress 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     accountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddressJSON `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 (*AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPerson added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPerson 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 AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonAddress `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        accountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonJSON `json:"-"`
}

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 (*AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPerson) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonAddress added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonAddress 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     accountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonAddressJSON `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 (*AccountHolderUpdatedWebhookEventKYBPayloadUpdateRequestControlPersonAddress) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYCPayload added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYCPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// Original request to update the account holder.
	UpdateRequest AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequest `json:"update_request,required"`
	// The type of event that occurred.
	EventType AccountHolderUpdatedWebhookEventKYCPayloadEventType `json:"event_type"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string                                         `json:"external_id"`
	JSON       accountHolderUpdatedWebhookEventKYCPayloadJSON `json:"-"`
}

KYC payload for an updated account holder.

func (*AccountHolderUpdatedWebhookEventKYCPayload) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYCPayloadEventType added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYCPayloadEventType string

The type of event that occurred. 

const (
	AccountHolderUpdatedWebhookEventKYCPayloadEventTypeAccountHolderUpdated AccountHolderUpdatedWebhookEventKYCPayloadEventType = "account_holder.updated"
)

func (AccountHolderUpdatedWebhookEventKYCPayloadEventType) IsKnown added in v0.98.0 

func (r AccountHolderUpdatedWebhookEventKYCPayloadEventType) IsKnown() bool

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequest added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequest struct {
	// Information on the individual for whom the account is being opened and KYC is
	// being run.
	Individual AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividual `json:"individual"`
	JSON       accountHolderUpdatedWebhookEventKYCPayloadUpdateRequestJSON       `json:"-"`
}

Original request to update the account holder.

func (*AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequest) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividual added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividual 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 AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualAddress `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        accountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualJSON `json:"-"`
}

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

func (*AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividual) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualAddress added in v0.98.0 

type AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualAddress 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     accountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualAddressJSON `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 (*AccountHolderUpdatedWebhookEventKYCPayloadUpdateRequestIndividualAddress) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventLegacyPayload added in v0.98.0 

type AccountHolderUpdatedWebhookEventLegacyPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// If applicable, represents the business account token associated with the
	// account_holder.
	BusinessAccountToken string `json:"business_account_token,nullable" format:"uuid"`
	// When the account_holder updated event was created
	Created time.Time `json:"created" format:"date-time"`
	// If updated, the newly updated email associated with the account_holder otherwise
	// the existing email is provided.
	Email string `json:"email"`
	// The type of event that occurred.
	EventType AccountHolderUpdatedWebhookEventLegacyPayloadEventType `json:"event_type"`
	// If applicable, represents the external_id associated with the account_holder.
	ExternalID string `json:"external_id,nullable"`
	// If applicable, represents the account_holder's first name.
	FirstName string `json:"first_name"`
	// If applicable, represents the account_holder's last name.
	LastName string `json:"last_name"`
	// If applicable, represents the account_holder's business name.
	LegalBusinessName string `json:"legal_business_name"`
	// If updated, the newly updated phone_number associated with the account_holder
	// otherwise the existing phone_number is provided.
	PhoneNumber string                                            `json:"phone_number"`
	JSON        accountHolderUpdatedWebhookEventLegacyPayloadJSON `json:"-"`
}

Legacy payload for an updated account holder.

func (*AccountHolderUpdatedWebhookEventLegacyPayload) UnmarshalJSON added in v0.98.0 

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

type AccountHolderUpdatedWebhookEventLegacyPayloadEventType added in v0.98.0 

type AccountHolderUpdatedWebhookEventLegacyPayloadEventType string

The type of event that occurred. 

const (
	AccountHolderUpdatedWebhookEventLegacyPayloadEventTypeAccountHolderUpdated AccountHolderUpdatedWebhookEventLegacyPayloadEventType = "account_holder.updated"
)

func (AccountHolderUpdatedWebhookEventLegacyPayloadEventType) IsKnown added in v0.98.0 

func (r AccountHolderUpdatedWebhookEventLegacyPayloadEventType) IsKnown() bool

type AccountHolderUpdatedWebhookEventUnion added in v0.98.0 

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

KYB payload for an updated account holder.

Union satisfied by AccountHolderUpdatedWebhookEventKYBPayload, AccountHolderUpdatedWebhookEventKYCPayload or AccountHolderUpdatedWebhookEventLegacyPayload.

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"
	AccountHolderUploadDocumentParamsDocumentTypeFincenBoiReport           AccountHolderUploadDocumentParamsDocumentType = "FINCEN_BOI_REPORT"
)

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", "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_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_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 AccountHolderVerificationWebhookEvent added in v0.98.0 

type AccountHolderVerificationWebhookEvent struct {
	// The type of event that occurred.
	EventType AccountHolderVerificationWebhookEventEventType `json:"event_type,required"`
	// The token of the account_holder being verified.
	Token string `json:"token" format:"uuid"`
	// The token of the account being verified.
	AccountToken string `json:"account_token" format:"uuid"`
	// When the account_holder verification status was updated
	Created time.Time `json:"created" format:"date-time"`
	// The status of the account_holder that was created
	Status        AccountHolderVerificationWebhookEventStatus `json:"status"`
	StatusReasons []string                                    `json:"status_reasons"`
	JSON          accountHolderVerificationWebhookEventJSON   `json:"-"`
}

func (*AccountHolderVerificationWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type AccountHolderVerificationWebhookEventEventType added in v0.98.0 

type AccountHolderVerificationWebhookEventEventType string

The type of event that occurred. 

const (
	AccountHolderVerificationWebhookEventEventTypeAccountHolderVerification AccountHolderVerificationWebhookEventEventType = "account_holder.verification"
)

func (AccountHolderVerificationWebhookEventEventType) IsKnown added in v0.98.0 

func (r AccountHolderVerificationWebhookEventEventType) IsKnown() bool

type AccountHolderVerificationWebhookEventStatus added in v0.98.0 

type AccountHolderVerificationWebhookEventStatus string

The status of the account_holder that was created 

const (
	AccountHolderVerificationWebhookEventStatusAccepted      AccountHolderVerificationWebhookEventStatus = "ACCEPTED"
	AccountHolderVerificationWebhookEventStatusPendingReview AccountHolderVerificationWebhookEventStatus = "PENDING_REVIEW"
	AccountHolderVerificationWebhookEventStatusRejected      AccountHolderVerificationWebhookEventStatus = "REJECTED"
)

func (AccountHolderVerificationWebhookEventStatus) IsKnown added in v0.98.0 

func (r AccountHolderVerificationWebhookEventStatus) 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 (e.g. 100000 would be a $1,000 limit).
	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 unable to be transitioned to `ACTIVE` or `PAUSED` states. Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to failure to pass KYB/KYC or for risk/compliance reasons. Please contact [support@lithic.com](mailto:support@lithic.com) if you believe this was done by mistake.
const (
	AccountStateActive AccountState = "ACTIVE"
	AccountStatePaused AccountState = "PAUSED"
	AccountStateClosed AccountState = "CLOSED"
)

func (AccountState) IsKnown added in v0.27.0 

func (r AccountState) IsKnown() bool

type AccountSubstatus added in v0.84.0 

type AccountSubstatus string

Account state substatus values:

  • `FRAUD_IDENTIFIED` - The account has been recognized as being created or used with stolen or fabricated identity information, encompassing both true identity theft and synthetic identities.
  • `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as unauthorized access or fraudulent transactions, necessitating further investigation.
  • `RISK_VIOLATION` - The account has been involved in deliberate misuse by the legitimate account holder. Examples include disputing valid transactions without cause, falsely claiming non-receipt of goods, or engaging in intentional bust-out schemes to exploit account services.
  • `END_USER_REQUEST` - The account holder has voluntarily requested the closure of the account for personal reasons. This encompasses situations such as bankruptcy, other financial considerations, or the account holder's death.
  • `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to business strategy, risk management, inactivity, product changes, regulatory concerns, or violations of terms and conditions.
  • `NOT_ACTIVE` - The account has not had any transactions or payment activity within a specified period. This status applies to accounts that are paused or closed due to inactivity.
  • `INTERNAL_REVIEW` - The account is temporarily paused pending further internal review. In future implementations, this status may prevent clients from activating the account via APIs until the review is completed.
  • `OTHER` - The reason for the account's current status does not fall into any of the above categories. A comment should be provided to specify the particular reason.
const (
	AccountSubstatusFraudIdentified    AccountSubstatus = "FRAUD_IDENTIFIED"
	AccountSubstatusSuspiciousActivity AccountSubstatus = "SUSPICIOUS_ACTIVITY"
	AccountSubstatusRiskViolation      AccountSubstatus = "RISK_VIOLATION"
	AccountSubstatusEndUserRequest     AccountSubstatus = "END_USER_REQUEST"
	AccountSubstatusIssuerRequest      AccountSubstatus = "ISSUER_REQUEST"
	AccountSubstatusNotActive          AccountSubstatus = "NOT_ACTIVE"
	AccountSubstatusInternalReview     AccountSubstatus = "INTERNAL_REVIEW"
	AccountSubstatusOther              AccountSubstatus = "OTHER"
)

func (AccountSubstatus) IsKnown added in v0.84.0 

func (r AccountSubstatus) IsKnown() bool

type AccountUpdateParams 

type AccountUpdateParams struct {
	// Additional context or information related to the account.
	Comment param.Field[string] `json:"comment"`
	// Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
	// $1,000 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 (e.g. 100000 would be a
	// $1,000 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 (e.g. 100000 would be a
	// $1,000 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"`
	// Account state substatus values:
	//
	//   - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
	//     with stolen or fabricated identity information, encompassing both true
	//     identity theft and synthetic identities.
	//   - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
	//     unauthorized access or fraudulent transactions, necessitating further
	//     investigation.
	//   - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
	//     legitimate account holder. Examples include disputing valid transactions
	//     without cause, falsely claiming non-receipt of goods, or engaging in
	//     intentional bust-out schemes to exploit account services.
	//   - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
	//     of the account for personal reasons. This encompasses situations such as
	//     bankruptcy, other financial considerations, or the account holder's death.
	//   - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
	//     business strategy, risk management, inactivity, product changes, regulatory
	//     concerns, or violations of terms and conditions.
	//   - `NOT_ACTIVE` - The account has not had any transactions or payment activity
	//     within a specified period. This status applies to accounts that are paused or
	//     closed due to inactivity.
	//   - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
	//     review. In future implementations, this status may prevent clients from
	//     activating the account via APIs until the review is completed.
	//   - `OTHER` - The reason for the account's current status does not fall into any
	//     of the above categories. A comment should be provided to specify the
	//     particular reason.
	Substatus param.Field[AccountUpdateParamsSubstatus] `json:"substatus"`
	// 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 Auth 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"
	AccountUpdateParamsStateClosed AccountUpdateParamsState = "CLOSED"
)

func (AccountUpdateParamsState) IsKnown added in v0.27.0 

func (r AccountUpdateParamsState) IsKnown() bool

type AccountUpdateParamsSubstatus added in v0.84.0 

type AccountUpdateParamsSubstatus string

Account state substatus values:

  • `FRAUD_IDENTIFIED` - The account has been recognized as being created or used with stolen or fabricated identity information, encompassing both true identity theft and synthetic identities.
  • `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as unauthorized access or fraudulent transactions, necessitating further investigation.
  • `RISK_VIOLATION` - The account has been involved in deliberate misuse by the legitimate account holder. Examples include disputing valid transactions without cause, falsely claiming non-receipt of goods, or engaging in intentional bust-out schemes to exploit account services.
  • `END_USER_REQUEST` - The account holder has voluntarily requested the closure of the account for personal reasons. This encompasses situations such as bankruptcy, other financial considerations, or the account holder's death.
  • `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to business strategy, risk management, inactivity, product changes, regulatory concerns, or violations of terms and conditions.
  • `NOT_ACTIVE` - The account has not had any transactions or payment activity within a specified period. This status applies to accounts that are paused or closed due to inactivity.
  • `INTERNAL_REVIEW` - The account is temporarily paused pending further internal review. In future implementations, this status may prevent clients from activating the account via APIs until the review is completed.
  • `OTHER` - The reason for the account's current status does not fall into any of the above categories. A comment should be provided to specify the particular reason.
const (
	AccountUpdateParamsSubstatusFraudIdentified    AccountUpdateParamsSubstatus = "FRAUD_IDENTIFIED"
	AccountUpdateParamsSubstatusSuspiciousActivity AccountUpdateParamsSubstatus = "SUSPICIOUS_ACTIVITY"
	AccountUpdateParamsSubstatusRiskViolation      AccountUpdateParamsSubstatus = "RISK_VIOLATION"
	AccountUpdateParamsSubstatusEndUserRequest     AccountUpdateParamsSubstatus = "END_USER_REQUEST"
	AccountUpdateParamsSubstatusIssuerRequest      AccountUpdateParamsSubstatus = "ISSUER_REQUEST"
	AccountUpdateParamsSubstatusNotActive          AccountUpdateParamsSubstatus = "NOT_ACTIVE"
	AccountUpdateParamsSubstatusInternalReview     AccountUpdateParamsSubstatus = "INTERNAL_REVIEW"
	AccountUpdateParamsSubstatusOther              AccountUpdateParamsSubstatus = "OTHER"
)

func (AccountUpdateParamsSubstatus) IsKnown added in v0.84.0 

func (r AccountUpdateParamsSubstatus) IsKnown() bool

type AccountUpdateParamsVerificationAddress deprecated 

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 Auth Rules. The field will be removed from the schema in a future release.

Deprecated: deprecated

func (AccountUpdateParamsVerificationAddress) MarshalJSON added in v0.3.1 

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

type AccountVerificationAddress deprecated 

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:"-"`
}

Deprecated: deprecated

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 AddressUpdateParam added in v0.68.0 

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

func (AddressUpdateParam) MarshalJSON added in v0.68.0 

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

type AuthRule 

type AuthRule struct {
	// Auth Rule Token
	Token string `json:"token,required" format:"uuid"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens []string `json:"account_tokens,required" format:"uuid"`
	// Business Account tokens to which the Auth Rule applies.
	BusinessAccountTokens []string `json:"business_account_tokens,required" format:"uuid"`
	// Card tokens to which the Auth Rule applies.
	CardTokens     []string               `json:"card_tokens,required" format:"uuid"`
	CurrentVersion AuthRuleCurrentVersion `json:"current_version,required,nullable"`
	DraftVersion   AuthRuleDraftVersion   `json:"draft_version,required,nullable"`
	// The event stream during which the rule will be evaluated.
	EventStream EventStream `json:"event_stream,required"`
	// Indicates whether this auth rule is managed by Lithic. If true, the rule cannot
	// be modified or deleted by the user
	LithicManaged bool `json:"lithic_managed,required"`
	// Auth Rule Name
	Name string `json:"name,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 AuthRuleState `json:"state,required"`
	// The type of Auth Rule. For certain rule types, this determines the event stream
	// during which it will be evaluated. For rules that can be applied to one of
	// several event streams, the effective one is defined by the separate
	// `event_stream` field.
	//
	//   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
	//   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
	//   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
	//   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
	//     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
	Type AuthRuleType `json:"type,required"`
	// Card tokens to which the Auth Rule does not apply.
	ExcludedCardTokens []string     `json:"excluded_card_tokens" format:"uuid"`
	JSON               authRuleJSON `json:"-"`
}

func (*AuthRule) UnmarshalJSON 

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

type AuthRuleCondition added in v0.64.0 

type AuthRuleCondition 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-character 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.
	//   - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
	//     trailing 15 minutes before the authorization.
	//   - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
	//     trailing hour up and until the authorization.
	//   - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
	//     trailing 24 hours up and until the authorization.
	//   - `CARD_STATE`: The current state of the card associated with the transaction.
	//     Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
	//     `PENDING_FULFILLMENT`.
	//   - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
	//     Valid values are `TRUE`, `FALSE`.
	//   - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
	//     `OK`, `BLOCKED`.
	//   - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
	//     source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
	//     `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
	//   - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
	//     data with the cardholder KYC data if it exists. Valid values are `MATCH`,
	//     `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
	Attribute ConditionalAttribute `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation ConditionalOperation `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value ConditionalValueUnion `json:"value,required" format:"date-time"`
	JSON  authRuleConditionJSON `json:"-"`
}

func (*AuthRuleCondition) UnmarshalJSON added in v0.64.0 

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

type AuthRuleConditionParam added in v0.64.0 

type AuthRuleConditionParam 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-character 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.
	//   - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
	//     trailing 15 minutes before the authorization.
	//   - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
	//     trailing hour up and until the authorization.
	//   - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
	//     trailing 24 hours up and until the authorization.
	//   - `CARD_STATE`: The current state of the card associated with the transaction.
	//     Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
	//     `PENDING_FULFILLMENT`.
	//   - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
	//     Valid values are `TRUE`, `FALSE`.
	//   - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
	//     `OK`, `BLOCKED`.
	//   - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
	//     source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
	//     `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
	//   - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
	//     data with the cardholder KYC data if it exists. Valid values are `MATCH`,
	//     `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
	Attribute param.Field[ConditionalAttribute] `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation param.Field[ConditionalOperation] `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value param.Field[ConditionalValueUnionParam] `json:"value,required" format:"date-time"`
}

func (AuthRuleConditionParam) MarshalJSON added in v0.64.0 

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

type AuthRuleCurrentVersion added in v0.98.0 

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

func (*AuthRuleCurrentVersion) UnmarshalJSON added in v0.98.0 

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

type AuthRuleCurrentVersionParameters added in v0.98.0 

type AuthRuleCurrentVersionParameters struct {
	// This field can have the runtime type of [Conditional3DSActionParametersAction],
	// [ConditionalAuthorizationActionParametersAction],
	// [ConditionalACHActionParametersAction],
	// [ConditionalTokenizationActionParametersAction].
	Action interface{} `json:"action"`
	// This field can have the runtime type of [[]AuthRuleCondition],
	// [[]Conditional3DsActionParametersCondition],
	// [[]ConditionalAuthorizationActionParametersCondition],
	// [[]ConditionalACHActionParametersCondition],
	// [[]ConditionalTokenizationActionParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [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 int64 `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 int64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [[]MerchantLockParametersMerchant].
	Merchants interface{} `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period VelocityLimitPeriod `json:"period"`
	// The scope the velocity is calculated for
	Scope AuthRuleCurrentVersionParametersScope `json:"scope"`
	JSON  authRuleCurrentVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the Auth Rule

func (AuthRuleCurrentVersionParameters) AsUnion added in v0.98.0 

func (r AuthRuleCurrentVersionParameters) AsUnion() AuthRuleCurrentVersionParametersUnion

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

Possible runtime types of the union are ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters.

func (*AuthRuleCurrentVersionParameters) UnmarshalJSON added in v0.98.0 

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

type AuthRuleCurrentVersionParametersScope added in v0.98.0 

type AuthRuleCurrentVersionParametersScope string

The scope the velocity is calculated for 

const (
	AuthRuleCurrentVersionParametersScopeCard    AuthRuleCurrentVersionParametersScope = "CARD"
	AuthRuleCurrentVersionParametersScopeAccount AuthRuleCurrentVersionParametersScope = "ACCOUNT"
)

func (AuthRuleCurrentVersionParametersScope) IsKnown added in v0.98.0 

func (r AuthRuleCurrentVersionParametersScope) IsKnown() bool

type AuthRuleCurrentVersionParametersUnion added in v0.98.0 

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

Parameters for the Auth Rule

Union satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters or ConditionalTokenizationActionParameters.

type AuthRuleDraftVersion added in v0.98.0 

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

func (*AuthRuleDraftVersion) UnmarshalJSON added in v0.98.0 

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

type AuthRuleDraftVersionParameters added in v0.98.0 

type AuthRuleDraftVersionParameters struct {
	// This field can have the runtime type of [Conditional3DSActionParametersAction],
	// [ConditionalAuthorizationActionParametersAction],
	// [ConditionalACHActionParametersAction],
	// [ConditionalTokenizationActionParametersAction].
	Action interface{} `json:"action"`
	// This field can have the runtime type of [[]AuthRuleCondition],
	// [[]Conditional3DsActionParametersCondition],
	// [[]ConditionalAuthorizationActionParametersCondition],
	// [[]ConditionalACHActionParametersCondition],
	// [[]ConditionalTokenizationActionParametersCondition].
	Conditions interface{} `json:"conditions"`
	// This field can have the runtime type of [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 int64 `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 int64 `json:"limit_count,nullable"`
	// This field can have the runtime type of [[]MerchantLockParametersMerchant].
	Merchants interface{} `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period VelocityLimitPeriod `json:"period"`
	// The scope the velocity is calculated for
	Scope AuthRuleDraftVersionParametersScope `json:"scope"`
	JSON  authRuleDraftVersionParametersJSON  `json:"-"`
	// contains filtered or unexported fields
}

Parameters for the Auth Rule

func (AuthRuleDraftVersionParameters) AsUnion added in v0.98.0 

func (r AuthRuleDraftVersionParameters) AsUnion() AuthRuleDraftVersionParametersUnion

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

Possible runtime types of the union are ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters.

func (*AuthRuleDraftVersionParameters) UnmarshalJSON added in v0.98.0 

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

type AuthRuleDraftVersionParametersScope added in v0.98.0 

type AuthRuleDraftVersionParametersScope string

The scope the velocity is calculated for 

const (
	AuthRuleDraftVersionParametersScopeCard    AuthRuleDraftVersionParametersScope = "CARD"
	AuthRuleDraftVersionParametersScopeAccount AuthRuleDraftVersionParametersScope = "ACCOUNT"
)

func (AuthRuleDraftVersionParametersScope) IsKnown added in v0.98.0 

func (r AuthRuleDraftVersionParametersScope) IsKnown() bool

type AuthRuleDraftVersionParametersUnion added in v0.98.0 

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

Parameters for the Auth Rule

Union satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters or ConditionalTokenizationActionParameters.

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 AuthRuleState 

type AuthRuleState string

The state of the Auth Rule 

const (
	AuthRuleStateActive   AuthRuleState = "ACTIVE"
	AuthRuleStateInactive AuthRuleState = "INACTIVE"
)

func (AuthRuleState) IsKnown added in v0.27.0 

func (r AuthRuleState) IsKnown() bool

type AuthRuleType added in v0.98.0 

type AuthRuleType string

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate `event_stream` field.

  • `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
  • `VELOCITY_LIMIT`: AUTHORIZATION event stream.
  • `MERCHANT_LOCK`: AUTHORIZATION event stream.
  • `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
const (
	AuthRuleTypeConditionalBlock  AuthRuleType = "CONDITIONAL_BLOCK"
	AuthRuleTypeVelocityLimit     AuthRuleType = "VELOCITY_LIMIT"
	AuthRuleTypeMerchantLock      AuthRuleType = "MERCHANT_LOCK"
	AuthRuleTypeConditionalAction AuthRuleType = "CONDITIONAL_ACTION"
)

func (AuthRuleType) IsKnown added in v0.98.0 

func (r AuthRuleType) IsKnown() bool

type AuthRuleV2BacktestNewParams added in v0.64.0 

type AuthRuleV2BacktestNewParams struct {
	// The end time of the backtest.
	End param.Field[time.Time] `json:"end" format:"date-time"`
	// The start time of the backtest.
	Start param.Field[time.Time] `json:"start" format:"date-time"`
}

func (AuthRuleV2BacktestNewParams) MarshalJSON added in v0.64.0 

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

type AuthRuleV2BacktestNewResponse added in v0.64.0 

type AuthRuleV2BacktestNewResponse struct {
	// Auth Rule Backtest Token
	BacktestToken string                            `json:"backtest_token" format:"uuid"`
	JSON          authRuleV2BacktestNewResponseJSON `json:"-"`
}

func (*AuthRuleV2BacktestNewResponse) UnmarshalJSON added in v0.64.0 

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

type AuthRuleV2BacktestService added in v0.64.0 

type AuthRuleV2BacktestService struct {
	Options []option.RequestOption
}

AuthRuleV2BacktestService 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 NewAuthRuleV2BacktestService method instead.

func NewAuthRuleV2BacktestService added in v0.64.0 

func NewAuthRuleV2BacktestService(opts ...option.RequestOption) (r *AuthRuleV2BacktestService)

NewAuthRuleV2BacktestService 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 (*AuthRuleV2BacktestService) Get added in v0.64.0 

func (r *AuthRuleV2BacktestService) Get(ctx context.Context, authRuleToken string, authRuleBacktestToken string, opts ...option.RequestOption) (res *BacktestResults, err error)

Returns the backtest results of an Auth rule (if available).

Backtesting is an asynchronous process that requires time to complete. If a customer retrieves the backtest results using this endpoint before the report is fully generated, the response will return null for `results.current_version` and `results.draft_version`. Customers are advised to wait for the backtest creation process to complete (as indicated by the webhook event auth_rules.backtest_report.created) before retrieving results from this endpoint.

Backtesting is an asynchronous process, while the backtest is being processed, results will not be available which will cause `results.current_version` and `results.draft_version` objects to contain `null`. The entries in `results` will also always represent the configuration of the rule at the time requests are made to this endpoint. For example, the results for `current_version` in the served backtest report will be consistent with which version of the rule is currently activated in the respective event stream, regardless of which version of the rule was active in the event stream at the time a backtest is requested.

func (*AuthRuleV2BacktestService) New added in v0.64.0 

func (r *AuthRuleV2BacktestService) New(ctx context.Context, authRuleToken string, body AuthRuleV2BacktestNewParams, opts ...option.RequestOption) (res *AuthRuleV2BacktestNewResponse, err error)

Initiates a request to asynchronously generate a backtest for an Auth rule. During backtesting, both the active version (if one exists) and the draft version of the Auth Rule are evaluated by replaying historical transaction data against the rule's conditions. This process allows customers to simulate and understand the effects of proposed rule changes before deployment. The generated backtest report provides detailed results showing whether the draft version of the Auth Rule would have approved or declined historical transactions which were processed during the backtest period. These reports help evaluate how changes to rule configurations might affect overall transaction approval rates.

The generated backtest report will be delivered asynchronously through a webhook with `event_type` = `auth_rules.backtest_report.created`. See the docs on setting up [webhook subscriptions](https://docs.lithic.com/docs/events-api). It is also possible to request backtest reports on-demand through the `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}` endpoint.

Lithic currently supports backtesting for `CONDITIONAL_BLOCK` / `CONDITIONAL_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is generally not supported. In specific cases (i.e. where Lithic has pre-calculated the requested velocity metrics for historical transactions), a backtest may be feasible. However, such cases are uncommon and customers should not anticipate support for velocity backtests under most configurations. If a historical transaction does not feature the required inputs to evaluate the rule, then it will not be included in the final backtest report.

type AuthRuleV2DraftParams added in v0.51.0 

type AuthRuleV2DraftParams struct {
	// Parameters for 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 {
	Action     param.Field[interface{}] `json:"action"`
	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[int64] `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[int64]       `json:"limit_count"`
	Merchants  param.Field[interface{}] `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period param.Field[VelocityLimitPeriodUnionParam] `json:"period"`
	// The scope the velocity is calculated for
	Scope param.Field[AuthRuleV2DraftParamsParametersScope] `json:"scope"`
}

Parameters for the Auth Rule

func (AuthRuleV2DraftParamsParameters) MarshalJSON added in v0.51.0 

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

type AuthRuleV2DraftParamsParametersScope added in v0.51.0 

type AuthRuleV2DraftParamsParametersScope string

The scope the velocity is calculated for 

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 {
	// contains filtered or unexported methods
}

Parameters for the Auth Rule

Satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters, AuthRuleV2DraftParamsParameters.

type AuthRuleV2GetFeaturesParams added in v0.93.0 

type AuthRuleV2GetFeaturesParams struct {
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	CardToken    param.Field[string] `query:"card_token" format:"uuid"`
}

func (AuthRuleV2GetFeaturesParams) URLQuery added in v0.93.0 

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

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

type AuthRuleV2GetFeaturesResponse added in v0.93.0 

type AuthRuleV2GetFeaturesResponse struct {
	// Timestamp at which the Features were evaluated
	Evaluated time.Time `json:"evaluated,required" format:"date-time"`
	// Calculated Features used for evaluation of the provided Auth Rule
	Features []AuthRuleV2GetFeaturesResponseFeature `json:"features,required"`
	JSON     authRuleV2GetFeaturesResponseJSON      `json:"-"`
}

func (*AuthRuleV2GetFeaturesResponse) UnmarshalJSON added in v0.93.0 

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

type AuthRuleV2GetFeaturesResponseFeature added in v0.93.0 

type AuthRuleV2GetFeaturesResponseFeature struct {
	Filters AuthRuleV2GetFeaturesResponseFeaturesFilters `json:"filters,required"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period VelocityLimitPeriod `json:"period,required"`
	// The scope the velocity is calculated for
	Scope AuthRuleV2GetFeaturesResponseFeaturesScope `json:"scope,required"`
	Value AuthRuleV2GetFeaturesResponseFeaturesValue `json:"value,required"`
	JSON  authRuleV2GetFeaturesResponseFeatureJSON   `json:"-"`
}

func (*AuthRuleV2GetFeaturesResponseFeature) UnmarshalJSON added in v0.93.0 

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

type AuthRuleV2GetFeaturesResponseFeaturesFilters added in v0.93.0 

type AuthRuleV2GetFeaturesResponseFeaturesFilters struct {
	// ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
	// Transactions matching any of the provided will be excluded from the calculated
	// velocity.
	ExcludeCountries []string `json:"exclude_countries,nullable"`
	// Merchant Category Codes to exclude from the velocity calculation. Transactions
	// matching this MCC will be excluded from the calculated velocity.
	ExcludeMccs []string `json:"exclude_mccs,nullable"`
	// ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
	// Transactions not matching any of the provided will not be included in the
	// calculated velocity.
	IncludeCountries []string `json:"include_countries,nullable"`
	// Merchant Category Codes to include in the velocity calculation. Transactions not
	// matching this MCC will not be included in the calculated velocity.
	IncludeMccs []string `json:"include_mccs,nullable"`
	// PAN entry modes to include in the velocity calculation. Transactions not
	// matching any of the provided will not be included in the calculated velocity.
	IncludePanEntryModes []AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode `json:"include_pan_entry_modes,nullable"`
	JSON                 authRuleV2GetFeaturesResponseFeaturesFiltersJSON                  `json:"-"`
}

func (*AuthRuleV2GetFeaturesResponseFeaturesFilters) UnmarshalJSON added in v0.93.0 

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

type AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode added in v0.93.0 

type AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode string
const (
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeAutoEntry           AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "AUTO_ENTRY"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeBarCode             AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "BAR_CODE"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeContactless         AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "CONTACTLESS"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeCredentialOnFile    AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "CREDENTIAL_ON_FILE"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeEcommerce           AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "ECOMMERCE"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeErrorKeyed          AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "ERROR_KEYED"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeErrorMagneticStripe AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "ERROR_MAGNETIC_STRIPE"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeIcc                 AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "ICC"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeKeyEntered          AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "KEY_ENTERED"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeMagneticStripe      AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "MAGNETIC_STRIPE"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeManual              AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "MANUAL"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeOcr                 AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "OCR"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeSecureCardless      AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "SECURE_CARDLESS"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeUnspecified         AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "UNSPECIFIED"
	AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryModeUnknown             AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode = "UNKNOWN"
)

func (AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode) IsKnown added in v0.93.0 

func (r AuthRuleV2GetFeaturesResponseFeaturesFiltersIncludePanEntryMode) IsKnown() bool

type AuthRuleV2GetFeaturesResponseFeaturesScope added in v0.93.0 

type AuthRuleV2GetFeaturesResponseFeaturesScope string

The scope the velocity is calculated for 

const (
	AuthRuleV2GetFeaturesResponseFeaturesScopeCard    AuthRuleV2GetFeaturesResponseFeaturesScope = "CARD"
	AuthRuleV2GetFeaturesResponseFeaturesScopeAccount AuthRuleV2GetFeaturesResponseFeaturesScope = "ACCOUNT"
)

func (AuthRuleV2GetFeaturesResponseFeaturesScope) IsKnown added in v0.93.0 

func (r AuthRuleV2GetFeaturesResponseFeaturesScope) IsKnown() bool

type AuthRuleV2GetFeaturesResponseFeaturesValue added in v0.93.0 

type AuthRuleV2GetFeaturesResponseFeaturesValue struct {
	// Amount (in cents) for the given Auth Rule that is used as input for calculating
	// the rule. For Velocity Limit rules this would be the calculated Velocity. For
	// Conditional Rules using CARD*TRANSACTION_COUNT*\* this will be 0
	Amount int64 `json:"amount,required"`
	// Number of velocity impacting transactions matching the given scope, period and
	// filters
	Count int64                                          `json:"count,required"`
	JSON  authRuleV2GetFeaturesResponseFeaturesValueJSON `json:"-"`
}

func (*AuthRuleV2GetFeaturesResponseFeaturesValue) UnmarshalJSON added in v0.93.0 

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

type AuthRuleV2GetReportParams added in v0.80.0 

type AuthRuleV2GetReportParams struct {
	// Start date for the report
	Begin param.Field[time.Time] `query:"begin,required" format:"date"`
	// End date for the report
	End param.Field[time.Time] `query:"end,required" format:"date"`
}

func (AuthRuleV2GetReportParams) URLQuery added in v0.80.0 

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

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

type AuthRuleV2GetReportResponse added in v0.80.0 

type AuthRuleV2GetReportResponse struct {
	// Auth Rule Token
	AuthRuleToken string `json:"auth_rule_token,required" format:"uuid"`
	// The start date (UTC) of the report.
	Begin time.Time `json:"begin,required" format:"date"`
	// Daily evaluation statistics for the Auth Rule.
	DailyStatistics []AuthRuleV2GetReportResponseDailyStatistic `json:"daily_statistics,required"`
	// The end date (UTC) of the report.
	End  time.Time                       `json:"end,required" format:"date"`
	JSON authRuleV2GetReportResponseJSON `json:"-"`
}

func (*AuthRuleV2GetReportResponse) UnmarshalJSON added in v0.80.0 

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

type AuthRuleV2GetReportResponseDailyStatistic added in v0.80.0 

type AuthRuleV2GetReportResponseDailyStatistic struct {
	// Detailed statistics for the current version of the rule.
	CurrentVersionStatistics RuleStats `json:"current_version_statistics,required,nullable"`
	// The date (UTC) for which the statistics are reported.
	Date time.Time `json:"date,required" format:"date"`
	// Detailed statistics for the draft version of the rule.
	DraftVersionStatistics RuleStats                                     `json:"draft_version_statistics,required,nullable"`
	JSON                   authRuleV2GetReportResponseDailyStatisticJSON `json:"-"`
}

func (*AuthRuleV2GetReportResponseDailyStatistic) UnmarshalJSON added in v0.80.0 

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

type AuthRuleV2ListParams added in v0.51.0 

type AuthRuleV2ListParams struct {
	// Only return Auth Rules that are bound to the provided account token.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Only return Auth Rules that are bound to the provided business account token.
	BusinessAccountToken param.Field[string] `query:"business_account_token" format:"uuid"`
	// Only return Auth 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" format:"uuid"`
	// Deprecated: Use event_streams instead. Only return Auth rules that are executed
	// during the provided event stream.
	EventStream param.Field[EventStream] `query:"event_stream"`
	// Only return Auth rules that are executed during any of the provided event
	// streams. If event_streams and event_stream are specified, the values will be
	// combined.
	EventStreams param.Field[[]EventStream] `query:"event_streams"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// Only return Auth Rules that are bound to the provided scope.
	Scope param.Field[AuthRuleV2ListParamsScope] `query:"scope"`
	// 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" format:"uuid"`
}

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 AuthRuleV2ListParamsScope added in v0.76.0 

type AuthRuleV2ListParamsScope string

Only return Auth Rules that are bound to the provided scope. 

const (
	AuthRuleV2ListParamsScopeProgram         AuthRuleV2ListParamsScope = "PROGRAM"
	AuthRuleV2ListParamsScopeAccount         AuthRuleV2ListParamsScope = "ACCOUNT"
	AuthRuleV2ListParamsScopeBusinessAccount AuthRuleV2ListParamsScope = "BUSINESS_ACCOUNT"
	AuthRuleV2ListParamsScopeCard            AuthRuleV2ListParamsScope = "CARD"
	AuthRuleV2ListParamsScopeAny             AuthRuleV2ListParamsScope = "ANY"
)

func (AuthRuleV2ListParamsScope) IsKnown added in v0.76.0 

func (r AuthRuleV2ListParamsScope) 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 {
	Parameters param.Field[interface{}] `json:"parameters,required"`
	// The type of Auth Rule. For certain rule types, this determines the event stream
	// during which it will be evaluated. For rules that can be applied to one of
	// several event streams, the effective one is defined by the separate
	// `event_stream` field.
	//
	//   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
	//   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
	//   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
	//   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
	//     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
	Type                  param.Field[AuthRuleV2NewParamsBodyType] `json:"type,required"`
	AccountTokens         param.Field[interface{}]                 `json:"account_tokens"`
	BusinessAccountTokens param.Field[interface{}]                 `json:"business_account_tokens"`
	CardTokens            param.Field[interface{}]                 `json:"card_tokens"`
	// The event stream during which the rule will be evaluated.
	EventStream        param.Field[EventStream] `json:"event_stream"`
	ExcludedCardTokens param.Field[interface{}] `json:"excluded_card_tokens"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level"`
}

func (AuthRuleV2NewParamsBody) MarshalJSON added in v0.51.0 

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

type AuthRuleV2NewParamsBodyAccountLevelRule added in v0.96.0 

type AuthRuleV2NewParamsBodyAccountLevelRule struct {
	// Parameters for the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyAccountLevelRuleParametersUnion] `json:"parameters,required"`
	// The type of Auth Rule. For certain rule types, this determines the event stream
	// during which it will be evaluated. For rules that can be applied to one of
	// several event streams, the effective one is defined by the separate
	// `event_stream` field.
	//
	//   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
	//   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
	//   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
	//   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
	//     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
	Type param.Field[AuthRuleV2NewParamsBodyAccountLevelRuleType] `json:"type,required"`
	// Account tokens to which the Auth Rule applies.
	AccountTokens param.Field[[]string] `json:"account_tokens" format:"uuid"`
	// Business Account tokens to which the Auth Rule applies.
	BusinessAccountTokens param.Field[[]string] `json:"business_account_tokens" format:"uuid"`
	// The event stream during which the rule will be evaluated.
	EventStream param.Field[EventStream] `json:"event_stream"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
}

func (AuthRuleV2NewParamsBodyAccountLevelRule) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyAccountLevelRuleParameters added in v0.96.0 

type AuthRuleV2NewParamsBodyAccountLevelRuleParameters struct {
	Action     param.Field[interface{}] `json:"action"`
	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[int64] `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[int64]       `json:"limit_count"`
	Merchants  param.Field[interface{}] `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period param.Field[VelocityLimitPeriodUnionParam] `json:"period"`
	// The scope the velocity is calculated for
	Scope param.Field[AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope] `json:"scope"`
}

Parameters for the Auth Rule

func (AuthRuleV2NewParamsBodyAccountLevelRuleParameters) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope added in v0.96.0 

type AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope string

The scope the velocity is calculated for 

const (
	AuthRuleV2NewParamsBodyAccountLevelRuleParametersScopeCard    AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope = "CARD"
	AuthRuleV2NewParamsBodyAccountLevelRuleParametersScopeAccount AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyAccountLevelRuleParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyAccountLevelRuleParametersUnion added in v0.96.0 

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

Parameters for the Auth Rule

Satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters, AuthRuleV2NewParamsBodyAccountLevelRuleParameters.

type AuthRuleV2NewParamsBodyAccountLevelRuleType added in v0.96.0 

type AuthRuleV2NewParamsBodyAccountLevelRuleType string

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate `event_stream` field.

  • `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
  • `VELOCITY_LIMIT`: AUTHORIZATION event stream.
  • `MERCHANT_LOCK`: AUTHORIZATION event stream.
  • `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
const (
	AuthRuleV2NewParamsBodyAccountLevelRuleTypeConditionalBlock  AuthRuleV2NewParamsBodyAccountLevelRuleType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyAccountLevelRuleTypeVelocityLimit     AuthRuleV2NewParamsBodyAccountLevelRuleType = "VELOCITY_LIMIT"
	AuthRuleV2NewParamsBodyAccountLevelRuleTypeMerchantLock      AuthRuleV2NewParamsBodyAccountLevelRuleType = "MERCHANT_LOCK"
	AuthRuleV2NewParamsBodyAccountLevelRuleTypeConditionalAction AuthRuleV2NewParamsBodyAccountLevelRuleType = "CONDITIONAL_ACTION"
)

func (AuthRuleV2NewParamsBodyAccountLevelRuleType) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyAccountLevelRuleType) IsKnown() bool

type AuthRuleV2NewParamsBodyCardLevelRule added in v0.96.0 

type AuthRuleV2NewParamsBodyCardLevelRule struct {
	// Card tokens to which the Auth Rule applies.
	CardTokens param.Field[[]string] `json:"card_tokens,required" format:"uuid"`
	// Parameters for the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyCardLevelRuleParametersUnion] `json:"parameters,required"`
	// The type of Auth Rule. For certain rule types, this determines the event stream
	// during which it will be evaluated. For rules that can be applied to one of
	// several event streams, the effective one is defined by the separate
	// `event_stream` field.
	//
	//   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
	//   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
	//   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
	//   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
	//     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
	Type param.Field[AuthRuleV2NewParamsBodyCardLevelRuleType] `json:"type,required"`
	// The event stream during which the rule will be evaluated.
	EventStream param.Field[EventStream] `json:"event_stream"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
}

func (AuthRuleV2NewParamsBodyCardLevelRule) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyCardLevelRuleParameters added in v0.96.0 

type AuthRuleV2NewParamsBodyCardLevelRuleParameters struct {
	Action     param.Field[interface{}] `json:"action"`
	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[int64] `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[int64]       `json:"limit_count"`
	Merchants  param.Field[interface{}] `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period param.Field[VelocityLimitPeriodUnionParam] `json:"period"`
	// The scope the velocity is calculated for
	Scope param.Field[AuthRuleV2NewParamsBodyCardLevelRuleParametersScope] `json:"scope"`
}

Parameters for the Auth Rule

func (AuthRuleV2NewParamsBodyCardLevelRuleParameters) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyCardLevelRuleParametersScope added in v0.96.0 

type AuthRuleV2NewParamsBodyCardLevelRuleParametersScope string

The scope the velocity is calculated for 

const (
	AuthRuleV2NewParamsBodyCardLevelRuleParametersScopeCard    AuthRuleV2NewParamsBodyCardLevelRuleParametersScope = "CARD"
	AuthRuleV2NewParamsBodyCardLevelRuleParametersScopeAccount AuthRuleV2NewParamsBodyCardLevelRuleParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyCardLevelRuleParametersScope) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyCardLevelRuleParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyCardLevelRuleParametersUnion added in v0.96.0 

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

Parameters for the Auth Rule

Satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters, AuthRuleV2NewParamsBodyCardLevelRuleParameters.

type AuthRuleV2NewParamsBodyCardLevelRuleType added in v0.96.0 

type AuthRuleV2NewParamsBodyCardLevelRuleType string

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate `event_stream` field.

  • `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
  • `VELOCITY_LIMIT`: AUTHORIZATION event stream.
  • `MERCHANT_LOCK`: AUTHORIZATION event stream.
  • `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
const (
	AuthRuleV2NewParamsBodyCardLevelRuleTypeConditionalBlock  AuthRuleV2NewParamsBodyCardLevelRuleType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyCardLevelRuleTypeVelocityLimit     AuthRuleV2NewParamsBodyCardLevelRuleType = "VELOCITY_LIMIT"
	AuthRuleV2NewParamsBodyCardLevelRuleTypeMerchantLock      AuthRuleV2NewParamsBodyCardLevelRuleType = "MERCHANT_LOCK"
	AuthRuleV2NewParamsBodyCardLevelRuleTypeConditionalAction AuthRuleV2NewParamsBodyCardLevelRuleType = "CONDITIONAL_ACTION"
)

func (AuthRuleV2NewParamsBodyCardLevelRuleType) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyCardLevelRuleType) IsKnown() bool

type AuthRuleV2NewParamsBodyProgramLevelRule added in v0.96.0 

type AuthRuleV2NewParamsBodyProgramLevelRule struct {
	// Parameters for the Auth Rule
	Parameters param.Field[AuthRuleV2NewParamsBodyProgramLevelRuleParametersUnion] `json:"parameters,required"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level,required"`
	// The type of Auth Rule. For certain rule types, this determines the event stream
	// during which it will be evaluated. For rules that can be applied to one of
	// several event streams, the effective one is defined by the separate
	// `event_stream` field.
	//
	//   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
	//   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
	//   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
	//   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
	//     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
	Type param.Field[AuthRuleV2NewParamsBodyProgramLevelRuleType] `json:"type,required"`
	// The event stream during which the rule will be evaluated.
	EventStream param.Field[EventStream] `json:"event_stream"`
	// Card tokens to which the Auth Rule does not apply.
	ExcludedCardTokens param.Field[[]string] `json:"excluded_card_tokens" format:"uuid"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
}

func (AuthRuleV2NewParamsBodyProgramLevelRule) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyProgramLevelRuleParameters added in v0.96.0 

type AuthRuleV2NewParamsBodyProgramLevelRuleParameters struct {
	Action     param.Field[interface{}] `json:"action"`
	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[int64] `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[int64]       `json:"limit_count"`
	Merchants  param.Field[interface{}] `json:"merchants"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period param.Field[VelocityLimitPeriodUnionParam] `json:"period"`
	// The scope the velocity is calculated for
	Scope param.Field[AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope] `json:"scope"`
}

Parameters for the Auth Rule

func (AuthRuleV2NewParamsBodyProgramLevelRuleParameters) MarshalJSON added in v0.96.0 

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

type AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope added in v0.96.0 

type AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope string

The scope the velocity is calculated for 

const (
	AuthRuleV2NewParamsBodyProgramLevelRuleParametersScopeCard    AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope = "CARD"
	AuthRuleV2NewParamsBodyProgramLevelRuleParametersScopeAccount AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope = "ACCOUNT"
)

func (AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyProgramLevelRuleParametersScope) IsKnown() bool

type AuthRuleV2NewParamsBodyProgramLevelRuleParametersUnion added in v0.96.0 

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

Parameters for the Auth Rule

Satisfied by ConditionalBlockParameters, VelocityLimitParams, MerchantLockParameters, Conditional3DSActionParameters, ConditionalAuthorizationActionParameters, ConditionalACHActionParameters, ConditionalTokenizationActionParameters, AuthRuleV2NewParamsBodyProgramLevelRuleParameters.

type AuthRuleV2NewParamsBodyProgramLevelRuleType added in v0.96.0 

type AuthRuleV2NewParamsBodyProgramLevelRuleType string

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate `event_stream` field.

  • `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
  • `VELOCITY_LIMIT`: AUTHORIZATION event stream.
  • `MERCHANT_LOCK`: AUTHORIZATION event stream.
  • `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
const (
	AuthRuleV2NewParamsBodyProgramLevelRuleTypeConditionalBlock  AuthRuleV2NewParamsBodyProgramLevelRuleType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyProgramLevelRuleTypeVelocityLimit     AuthRuleV2NewParamsBodyProgramLevelRuleType = "VELOCITY_LIMIT"
	AuthRuleV2NewParamsBodyProgramLevelRuleTypeMerchantLock      AuthRuleV2NewParamsBodyProgramLevelRuleType = "MERCHANT_LOCK"
	AuthRuleV2NewParamsBodyProgramLevelRuleTypeConditionalAction AuthRuleV2NewParamsBodyProgramLevelRuleType = "CONDITIONAL_ACTION"
)

func (AuthRuleV2NewParamsBodyProgramLevelRuleType) IsKnown added in v0.96.0 

func (r AuthRuleV2NewParamsBodyProgramLevelRuleType) IsKnown() bool

type AuthRuleV2NewParamsBodyType added in v0.51.0 

type AuthRuleV2NewParamsBodyType string

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate `event_stream` field.

  • `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
  • `VELOCITY_LIMIT`: AUTHORIZATION event stream.
  • `MERCHANT_LOCK`: AUTHORIZATION event stream.
  • `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
const (
	AuthRuleV2NewParamsBodyTypeConditionalBlock  AuthRuleV2NewParamsBodyType = "CONDITIONAL_BLOCK"
	AuthRuleV2NewParamsBodyTypeVelocityLimit     AuthRuleV2NewParamsBodyType = "VELOCITY_LIMIT"
	AuthRuleV2NewParamsBodyTypeMerchantLock      AuthRuleV2NewParamsBodyType = "MERCHANT_LOCK"
	AuthRuleV2NewParamsBodyTypeConditionalAction AuthRuleV2NewParamsBodyType = "CONDITIONAL_ACTION"
)

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 AuthRuleV2NewParamsBodyAccountLevelRule, AuthRuleV2NewParamsBodyCardLevelRule, AuthRuleV2NewParamsBodyProgramLevelRule, AuthRuleV2NewParamsBody.

type AuthRuleV2Service added in v0.51.0 

type AuthRuleV2Service struct {
	Options   []option.RequestOption
	Backtests *AuthRuleV2BacktestService
}

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) Delete added in v0.66.0 

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

Deletes a V2 Auth rule

func (*AuthRuleV2Service) Draft added in v0.51.0 

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

Creates a new draft version of a rule 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 *AuthRule, err error)

Fetches a V2 Auth rule by its token

func (*AuthRuleV2Service) GetFeatures added in v0.93.0 

func (r *AuthRuleV2Service) GetFeatures(ctx context.Context, authRuleToken string, query AuthRuleV2GetFeaturesParams, opts ...option.RequestOption) (res *AuthRuleV2GetFeaturesResponse, err error)

Fetches the current calculated Feature values for the given Auth Rule

This only calculates the features for the active version.

  • VelocityLimit Rules calculates the current Velocity Feature data. This requires a `card_token` or `account_token` matching what the rule is Scoped to.
  • ConditionalBlock Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on the rule. This requires a `card_token`

func (*AuthRuleV2Service) GetReport added in v0.80.0 

func (r *AuthRuleV2Service) GetReport(ctx context.Context, authRuleToken string, query AuthRuleV2GetReportParams, opts ...option.RequestOption) (res *AuthRuleV2GetReportResponse, err error)

Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes.

**Time Range Limitations:**

  • Reports are supported for the past 3 months only
  • Maximum interval length is 1 month
  • Report data is available only through the previous day in UTC (current day data is not available)

The report provides daily statistics for both current and draft versions of the Auth rule, including approval, decline, and challenge counts along with sample events.

func (*AuthRuleV2Service) List added in v0.51.0 

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

Lists V2 Auth rules

func (*AuthRuleV2Service) ListAutoPaging added in v0.51.0 

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

Lists V2 Auth rules

func (*AuthRuleV2Service) New added in v0.51.0 

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

Creates a new V2 Auth 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 *AuthRule, err error)

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

func (*AuthRuleV2Service) Update added in v0.51.0 

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

Updates a V2 Auth rule's properties

If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens` is provided, this will replace existing associations with the provided list of entities.

type AuthRuleV2UpdateParams added in v0.51.0 

type AuthRuleV2UpdateParams struct {
	Body AuthRuleV2UpdateParamsBodyUnion `json:"body,required"`
}

func (AuthRuleV2UpdateParams) MarshalJSON added in v0.51.0 

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

type AuthRuleV2UpdateParamsBody added in v0.66.0 

type AuthRuleV2UpdateParamsBody struct {
	AccountTokens         param.Field[interface{}] `json:"account_tokens"`
	BusinessAccountTokens param.Field[interface{}] `json:"business_account_tokens"`
	CardTokens            param.Field[interface{}] `json:"card_tokens"`
	ExcludedCardTokens    param.Field[interface{}] `json:"excluded_card_tokens"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level"`
	// 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[AuthRuleV2UpdateParamsBodyState] `json:"state"`
}

func (AuthRuleV2UpdateParamsBody) MarshalJSON added in v0.66.0 

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

type AuthRuleV2UpdateParamsBodyAccountLevelRule added in v0.66.0 

type AuthRuleV2UpdateParamsBodyAccountLevelRule struct {
	// Account tokens to which the Auth Rule applies.
	AccountTokens param.Field[[]string] `json:"account_tokens" format:"uuid"`
	// Business Account tokens to which the Auth Rule applies.
	BusinessAccountTokens param.Field[[]string] `json:"business_account_tokens" format:"uuid"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
	// 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[AuthRuleV2UpdateParamsBodyAccountLevelRuleState] `json:"state"`
}

func (AuthRuleV2UpdateParamsBodyAccountLevelRule) MarshalJSON added in v0.66.0 

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

type AuthRuleV2UpdateParamsBodyAccountLevelRuleState added in v0.66.0 

type AuthRuleV2UpdateParamsBodyAccountLevelRuleState 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 (
	AuthRuleV2UpdateParamsBodyAccountLevelRuleStateInactive AuthRuleV2UpdateParamsBodyAccountLevelRuleState = "INACTIVE"
)

func (AuthRuleV2UpdateParamsBodyAccountLevelRuleState) IsKnown added in v0.66.0 

func (r AuthRuleV2UpdateParamsBodyAccountLevelRuleState) IsKnown() bool

type AuthRuleV2UpdateParamsBodyCardLevelRule added in v0.66.0 

type AuthRuleV2UpdateParamsBodyCardLevelRule struct {
	// Card tokens to which the Auth Rule applies.
	CardTokens param.Field[[]string] `json:"card_tokens" format:"uuid"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
	// 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[AuthRuleV2UpdateParamsBodyCardLevelRuleState] `json:"state"`
}

func (AuthRuleV2UpdateParamsBodyCardLevelRule) MarshalJSON added in v0.66.0 

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

type AuthRuleV2UpdateParamsBodyCardLevelRuleState added in v0.66.0 

type AuthRuleV2UpdateParamsBodyCardLevelRuleState 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 (
	AuthRuleV2UpdateParamsBodyCardLevelRuleStateInactive AuthRuleV2UpdateParamsBodyCardLevelRuleState = "INACTIVE"
)

func (AuthRuleV2UpdateParamsBodyCardLevelRuleState) IsKnown added in v0.66.0 

func (r AuthRuleV2UpdateParamsBodyCardLevelRuleState) IsKnown() bool

type AuthRuleV2UpdateParamsBodyProgramLevelRule added in v0.66.0 

type AuthRuleV2UpdateParamsBodyProgramLevelRule struct {
	// Card tokens to which the Auth Rule does not apply.
	ExcludedCardTokens param.Field[[]string] `json:"excluded_card_tokens" format:"uuid"`
	// Auth Rule Name
	Name param.Field[string] `json:"name"`
	// Whether the Auth Rule applies to all authorizations on the card program.
	ProgramLevel param.Field[bool] `json:"program_level"`
	// 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[AuthRuleV2UpdateParamsBodyProgramLevelRuleState] `json:"state"`
}

func (AuthRuleV2UpdateParamsBodyProgramLevelRule) MarshalJSON added in v0.66.0 

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

type AuthRuleV2UpdateParamsBodyProgramLevelRuleState added in v0.66.0 

type AuthRuleV2UpdateParamsBodyProgramLevelRuleState 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 (
	AuthRuleV2UpdateParamsBodyProgramLevelRuleStateInactive AuthRuleV2UpdateParamsBodyProgramLevelRuleState = "INACTIVE"
)

func (AuthRuleV2UpdateParamsBodyProgramLevelRuleState) IsKnown added in v0.66.0 

func (r AuthRuleV2UpdateParamsBodyProgramLevelRuleState) IsKnown() bool

type AuthRuleV2UpdateParamsBodyState added in v0.66.0 

type AuthRuleV2UpdateParamsBodyState 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 (
	AuthRuleV2UpdateParamsBodyStateInactive AuthRuleV2UpdateParamsBodyState = "INACTIVE"
)

func (AuthRuleV2UpdateParamsBodyState) IsKnown added in v0.66.0 

func (r AuthRuleV2UpdateParamsBodyState) IsKnown() bool

type AuthRuleV2UpdateParamsBodyUnion added in v0.66.0 

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

Satisfied by AuthRuleV2UpdateParamsBodyAccountLevelRule, AuthRuleV2UpdateParamsBodyCardLevelRule, AuthRuleV2UpdateParamsBodyProgramLevelRule, AuthRuleV2UpdateParamsBody.

type AuthRulesBacktestReportCreatedWebhookEvent added in v0.98.0 

type AuthRulesBacktestReportCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType AuthRulesBacktestReportCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      authRulesBacktestReportCreatedWebhookEventJSON      `json:"-"`
	BacktestResults
}

func (*AuthRulesBacktestReportCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type AuthRulesBacktestReportCreatedWebhookEventEventType added in v0.98.0 

type AuthRulesBacktestReportCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	AuthRulesBacktestReportCreatedWebhookEventEventTypeAuthRulesBacktestReportCreated AuthRulesBacktestReportCreatedWebhookEventEventType = "auth_rules.backtest_report.created"
)

func (AuthRulesBacktestReportCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r AuthRulesBacktestReportCreatedWebhookEventEventType) 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 BacktestResults added in v0.64.0 

type BacktestResults struct {
	// Auth Rule Backtest Token
	BacktestToken        string                              `json:"backtest_token,required" format:"uuid"`
	Results              BacktestResultsResults              `json:"results,required"`
	SimulationParameters BacktestResultsSimulationParameters `json:"simulation_parameters,required"`
	JSON                 backtestResultsJSON                 `json:"-"`
}

func (*BacktestResults) UnmarshalJSON added in v0.64.0 

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

type BacktestResultsResults added in v0.64.0 

type BacktestResultsResults struct {
	CurrentVersion RuleStats                  `json:"current_version,nullable"`
	DraftVersion   RuleStats                  `json:"draft_version,nullable"`
	JSON           backtestResultsResultsJSON `json:"-"`
}

func (*BacktestResultsResults) UnmarshalJSON added in v0.64.0 

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

type BacktestResultsSimulationParameters added in v0.64.0 

type BacktestResultsSimulationParameters struct {
	// Auth Rule Token
	AuthRuleToken string `json:"auth_rule_token" format:"uuid"`
	// The end time of the simulation.
	End time.Time `json:"end" format:"date-time"`
	// The start time of the simulation.
	Start time.Time                               `json:"start" format:"date-time"`
	JSON  backtestResultsSimulationParametersJSON `json:"-"`
}

func (*BacktestResultsSimulationParameters) UnmarshalJSON added in v0.64.0 

func (r *BacktestResultsSimulationParameters) 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-character 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"
	BalanceFinancialAccountTypeSecurity  BalanceFinancialAccountType = "SECURITY"
)

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"
	BalanceListParamsFinancialAccountTypeSecurity  BalanceListParamsFinancialAccountType = "SECURITY"
)

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 BalanceUpdatedWebhookEvent added in v0.98.0 

type BalanceUpdatedWebhookEvent struct {
	Data []FinancialAccountBalance `json:"data,required"`
	// The type of event that occurred.
	EventType BalanceUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      balanceUpdatedWebhookEventJSON      `json:"-"`
}

func (*BalanceUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type BalanceUpdatedWebhookEventEventType added in v0.98.0 

type BalanceUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	BalanceUpdatedWebhookEventEventTypeBalanceUpdated BalanceUpdatedWebhookEventEventType = "balance.updated"
)

func (BalanceUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r BalanceUpdatedWebhookEventEventType) IsKnown() bool

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 (
	BookTransferListParamsCategoryAdjustment       BookTransferListParamsCategory = "ADJUSTMENT"
	BookTransferListParamsCategoryBalanceOrFunding BookTransferListParamsCategory = "BALANCE_OR_FUNDING"
	BookTransferListParamsCategoryDerecognition    BookTransferListParamsCategory = "DERECOGNITION"
	BookTransferListParamsCategoryDispute          BookTransferListParamsCategory = "DISPUTE"
	BookTransferListParamsCategoryFee              BookTransferListParamsCategory = "FEE"
	BookTransferListParamsCategoryInternal         BookTransferListParamsCategory = "INTERNAL"
	BookTransferListParamsCategoryReward           BookTransferListParamsCategory = "REWARD"
	BookTransferListParamsCategoryProgramFunding   BookTransferListParamsCategory = "PROGRAM_FUNDING"
	BookTransferListParamsCategoryTransfer         BookTransferListParamsCategory = "TRANSFER"
)

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 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 the 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"`
	// External ID defined by the customer
	ExternalID param.Field[string] `json:"external_id"`
	// Optional descriptor for the transfer.
	Memo param.Field[string] `json:"memo"`
	// What to do if the financial account is closed when posting an operation
	OnClosedAccount param.Field[BookTransferNewParamsOnClosedAccount] `json:"on_closed_account"`
}

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
const (
	BookTransferNewParamsCategoryAdjustment       BookTransferNewParamsCategory = "ADJUSTMENT"
	BookTransferNewParamsCategoryBalanceOrFunding BookTransferNewParamsCategory = "BALANCE_OR_FUNDING"
	BookTransferNewParamsCategoryDerecognition    BookTransferNewParamsCategory = "DERECOGNITION"
	BookTransferNewParamsCategoryDispute          BookTransferNewParamsCategory = "DISPUTE"
	BookTransferNewParamsCategoryFee              BookTransferNewParamsCategory = "FEE"
	BookTransferNewParamsCategoryInternal         BookTransferNewParamsCategory = "INTERNAL"
	BookTransferNewParamsCategoryReward           BookTransferNewParamsCategory = "REWARD"
	BookTransferNewParamsCategoryProgramFunding   BookTransferNewParamsCategory = "PROGRAM_FUNDING"
	BookTransferNewParamsCategoryTransfer         BookTransferNewParamsCategory = "TRANSFER"
)

func (BookTransferNewParamsCategory) IsKnown added in v0.35.0 

func (r BookTransferNewParamsCategory) IsKnown() bool

type BookTransferNewParamsOnClosedAccount added in v0.89.0 

type BookTransferNewParamsOnClosedAccount string

What to do if the financial account is closed when posting an operation 

const (
	BookTransferNewParamsOnClosedAccountFail        BookTransferNewParamsOnClosedAccount = "FAIL"
	BookTransferNewParamsOnClosedAccountUseSuspense BookTransferNewParamsOnClosedAccount = "USE_SUSPENSE"
)

func (BookTransferNewParamsOnClosedAccount) IsKnown added in v0.89.0 

func (r BookTransferNewParamsOnClosedAccount) IsKnown() bool

type BookTransferNewParamsType added in v0.35.0 

type BookTransferNewParamsType string

Type of the book transfer 

const (
	BookTransferNewParamsTypeAtmBalanceInquiry          BookTransferNewParamsType = "ATM_BALANCE_INQUIRY"
	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"
	BookTransferNewParamsTypeService                    BookTransferNewParamsType = "SERVICE"
	BookTransferNewParamsTypeTransfer                   BookTransferNewParamsType = "TRANSFER"
	BookTransferNewParamsTypeCollection                 BookTransferNewParamsType = "COLLECTION"
)

func (BookTransferNewParamsType) IsKnown added in v0.35.0 

func (r BookTransferNewParamsType) IsKnown() bool

type BookTransferResponse added in v0.35.0 

type BookTransferResponse struct {
	// Unique identifier for the transaction
	Token    string                       `json:"token,required" format:"uuid"`
	Category BookTransferResponseCategory `json:"category,required"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-character 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"`
	// TRANSFER - Book Transfer Transaction
	Family BookTransferResponseFamily `json:"family,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"`
	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"`
	// The status of the transaction
	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 string `json:"to_financial_account_token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// External ID defined by the customer
	ExternalID string `json:"external_id,nullable"`
	// External resource associated with the management operation
	ExternalResource ExternalResource `json:"external_resource,nullable"`
	// A series of transactions that are grouped together
	TransactionSeries BookTransferResponseTransactionSeries `json:"transaction_series,nullable"`
	JSON              bookTransferResponseJSON              `json:"-"`
}

Book transfer transaction

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
const (
	BookTransferResponseCategoryAdjustment       BookTransferResponseCategory = "ADJUSTMENT"
	BookTransferResponseCategoryBalanceOrFunding BookTransferResponseCategory = "BALANCE_OR_FUNDING"
	BookTransferResponseCategoryDerecognition    BookTransferResponseCategory = "DERECOGNITION"
	BookTransferResponseCategoryDispute          BookTransferResponseCategory = "DISPUTE"
	BookTransferResponseCategoryFee              BookTransferResponseCategory = "FEE"
	BookTransferResponseCategoryInternal         BookTransferResponseCategory = "INTERNAL"
	BookTransferResponseCategoryReward           BookTransferResponseCategory = "REWARD"
	BookTransferResponseCategoryProgramFunding   BookTransferResponseCategory = "PROGRAM_FUNDING"
	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"`
	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 BookTransferResponseEventsType `json:"type,required"`
	JSON bookTransferResponseEventJSON  `json:"-"`
}

Book transfer Event

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 BookTransferResponseEventsType added in v0.89.0 

type BookTransferResponseEventsType string

Type of the book transfer 

const (
	BookTransferResponseEventsTypeAtmBalanceInquiry          BookTransferResponseEventsType = "ATM_BALANCE_INQUIRY"
	BookTransferResponseEventsTypeAtmWithdrawal              BookTransferResponseEventsType = "ATM_WITHDRAWAL"
	BookTransferResponseEventsTypeAtmDecline                 BookTransferResponseEventsType = "ATM_DECLINE"
	BookTransferResponseEventsTypeInternationalAtmWithdrawal BookTransferResponseEventsType = "INTERNATIONAL_ATM_WITHDRAWAL"
	BookTransferResponseEventsTypeInactivity                 BookTransferResponseEventsType = "INACTIVITY"
	BookTransferResponseEventsTypeStatement                  BookTransferResponseEventsType = "STATEMENT"
	BookTransferResponseEventsTypeMonthly                    BookTransferResponseEventsType = "MONTHLY"
	BookTransferResponseEventsTypeQuarterly                  BookTransferResponseEventsType = "QUARTERLY"
	BookTransferResponseEventsTypeAnnual                     BookTransferResponseEventsType = "ANNUAL"
	BookTransferResponseEventsTypeCustomerService            BookTransferResponseEventsType = "CUSTOMER_SERVICE"
	BookTransferResponseEventsTypeAccountMaintenance         BookTransferResponseEventsType = "ACCOUNT_MAINTENANCE"
	BookTransferResponseEventsTypeAccountActivation          BookTransferResponseEventsType = "ACCOUNT_ACTIVATION"
	BookTransferResponseEventsTypeAccountClosure             BookTransferResponseEventsType = "ACCOUNT_CLOSURE"
	BookTransferResponseEventsTypeCardReplacement            BookTransferResponseEventsType = "CARD_REPLACEMENT"
	BookTransferResponseEventsTypeCardDelivery               BookTransferResponseEventsType = "CARD_DELIVERY"
	BookTransferResponseEventsTypeCardCreate                 BookTransferResponseEventsType = "CARD_CREATE"
	BookTransferResponseEventsTypeCurrencyConversion         BookTransferResponseEventsType = "CURRENCY_CONVERSION"
	BookTransferResponseEventsTypeInterest                   BookTransferResponseEventsType = "INTEREST"
	BookTransferResponseEventsTypeLatePayment                BookTransferResponseEventsType = "LATE_PAYMENT"
	BookTransferResponseEventsTypeBillPayment                BookTransferResponseEventsType = "BILL_PAYMENT"
	BookTransferResponseEventsTypeCashBack                   BookTransferResponseEventsType = "CASH_BACK"
	BookTransferResponseEventsTypeAccountToAccount           BookTransferResponseEventsType = "ACCOUNT_TO_ACCOUNT"
	BookTransferResponseEventsTypeCardToCard                 BookTransferResponseEventsType = "CARD_TO_CARD"
	BookTransferResponseEventsTypeDisburse                   BookTransferResponseEventsType = "DISBURSE"
	BookTransferResponseEventsTypeBillingError               BookTransferResponseEventsType = "BILLING_ERROR"
	BookTransferResponseEventsTypeLossWriteOff               BookTransferResponseEventsType = "LOSS_WRITE_OFF"
	BookTransferResponseEventsTypeExpiredCard                BookTransferResponseEventsType = "EXPIRED_CARD"
	BookTransferResponseEventsTypeEarlyDerecognition         BookTransferResponseEventsType = "EARLY_DERECOGNITION"
	BookTransferResponseEventsTypeEscheatment                BookTransferResponseEventsType = "ESCHEATMENT"
	BookTransferResponseEventsTypeInactivityFeeDown          BookTransferResponseEventsType = "INACTIVITY_FEE_DOWN"
	BookTransferResponseEventsTypeProvisionalCredit          BookTransferResponseEventsType = "PROVISIONAL_CREDIT"
	BookTransferResponseEventsTypeDisputeWon                 BookTransferResponseEventsType = "DISPUTE_WON"
	BookTransferResponseEventsTypeService                    BookTransferResponseEventsType = "SERVICE"
	BookTransferResponseEventsTypeTransfer                   BookTransferResponseEventsType = "TRANSFER"
	BookTransferResponseEventsTypeCollection                 BookTransferResponseEventsType = "COLLECTION"
)

func (BookTransferResponseEventsType) IsKnown added in v0.89.0 

func (r BookTransferResponseEventsType) IsKnown() bool

type BookTransferResponseFamily added in v0.95.0 

type BookTransferResponseFamily string

TRANSFER - Book Transfer Transaction 

const (
	BookTransferResponseFamilyTransfer BookTransferResponseFamily = "TRANSFER"
)

func (BookTransferResponseFamily) IsKnown added in v0.95.0 

func (r BookTransferResponseFamily) IsKnown() bool

type BookTransferResponseResult added in v0.35.0 

type BookTransferResponseResult string
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

The status of the transaction 

const (
	BookTransferResponseStatusPending  BookTransferResponseStatus = "PENDING"
	BookTransferResponseStatusSettled  BookTransferResponseStatus = "SETTLED"
	BookTransferResponseStatusDeclined BookTransferResponseStatus = "DECLINED"
	BookTransferResponseStatusReversed BookTransferResponseStatus = "REVERSED"
	BookTransferResponseStatusCanceled BookTransferResponseStatus = "CANCELED"
	BookTransferResponseStatusReturned BookTransferResponseStatus = "RETURNED"
)

func (BookTransferResponseStatus) IsKnown added in v0.35.0 

func (r BookTransferResponseStatus) IsKnown() bool

type BookTransferResponseTransactionSeries added in v0.87.0 

type BookTransferResponseTransactionSeries struct {
	RelatedTransactionEventToken string                                    `json:"related_transaction_event_token,required,nullable" format:"uuid"`
	RelatedTransactionToken      string                                    `json:"related_transaction_token,required,nullable" format:"uuid"`
	Type                         string                                    `json:"type,required"`
	JSON                         bookTransferResponseTransactionSeriesJSON `json:"-"`
}

A series of transactions that are grouped together

func (*BookTransferResponseTransactionSeries) UnmarshalJSON added in v0.87.0 

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

type BookTransferRetryParams added in v0.99.0 

type BookTransferRetryParams struct {
	// Customer-provided token that will serve as an idempotency token. This token will
	// become the transaction token.
	RetryToken param.Field[string] `json:"retry_token,required" format:"uuid"`
}

func (BookTransferRetryParams) MarshalJSON added in v0.99.0 

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

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) Retry added in v0.99.0 

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

Retry a book transfer that has been declined

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 BookTransferTransactionCreatedWebhookEvent added in v0.98.0 

type BookTransferTransactionCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType BookTransferTransactionCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      bookTransferTransactionCreatedWebhookEventJSON      `json:"-"`
	BookTransferResponse
}

Book transfer transaction

func (*BookTransferTransactionCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type BookTransferTransactionCreatedWebhookEventEventType added in v0.98.0 

type BookTransferTransactionCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	BookTransferTransactionCreatedWebhookEventEventTypeBookTransferTransactionCreated BookTransferTransactionCreatedWebhookEventEventType = "book_transfer_transaction.created"
)

func (BookTransferTransactionCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r BookTransferTransactionCreatedWebhookEventEventType) IsKnown() bool

type BookTransferTransactionUpdatedWebhookEvent added in v0.98.0 

type BookTransferTransactionUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType BookTransferTransactionUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      bookTransferTransactionUpdatedWebhookEventJSON      `json:"-"`
	BookTransferResponse
}

Book transfer transaction

func (*BookTransferTransactionUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type BookTransferTransactionUpdatedWebhookEventEventType added in v0.98.0 

type BookTransferTransactionUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	BookTransferTransactionUpdatedWebhookEventEventTypeBookTransferTransactionUpdated BookTransferTransactionUpdatedWebhookEventEventType = "book_transfer_transaction.updated"
)

func (BookTransferTransactionUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r BookTransferTransactionUpdatedWebhookEventEventType) IsKnown() bool

type Card 

type Card struct {
	// Three digit cvv printed on the back of the card.
	Cvv string `json:"cvv"`
	// 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 for questions.
	Pan  string   `json:"pan"`
	JSON cardJSON `json:"-"`
	NonPCICard
}

Card details with potentially PCI sensitive information for Enterprise customers

func (*Card) UnmarshalJSON 

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

type CardAuthorizationApprovalRequestWebhookEvent added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEvent struct {
	// The provisional transaction group uuid associated with the authorization
	Token string `json:"token,required" format:"uuid"`
	// Fee (in cents) assessed by the merchant and paid for by the cardholder. 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"`
	// Authorization amount of the transaction (in cents), including any acquirer fees.
	// The contents of this field are identical to `authorization_amount`.
	Amount int64 `json:"amount,required"`
	// The base transaction amount (in cents) plus the acquirer fee field. This is the
	// amount the issuer should authorize against unless the issuer is paying the
	// acquirer fee on behalf of the cardholder.
	AuthorizationAmount int64                                           `json:"authorization_amount,required"`
	Avs                 CardAuthorizationApprovalRequestWebhookEventAvs `json:"avs,required"`
	// Card object in ASA
	Card CardAuthorizationApprovalRequestWebhookEventCard `json:"card,required"`
	// 3-character alphabetic ISO 4217 code for cardholder's billing currency.
	CardholderCurrency string `json:"cardholder_currency,required"`
	// The portion of the transaction requested as cash back by the cardholder, and
	// does not include any acquirer fees. The amount field includes the purchase
	// amount, the requested cash back amount, and any acquirer fees.
	//
	// If no cash back was requested, the value of this field will be 0, and the field
	// will always be present.
	CashAmount int64 `json:"cash_amount,required"`
	// Date and time when the transaction first occurred in UTC.
	Created   time.Time                                             `json:"created,required" format:"date-time"`
	EventType CardAuthorizationApprovalRequestWebhookEventEventType `json:"event_type,required"`
	Merchant  shared.Merchant                                       `json:"merchant,required"`
	// The amount that the merchant will receive, denominated in `merchant_currency`
	// and in the smallest currency unit. Note the amount includes `acquirer_fee`,
	// similar to `authorization_amount`. It will be different from
	// `authorization_amount` if the merchant is taking payment in a different
	// currency.
	MerchantAmount int64 `json:"merchant_amount,required"`
	// 3-character alphabetic ISO 4217 code for the local currency of the transaction.
	MerchantCurrency string `json:"merchant_currency,required"`
	// Amount (in cents) of the transaction that has been settled, including any
	// acquirer fees
	SettledAmount int64 `json:"settled_amount,required"`
	// The type of authorization request that this request is for. Note that
	// `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
	// users with credit decisioning via ASA enabled.
	Status CardAuthorizationApprovalRequestWebhookEventStatus `json:"status,required"`
	// The entity that initiated the transaction.
	TransactionInitiator     CardAuthorizationApprovalRequestWebhookEventTransactionInitiator `json:"transaction_initiator,required"`
	AccountType              CardAuthorizationApprovalRequestWebhookEventAccountType          `json:"account_type"`
	CardholderAuthentication CardholderAuthentication                                         `json:"cardholder_authentication"`
	// Deprecated, use `cash_amount`.
	Cashback int64 `json:"cashback"`
	// If the transaction was requested in a currency other than the settlement
	// currency, this field will be populated to indicate the rate used to translate
	// the merchant_amount to the amount (i.e., `merchant_amount` x `conversion_rate` =
	// `amount`). Note that the `merchant_amount` is in the local currency and the
	// amount is in the settlement currency.
	ConversionRate float64 `json:"conversion_rate"`
	// The event token associated with the authorization. This field is only set for
	// programs enrolled into the beta.
	EventToken string `json:"event_token" format:"uuid"`
	// Optional Object containing information if the Card is a part of a Fleet managed
	// program
	FleetInfo CardAuthorizationApprovalRequestWebhookEventFleetInfo `json:"fleet_info,nullable"`
	// The latest Authorization Challenge that was issued to the cardholder for this
	// merchant.
	LatestChallenge CardAuthorizationApprovalRequestWebhookEventLatestChallenge `json:"latest_challenge"`
	// Card network of the authorization.
	Network CardAuthorizationApprovalRequestWebhookEventNetwork `json:"network"`
	// 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,nullable"`
	// Contains raw data provided by the card network, including attributes that
	// provide further context about the authorization. If populated by the network,
	// data is organized by Lithic and passed through without further modification.
	// Please consult the official network documentation for more details about these
	// values and how to use them. This object is only available to certain programs-
	// contact your Customer Success Manager to discuss enabling access.
	NetworkSpecificData CardAuthorizationApprovalRequestWebhookEventNetworkSpecificData `json:"network_specific_data,nullable"`
	Pos                 CardAuthorizationApprovalRequestWebhookEventPos                 `json:"pos"`
	TokenInfo           TokenInfo                                                       `json:"token_info,nullable"`
	// Deprecated: approximate time-to-live for the authorization.
	Ttl  time.Time                                        `json:"ttl" format:"date-time"`
	JSON cardAuthorizationApprovalRequestWebhookEventJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEvent) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventAccountType added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventAccountType string
const (
	CardAuthorizationApprovalRequestWebhookEventAccountTypeChecking CardAuthorizationApprovalRequestWebhookEventAccountType = "CHECKING"
	CardAuthorizationApprovalRequestWebhookEventAccountTypeSavings  CardAuthorizationApprovalRequestWebhookEventAccountType = "SAVINGS"
)

func (CardAuthorizationApprovalRequestWebhookEventAccountType) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventAccountType) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventAvs added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventAvs struct {
	// Cardholder address
	Address string `json:"address,required"`
	// Lithic's evaluation result comparing the transaction's address data with the
	// cardholder KYC data if it exists. In the event Lithic does not have any
	// Cardholder KYC data, or the transaction does not contain any address data,
	// NOT_PRESENT will be returned
	AddressOnFileMatch CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch `json:"address_on_file_match,required"`
	// Cardholder ZIP code
	Zipcode string                                              `json:"zipcode,required"`
	JSON    cardAuthorizationApprovalRequestWebhookEventAvsJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventAvs) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch string

Lithic's evaluation result comparing the transaction's address data with the cardholder KYC data if it exists. In the event Lithic does not have any Cardholder KYC data, or the transaction does not contain any address data, NOT_PRESENT will be returned 

const (
	CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatchMatch            CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch = "MATCH"
	CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatchMatchAddressOnly CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch = "MATCH_ADDRESS_ONLY"
	CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatchMatchZipOnly     CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch = "MATCH_ZIP_ONLY"
	CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatchMismatch         CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch = "MISMATCH"
	CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatchNotPresent       CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch = "NOT_PRESENT"
)

func (CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventAvsAddressOnFileMatch) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventCard added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventCard struct {
	// Globally unique identifier for the card.
	Token string `json:"token" format:"uuid"`
	// Hostname of card’s locked merchant (will be empty if not applicable)
	Hostname string `json:"hostname"`
	// Last four digits of the card number
	LastFour string `json:"last_four"`
	// Customizable name to identify the card. We recommend against using this field to
	// store JSON data as it can cause unexpected behavior.
	Memo string `json:"memo"`
	// Amount (in cents) to limit approved authorizations. Purchase requests above the
	// spend limit will be declined (refunds and credits will be approved).
	//
	// Note that while spend limits are enforced based on authorized and settled volume
	// on a card, they are not recommended to be used for balance or
	// reconciliation-level accuracy. Spend limits also cannot block force posted
	// charges (i.e., when a merchant sends a clearing message without a prior
	// authorization).
	SpendLimit int64 `json:"spend_limit"`
	// Note that 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.
	SpendLimitDuration CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration `json:"spend_limit_duration"`
	State              CardAuthorizationApprovalRequestWebhookEventCardState              `json:"state"`
	Type               CardAuthorizationApprovalRequestWebhookEventCardType               `json:"type"`
	JSON               cardAuthorizationApprovalRequestWebhookEventCardJSON               `json:"-"`
}

Card object in ASA

func (*CardAuthorizationApprovalRequestWebhookEventCard) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration string

Note that 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. 

const (
	CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDurationAnnually    CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration = "ANNUALLY"
	CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDurationForever     CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration = "FOREVER"
	CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDurationMonthly     CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration = "MONTHLY"
	CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDurationTransaction CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration = "TRANSACTION"
)

func (CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventCardSpendLimitDuration) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventCardState added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventCardState string
const (
	CardAuthorizationApprovalRequestWebhookEventCardStateClosed             CardAuthorizationApprovalRequestWebhookEventCardState = "CLOSED"
	CardAuthorizationApprovalRequestWebhookEventCardStateOpen               CardAuthorizationApprovalRequestWebhookEventCardState = "OPEN"
	CardAuthorizationApprovalRequestWebhookEventCardStatePaused             CardAuthorizationApprovalRequestWebhookEventCardState = "PAUSED"
	CardAuthorizationApprovalRequestWebhookEventCardStatePendingActivation  CardAuthorizationApprovalRequestWebhookEventCardState = "PENDING_ACTIVATION"
	CardAuthorizationApprovalRequestWebhookEventCardStatePendingFulfillment CardAuthorizationApprovalRequestWebhookEventCardState = "PENDING_FULFILLMENT"
)

func (CardAuthorizationApprovalRequestWebhookEventCardState) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventCardState) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventCardType added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventCardType string
const (
	CardAuthorizationApprovalRequestWebhookEventCardTypeSingleUse      CardAuthorizationApprovalRequestWebhookEventCardType = "SINGLE_USE"
	CardAuthorizationApprovalRequestWebhookEventCardTypeMerchantLocked CardAuthorizationApprovalRequestWebhookEventCardType = "MERCHANT_LOCKED"
	CardAuthorizationApprovalRequestWebhookEventCardTypeUnlocked       CardAuthorizationApprovalRequestWebhookEventCardType = "UNLOCKED"
	CardAuthorizationApprovalRequestWebhookEventCardTypePhysical       CardAuthorizationApprovalRequestWebhookEventCardType = "PHYSICAL"
	CardAuthorizationApprovalRequestWebhookEventCardTypeDigitalWallet  CardAuthorizationApprovalRequestWebhookEventCardType = "DIGITAL_WALLET"
	CardAuthorizationApprovalRequestWebhookEventCardTypeVirtual        CardAuthorizationApprovalRequestWebhookEventCardType = "VIRTUAL"
)

func (CardAuthorizationApprovalRequestWebhookEventCardType) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventCardType) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventEventType added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventEventType string
const (
	CardAuthorizationApprovalRequestWebhookEventEventTypeCardAuthorizationApprovalRequest CardAuthorizationApprovalRequestWebhookEventEventType = "card_authorization.approval_request"
)

func (CardAuthorizationApprovalRequestWebhookEventEventType) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventEventType) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventFleetInfo added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventFleetInfo struct {
	// Code indicating what the driver was prompted to enter at time of purchase. This
	// is configured at a program level and is a static configuration, and does not
	// change on a request to request basis
	FleetPromptCode CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode `json:"fleet_prompt_code,required"`
	// Code indicating which restrictions, if any, there are on purchase. This is
	// configured at a program level and is a static configuration, and does not change
	// on a request to request basis
	FleetRestrictionCode CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode `json:"fleet_restriction_code,required"`
	// Number representing the driver
	DriverNumber string `json:"driver_number,nullable"`
	// Number associated with the vehicle
	VehicleNumber string                                                    `json:"vehicle_number,nullable"`
	JSON          cardAuthorizationApprovalRequestWebhookEventFleetInfoJSON `json:"-"`
}

Optional Object containing information if the Card is a part of a Fleet managed program

func (*CardAuthorizationApprovalRequestWebhookEventFleetInfo) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode string

Code indicating what the driver was prompted to enter at time of purchase. This is configured at a program level and is a static configuration, and does not change on a request to request basis 

const (
	CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCodeNoPrompt      CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode = "NO_PROMPT"
	CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCodeVehicleNumber CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode = "VEHICLE_NUMBER"
	CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCodeDriverNumber  CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode = "DRIVER_NUMBER"
)

func (CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetPromptCode) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode string

Code indicating which restrictions, if any, there are on purchase. This is configured at a program level and is a static configuration, and does not change on a request to request basis 

const (
	CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCodeNoRestrictions CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode = "NO_RESTRICTIONS"
	CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCodeFuelOnly       CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode = "FUEL_ONLY"
)

func (CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventFleetInfoFleetRestrictionCode) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventLatestChallenge added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventLatestChallenge struct {
	// The phone number used for sending Authorization Challenge SMS.
	PhoneNumber string `json:"phone_number,required"`
	// The status of the Authorization Challenge
	//
	// - `COMPLETED` - Challenge was successfully completed by the cardholder
	// - `PENDING` - Challenge is still open
	// - `EXPIRED` - Challenge has expired without being completed
	// - `ERROR` - There was an error processing the challenge
	Status CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus `json:"status,required"`
	// The date and time when the Authorization Challenge was completed in UTC. Present
	// only if the status is `COMPLETED`.
	CompletedAt time.Time                                                       `json:"completed_at" format:"date-time"`
	JSON        cardAuthorizationApprovalRequestWebhookEventLatestChallengeJSON `json:"-"`
}

The latest Authorization Challenge that was issued to the cardholder for this merchant.

func (*CardAuthorizationApprovalRequestWebhookEventLatestChallenge) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus string

The status of the Authorization Challenge

- `COMPLETED` - Challenge was successfully completed by the cardholder - `PENDING` - Challenge is still open - `EXPIRED` - Challenge has expired without being completed - `ERROR` - There was an error processing the challenge 

const (
	CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatusCompleted CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus = "COMPLETED"
	CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatusPending   CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus = "PENDING"
	CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatusExpired   CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus = "EXPIRED"
	CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatusError     CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus = "ERROR"
)

func (CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventLatestChallengeStatus) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventNetwork added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventNetwork string

Card network of the authorization. 

const (
	CardAuthorizationApprovalRequestWebhookEventNetworkAmex       CardAuthorizationApprovalRequestWebhookEventNetwork = "AMEX"
	CardAuthorizationApprovalRequestWebhookEventNetworkInterlink  CardAuthorizationApprovalRequestWebhookEventNetwork = "INTERLINK"
	CardAuthorizationApprovalRequestWebhookEventNetworkMaestro    CardAuthorizationApprovalRequestWebhookEventNetwork = "MAESTRO"
	CardAuthorizationApprovalRequestWebhookEventNetworkMastercard CardAuthorizationApprovalRequestWebhookEventNetwork = "MASTERCARD"
	CardAuthorizationApprovalRequestWebhookEventNetworkUnknown    CardAuthorizationApprovalRequestWebhookEventNetwork = "UNKNOWN"
	CardAuthorizationApprovalRequestWebhookEventNetworkVisa       CardAuthorizationApprovalRequestWebhookEventNetwork = "VISA"
)

func (CardAuthorizationApprovalRequestWebhookEventNetwork) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventNetwork) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificData added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificData struct {
	Mastercard CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercard `json:"mastercard,nullable"`
	Visa       CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataVisa       `json:"visa,nullable"`
	JSON       cardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataJSON       `json:"-"`
}

Contains raw data provided by the card network, including attributes that provide further context about the authorization. If populated by the network, data is organized by Lithic and passed through without further modification. Please consult the official network documentation for more details about these values and how to use them. This object is only available to certain programs- contact your Customer Success Manager to discuss enabling access.

func (*CardAuthorizationApprovalRequestWebhookEventNetworkSpecificData) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercard added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercard struct {
	// Indicates the electronic commerce security level and UCAF collection.
	EcommerceSecurityLevelIndicator string `json:"ecommerce_security_level_indicator,nullable"`
	// The On-behalf Service performed on the transaction and the results. Contains all
	// applicable, on-behalf service results that were performed on a given
	// transaction.
	OnBehalfServiceResult []CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardOnBehalfServiceResult `json:"on_behalf_service_result,nullable"`
	// Indicates the type of additional transaction purpose.
	TransactionTypeIdentifier string                                                                        `json:"transaction_type_identifier,nullable"`
	JSON                      cardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercard) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardOnBehalfServiceResult added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardOnBehalfServiceResult struct {
	// Indicates the results of the service processing.
	Result1 string `json:"result_1,required"`
	// Identifies the results of the service processing.
	Result2 string `json:"result_2,required"`
	// Indicates the service performed on the transaction.
	Service string                                                                                             `json:"service,required"`
	JSON    cardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardOnBehalfServiceResultJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataMastercardOnBehalfServiceResult) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataVisa added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataVisa struct {
	// Identifies the purpose or category of a transaction, used to classify and
	// process transactions according to Visa’s rules.
	BusinessApplicationIdentifier string                                                                  `json:"business_application_identifier,nullable"`
	JSON                          cardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataVisaJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventNetworkSpecificDataVisa) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventPos added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPos struct {
	// POS > Entry Mode object in ASA
	EntryMode CardAuthorizationApprovalRequestWebhookEventPosEntryMode `json:"entry_mode"`
	Terminal  CardAuthorizationApprovalRequestWebhookEventPosTerminal  `json:"terminal"`
	JSON      cardAuthorizationApprovalRequestWebhookEventPosJSON      `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventPos) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventPosEntryMode added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosEntryMode struct {
	// Card Presence Indicator
	Card CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard `json:"card"`
	// Cardholder Presence Indicator
	Cardholder CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder `json:"cardholder"`
	// Method of entry for the PAN
	Pan CardAuthorizationApprovalRequestWebhookEventPosEntryModePan `json:"pan"`
	// Indicates whether the cardholder entered the PIN. True if the PIN was entered.
	PinEntered bool                                                         `json:"pin_entered"`
	JSON       cardAuthorizationApprovalRequestWebhookEventPosEntryModeJSON `json:"-"`
}

POS > Entry Mode object in ASA

func (*CardAuthorizationApprovalRequestWebhookEventPosEntryMode) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard string

Card Presence Indicator 

const (
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardPresent    CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard = "PRESENT"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardNotPresent CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard = "NOT_PRESENT"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardUnknown    CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard = "UNKNOWN"
)

func (CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosEntryModeCard) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder string

Cardholder Presence Indicator 

const (
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderDeferredBilling CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "DEFERRED_BILLING"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderElectronicOrder CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "ELECTRONIC_ORDER"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderInstallment     CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "INSTALLMENT"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderMailOrder       CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "MAIL_ORDER"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderNotPresent      CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "NOT_PRESENT"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderPresent         CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "PRESENT"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderReoccurring     CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "REOCCURRING"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderTelephoneOrder  CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "TELEPHONE_ORDER"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholderUnknown         CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder = "UNKNOWN"
)

func (CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosEntryModeCardholder) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventPosEntryModePan added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosEntryModePan string

Method of entry for the PAN 

const (
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanAutoEntry           CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "AUTO_ENTRY"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanBarCode             CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "BAR_CODE"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanContactless         CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "CONTACTLESS"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanEcommerce           CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "ECOMMERCE"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanErrorKeyed          CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "ERROR_KEYED"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanErrorMagneticStripe CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "ERROR_MAGNETIC_STRIPE"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanIcc                 CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "ICC"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanKeyEntered          CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "KEY_ENTERED"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanMagneticStripe      CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "MAGNETIC_STRIPE"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanManual              CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "MANUAL"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanOcr                 CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "OCR"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanSecureCardless      CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "SECURE_CARDLESS"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanUnspecified         CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "UNSPECIFIED"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanUnknown             CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "UNKNOWN"
	CardAuthorizationApprovalRequestWebhookEventPosEntryModePanCredentialOnFile    CardAuthorizationApprovalRequestWebhookEventPosEntryModePan = "CREDENTIAL_ON_FILE"
)

func (CardAuthorizationApprovalRequestWebhookEventPosEntryModePan) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosEntryModePan) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventPosTerminal added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosTerminal 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 CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator `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 CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability `json:"pin_capability,required"`
	// POS Type
	Type CardAuthorizationApprovalRequestWebhookEventPosTerminalType `json:"type,required"`
	// Uniquely identifies a terminal at the card acceptor location of acquiring
	// institutions or merchant POS Systems. Left justified with trailing spaces.
	AcceptorTerminalID string                                                      `json:"acceptor_terminal_id,nullable"`
	JSON               cardAuthorizationApprovalRequestWebhookEventPosTerminalJSON `json:"-"`
}

func (*CardAuthorizationApprovalRequestWebhookEventPosTerminal) UnmarshalJSON added in v0.99.0 

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

type CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator string

The person that is designated to swipe the card 

const (
	CardAuthorizationApprovalRequestWebhookEventPosTerminalOperatorAdministrative CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator = "ADMINISTRATIVE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalOperatorCardholder     CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator = "CARDHOLDER"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalOperatorCardAcceptor   CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator = "CARD_ACCEPTOR"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalOperatorUnknown        CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator = "UNKNOWN"
)

func (CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosTerminalOperator) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability string

Status of whether the POS is able to accept PINs 

const (
	CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapabilityCapable     CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability = "CAPABLE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapabilityInoperative CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability = "INOPERATIVE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapabilityNotCapable  CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability = "NOT_CAPABLE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapabilityUnspecified CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability = "UNSPECIFIED"
)

func (CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosTerminalPinCapability) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventPosTerminalType added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventPosTerminalType string

POS Type 

const (
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeAdministrative        CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "ADMINISTRATIVE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeAtm                   CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "ATM"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeAuthorization         CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "AUTHORIZATION"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeCouponMachine         CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "COUPON_MACHINE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeDialTerminal          CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "DIAL_TERMINAL"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeEcommerce             CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "ECOMMERCE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeEcr                   CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "ECR"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeFuelMachine           CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "FUEL_MACHINE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeHomeTerminal          CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "HOME_TERMINAL"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeMicr                  CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "MICR"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeOffPremise            CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "OFF_PREMISE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePayment               CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "PAYMENT"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePda                   CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "PDA"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePhone                 CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "PHONE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePoint                 CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "POINT"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePosTerminal           CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "POS_TERMINAL"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypePublicUtility         CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "PUBLIC_UTILITY"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeSelfService           CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "SELF_SERVICE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeTelevision            CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "TELEVISION"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeTeller                CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "TELLER"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeTravelersCheckMachine CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "TRAVELERS_CHECK_MACHINE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeVending               CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "VENDING"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeVoice                 CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "VOICE"
	CardAuthorizationApprovalRequestWebhookEventPosTerminalTypeUnknown               CardAuthorizationApprovalRequestWebhookEventPosTerminalType = "UNKNOWN"
)

func (CardAuthorizationApprovalRequestWebhookEventPosTerminalType) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventPosTerminalType) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventStatus added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventStatus string

The type of authorization request that this request is for. Note that `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to users with credit decisioning via ASA enabled. 

const (
	CardAuthorizationApprovalRequestWebhookEventStatusAuthorization                CardAuthorizationApprovalRequestWebhookEventStatus = "AUTHORIZATION"
	CardAuthorizationApprovalRequestWebhookEventStatusCreditAuthorization          CardAuthorizationApprovalRequestWebhookEventStatus = "CREDIT_AUTHORIZATION"
	CardAuthorizationApprovalRequestWebhookEventStatusFinancialAuthorization       CardAuthorizationApprovalRequestWebhookEventStatus = "FINANCIAL_AUTHORIZATION"
	CardAuthorizationApprovalRequestWebhookEventStatusFinancialCreditAuthorization CardAuthorizationApprovalRequestWebhookEventStatus = "FINANCIAL_CREDIT_AUTHORIZATION"
	CardAuthorizationApprovalRequestWebhookEventStatusBalanceInquiry               CardAuthorizationApprovalRequestWebhookEventStatus = "BALANCE_INQUIRY"
)

func (CardAuthorizationApprovalRequestWebhookEventStatus) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventStatus) IsKnown() bool

type CardAuthorizationApprovalRequestWebhookEventTransactionInitiator added in v0.99.0 

type CardAuthorizationApprovalRequestWebhookEventTransactionInitiator string

The entity that initiated the transaction. 

const (
	CardAuthorizationApprovalRequestWebhookEventTransactionInitiatorCardholder CardAuthorizationApprovalRequestWebhookEventTransactionInitiator = "CARDHOLDER"
	CardAuthorizationApprovalRequestWebhookEventTransactionInitiatorMerchant   CardAuthorizationApprovalRequestWebhookEventTransactionInitiator = "MERCHANT"
	CardAuthorizationApprovalRequestWebhookEventTransactionInitiatorUnknown    CardAuthorizationApprovalRequestWebhookEventTransactionInitiator = "UNKNOWN"
)

func (CardAuthorizationApprovalRequestWebhookEventTransactionInitiator) IsKnown added in v0.99.0 

func (r CardAuthorizationApprovalRequestWebhookEventTransactionInitiator) IsKnown() bool

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 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[FinancialAccountBalance], 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[FinancialAccountBalance]

Get the balances for a given card.

type CardBulkOrder added in v0.98.0 

type CardBulkOrder struct {
	// Globally unique identifier for the bulk order
	Token string `json:"token,required" format:"uuid"`
	// List of card tokens associated with this bulk order
	CardTokens []string `json:"card_tokens,required" format:"uuid"`
	// An RFC 3339 timestamp for when the bulk order was created. UTC time zone
	Created time.Time `json:"created,required" format:"date-time"`
	// Customer-specified product configuration for physical card manufacturing. This
	// must be configured with Lithic before use
	CustomerProductID string `json:"customer_product_id,required,nullable"`
	// Shipping address for all cards in this bulk order
	ShippingAddress interface{} `json:"shipping_address,required"`
	// Shipping method for all cards in this bulk order
	ShippingMethod CardBulkOrderShippingMethod `json:"shipping_method,required"`
	// Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED
	// indicates the order is finalized and no more cards can be added
	Status CardBulkOrderStatus `json:"status,required"`
	// An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone
	Updated time.Time         `json:"updated,required" format:"date-time"`
	JSON    cardBulkOrderJSON `json:"-"`
}

Represents a bulk order for physical card shipments

func (*CardBulkOrder) UnmarshalJSON added in v0.98.0 

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

type CardBulkOrderListParams added in v0.98.0 

type CardBulkOrderListParams 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 (CardBulkOrderListParams) URLQuery added in v0.98.0 

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

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

type CardBulkOrderNewParams added in v0.98.0 

type CardBulkOrderNewParams struct {
	// Customer-specified product configuration for physical card manufacturing. This
	// must be configured with Lithic before use
	CustomerProductID param.Field[string] `json:"customer_product_id,required"`
	// Shipping address for all cards in this bulk order
	ShippingAddress param.Field[interface{}] `json:"shipping_address,required"`
	// Shipping method for all cards in this bulk order
	ShippingMethod param.Field[CardBulkOrderNewParamsShippingMethod] `json:"shipping_method,required"`
}

func (CardBulkOrderNewParams) MarshalJSON added in v0.98.0 

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

type CardBulkOrderNewParamsShippingMethod added in v0.98.0 

type CardBulkOrderNewParamsShippingMethod string

Shipping method for all cards in this bulk order 

const (
	CardBulkOrderNewParamsShippingMethodBulkExpedited CardBulkOrderNewParamsShippingMethod = "BULK_EXPEDITED"
)

func (CardBulkOrderNewParamsShippingMethod) IsKnown added in v0.98.0 

func (r CardBulkOrderNewParamsShippingMethod) IsKnown() bool

type CardBulkOrderService added in v0.98.0 

type CardBulkOrderService struct {
	Options []option.RequestOption
}

CardBulkOrderService 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 NewCardBulkOrderService method instead.

func NewCardBulkOrderService added in v0.98.0 

func NewCardBulkOrderService(opts ...option.RequestOption) (r *CardBulkOrderService)

NewCardBulkOrderService 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 (*CardBulkOrderService) Get added in v0.98.0 

func (r *CardBulkOrderService) Get(ctx context.Context, bulkOrderToken string, opts ...option.RequestOption) (res *CardBulkOrder, err error)

Retrieve a specific bulk order by token **[BETA]**

func (*CardBulkOrderService) List added in v0.98.0 

func (r *CardBulkOrderService) List(ctx context.Context, query CardBulkOrderListParams, opts ...option.RequestOption) (res *pagination.CursorPage[CardBulkOrder], err error)

List bulk orders for physical card shipments **[BETA]**

func (*CardBulkOrderService) ListAutoPaging added in v0.98.0 

func (r *CardBulkOrderService) ListAutoPaging(ctx context.Context, query CardBulkOrderListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[CardBulkOrder]

List bulk orders for physical card shipments **[BETA]**

func (*CardBulkOrderService) New added in v0.98.0 

func (r *CardBulkOrderService) New(ctx context.Context, body CardBulkOrderNewParams, opts ...option.RequestOption) (res *CardBulkOrder, err error)

Create a new bulk order for physical card shipments **[BETA]**. Cards can be added to the order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work with your Customer Success Manager and card personalization bureau to ensure bulk shipping is supported for your program.

func (*CardBulkOrderService) Update added in v0.98.0 

func (r *CardBulkOrderService) Update(ctx context.Context, bulkOrderToken string, body CardBulkOrderUpdateParams, opts ...option.RequestOption) (res *CardBulkOrder, err error)

Update a bulk order **[BETA]**. Primarily used to lock the order, preventing additional cards from being added

type CardBulkOrderShippingMethod added in v0.98.0 

type CardBulkOrderShippingMethod string

Shipping method for all cards in this bulk order 

const (
	CardBulkOrderShippingMethodBulkExpedited CardBulkOrderShippingMethod = "BULK_EXPEDITED"
)

func (CardBulkOrderShippingMethod) IsKnown added in v0.98.0 

func (r CardBulkOrderShippingMethod) IsKnown() bool

type CardBulkOrderStatus added in v0.98.0 

type CardBulkOrderStatus string

Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED indicates the order is finalized and no more cards can be added 

const (
	CardBulkOrderStatusOpen   CardBulkOrderStatus = "OPEN"
	CardBulkOrderStatusLocked CardBulkOrderStatus = "LOCKED"
)

func (CardBulkOrderStatus) IsKnown added in v0.98.0 

func (r CardBulkOrderStatus) IsKnown() bool

type CardBulkOrderUpdateParams added in v0.98.0 

type CardBulkOrderUpdateParams struct {
	// Status to update the bulk order to. Use LOCKED to finalize the order
	Status param.Field[CardBulkOrderUpdateParamsStatus] `json:"status,required"`
}

func (CardBulkOrderUpdateParams) MarshalJSON added in v0.98.0 

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

type CardBulkOrderUpdateParamsStatus added in v0.98.0 

type CardBulkOrderUpdateParamsStatus string

Status to update the bulk order to. Use LOCKED to finalize the order 

const (
	CardBulkOrderUpdateParamsStatusLocked CardBulkOrderUpdateParamsStatus = "LOCKED"
)

func (CardBulkOrderUpdateParamsStatus) IsKnown added in v0.98.0 

func (r CardBulkOrderUpdateParamsStatus) IsKnown() bool

type CardConvertPhysicalParams added in v0.64.0 

type CardConvertPhysicalParams 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"`
	// 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. 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 or UPS depending on card manufacturer, Express, 3-day
	//     shipping, with tracking
	//   - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
	//     tracking
	//   - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
	//     or similar international option, with tracking
	//   - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
	ShippingMethod param.Field[CardConvertPhysicalParamsShippingMethod] `json:"shipping_method"`
}

func (CardConvertPhysicalParams) MarshalJSON added in v0.64.0 

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

type CardConvertPhysicalParamsShippingMethod added in v0.64.0 

type CardConvertPhysicalParamsShippingMethod 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 or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
  • `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
  • `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
const (
	CardConvertPhysicalParamsShippingMethod2Day                 CardConvertPhysicalParamsShippingMethod = "2_DAY"
	CardConvertPhysicalParamsShippingMethodBulkExpedited        CardConvertPhysicalParamsShippingMethod = "BULK_EXPEDITED"
	CardConvertPhysicalParamsShippingMethodExpedited            CardConvertPhysicalParamsShippingMethod = "EXPEDITED"
	CardConvertPhysicalParamsShippingMethodExpress              CardConvertPhysicalParamsShippingMethod = "EXPRESS"
	CardConvertPhysicalParamsShippingMethodPriority             CardConvertPhysicalParamsShippingMethod = "PRIORITY"
	CardConvertPhysicalParamsShippingMethodStandard             CardConvertPhysicalParamsShippingMethod = "STANDARD"
	CardConvertPhysicalParamsShippingMethodStandardWithTracking CardConvertPhysicalParamsShippingMethod = "STANDARD_WITH_TRACKING"
)

func (CardConvertPhysicalParamsShippingMethod) IsKnown added in v0.64.0 

func (r CardConvertPhysicalParamsShippingMethod) IsKnown() bool

type CardConvertedWebhookEvent added in v0.98.0 

type CardConvertedWebhookEvent struct {
	// The token of the card that was created.
	CardToken string `json:"card_token,required" format:"uuid"`
	// The type of event that occurred.
	EventType CardConvertedWebhookEventEventType `json:"event_type,required"`
	JSON      cardConvertedWebhookEventJSON      `json:"-"`
}

func (*CardConvertedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardConvertedWebhookEventEventType added in v0.98.0 

type CardConvertedWebhookEventEventType string

The type of event that occurred. 

const (
	CardConvertedWebhookEventEventTypeCardConverted CardConvertedWebhookEventEventType = "card.converted"
)

func (CardConvertedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardConvertedWebhookEventEventType) IsKnown() bool

type CardCreatedWebhookEvent added in v0.98.0 

type CardCreatedWebhookEvent struct {
	// The token of the card that was created.
	CardToken string `json:"card_token,required" format:"uuid"`
	// The type of event that occurred.
	EventType CardCreatedWebhookEventEventType `json:"event_type,required"`
	// The token of the card that was replaced, if the new card is a replacement card.
	ReplacementFor string                      `json:"replacement_for,nullable" format:"uuid"`
	JSON           cardCreatedWebhookEventJSON `json:"-"`
}

func (*CardCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardCreatedWebhookEventEventType added in v0.98.0 

type CardCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	CardCreatedWebhookEventEventTypeCardCreated CardCreatedWebhookEventEventType = "card.created"
)

func (CardCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardCreatedWebhookEventEventType) IsKnown() bool

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 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"`
	// Returns cards containing the specified partial or full memo text.
	Memo param.Field[string] `query:"memo"`
	// 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.
	//   - `UNLOCKED` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
	//     VIRTUAL instead.
	//   - `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please
	//     use VIRTUAL instead.
	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"`
	// Globally unique identifier for an existing bulk order to associate this card
	// with. When specified, the card will be added to the bulk order for batch
	// shipment. Only applicable to cards of type PHYSICAL
	BulkOrderToken param.Field[string] `json:"bulk_order_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). 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"`
	// Additional context or information related to the card that this card will
	// replace.
	ReplacementComment param.Field[string] `json:"replacement_comment"`
	// Globally unique identifier for the card that this card will replace. If the card
	// type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
	// `VIRTUAL` it will be replaced by a `VIRTUAL` card.
	ReplacementFor param.Field[string] `json:"replacement_for" format:"uuid"`
	// Card state substatus values for the card that this card will replace:
	//
	//   - `LOST` - The physical card is no longer in the cardholder's possession due to
	//     being lost or never received by the cardholder.
	//   - `COMPROMISED` - Card information has been exposed, potentially leading to
	//     unauthorized access. This may involve physical card theft, cloning, or online
	//     data breaches.
	//   - `DAMAGED` - The physical card is not functioning properly, such as having chip
	//     failures or a demagnetized magnetic stripe.
	//   - `END_USER_REQUEST` - The cardholder requested the closure of the card for
	//     reasons unrelated to fraud or damage, such as switching to a different product
	//     or closing the account.
	//   - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
	//     or damage, such as account inactivity, product or policy changes, or
	//     technology upgrades.
	//   - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
	//     period, applicable to statuses like `PAUSED` or `CLOSED`.
	//   - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
	//     activities that require review. This can involve prompting the cardholder to
	//     confirm legitimate use or report confirmed fraud.
	//   - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
	//     review.
	//   - `EXPIRED` - The card has expired and has been closed without being reissued.
	//   - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
	//     returned.
	//   - `OTHER` - The reason for the status does not fall into any of the above
	//     categories. A comment should be provided to specify the reason.
	ReplacementSubstatus param.Field[CardNewParamsReplacementSubstatus] `json:"replacement_substatus"`
	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 or UPS depending on card manufacturer, Express, 3-day
	//     shipping, with tracking
	//   - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
	//     tracking
	//   - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
	//     or similar international option, with tracking
	//   - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
	ShippingMethod param.Field[CardNewParamsShippingMethod] `json:"shipping_method"`
	// Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
	// $1,000 limit). 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 CardNewParamsReplacementSubstatus added in v0.84.0 

type CardNewParamsReplacementSubstatus string

Card state substatus values for the card that this card will replace:

  • `LOST` - The physical card is no longer in the cardholder's possession due to being lost or never received by the cardholder.
  • `COMPROMISED` - Card information has been exposed, potentially leading to unauthorized access. This may involve physical card theft, cloning, or online data breaches.
  • `DAMAGED` - The physical card is not functioning properly, such as having chip failures or a demagnetized magnetic stripe.
  • `END_USER_REQUEST` - The cardholder requested the closure of the card for reasons unrelated to fraud or damage, such as switching to a different product or closing the account.
  • `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud or damage, such as account inactivity, product or policy changes, or technology upgrades.
  • `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified period, applicable to statuses like `PAUSED` or `CLOSED`.
  • `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or activities that require review. This can involve prompting the cardholder to confirm legitimate use or report confirmed fraud.
  • `INTERNAL_REVIEW` - The card is temporarily paused pending further internal review.
  • `EXPIRED` - The card has expired and has been closed without being reissued.
  • `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been returned.
  • `OTHER` - The reason for the status does not fall into any of the above categories. A comment should be provided to specify the reason.
const (
	CardNewParamsReplacementSubstatusLost               CardNewParamsReplacementSubstatus = "LOST"
	CardNewParamsReplacementSubstatusCompromised        CardNewParamsReplacementSubstatus = "COMPROMISED"
	CardNewParamsReplacementSubstatusDamaged            CardNewParamsReplacementSubstatus = "DAMAGED"
	CardNewParamsReplacementSubstatusEndUserRequest     CardNewParamsReplacementSubstatus = "END_USER_REQUEST"
	CardNewParamsReplacementSubstatusIssuerRequest      CardNewParamsReplacementSubstatus = "ISSUER_REQUEST"
	CardNewParamsReplacementSubstatusNotActive          CardNewParamsReplacementSubstatus = "NOT_ACTIVE"
	CardNewParamsReplacementSubstatusSuspiciousActivity CardNewParamsReplacementSubstatus = "SUSPICIOUS_ACTIVITY"
	CardNewParamsReplacementSubstatusInternalReview     CardNewParamsReplacementSubstatus = "INTERNAL_REVIEW"
	CardNewParamsReplacementSubstatusExpired            CardNewParamsReplacementSubstatus = "EXPIRED"
	CardNewParamsReplacementSubstatusUndeliverable      CardNewParamsReplacementSubstatus = "UNDELIVERABLE"
	CardNewParamsReplacementSubstatusOther              CardNewParamsReplacementSubstatus = "OTHER"
)

func (CardNewParamsReplacementSubstatus) IsKnown added in v0.84.0 

func (r CardNewParamsReplacementSubstatus) IsKnown() bool

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 or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
  • `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
  • `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
const (
	CardNewParamsShippingMethod2Day                 CardNewParamsShippingMethod = "2_DAY"
	CardNewParamsShippingMethodBulkExpedited        CardNewParamsShippingMethod = "BULK_EXPEDITED"
	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.
  • `UNLOCKED` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use VIRTUAL instead.
  • `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use VIRTUAL instead.
const (
	CardNewParamsTypeMerchantLocked CardNewParamsType = "MERCHANT_LOCKED"
	CardNewParamsTypePhysical       CardNewParamsType = "PHYSICAL"
	CardNewParamsTypeSingleUse      CardNewParamsType = "SINGLE_USE"
	CardNewParamsTypeVirtual        CardNewParamsType = "VIRTUAL"
	CardNewParamsTypeUnlocked       CardNewParamsType = "UNLOCKED"
	CardNewParamsTypeDigitalWallet  CardNewParamsType = "DIGITAL_WALLET"
)

func (CardNewParamsType) IsKnown added in v0.27.0 

func (r CardNewParamsType) IsKnown() bool

type CardProgram added in v0.10.0 

type CardProgram struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Whether the card program is participating in Account Level Management. Currently
	// applicable to Visa card programs only.
	AccountLevelManagementEnabled bool `json:"account_level_management_enabled,required"`
	// 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-character alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency string `json:"cardholder_currency"`
	// List of 3-character 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 {
	// Base64 encoded JSON payload representing a payment card that can be passed to a
	// device's digital wallet. Applies to Google and Samsung Pay wallets.
	ProvisioningPayload CardProvisionResponseProvisioningPayloadUnion `json:"provisioning_payload"`
	JSON                cardProvisionResponseJSON                     `json:"-"`
}

func (*CardProvisionResponse) UnmarshalJSON 

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

type CardProvisionResponseProvisioningPayloadUnion added in v0.95.0 

type CardProvisionResponseProvisioningPayloadUnion interface {
	ImplementsCardProvisionResponseProvisioningPayloadUnion()
}

Base64 encoded JSON payload representing a payment card that can be passed to a device's digital wallet. Applies to Google and Samsung Pay wallets.

Union satisfied by shared.UnionString or ProvisionResponse.

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. 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 or UPS depending on card manufacturer, Express, 3-day
	//     shipping, with tracking
	//   - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
	//     tracking
	//   - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
	//     or similar international option, with tracking
	//   - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
	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. 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 or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
  • `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
  • `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
const (
	CardReissueParamsShippingMethod2Day                 CardReissueParamsShippingMethod = "2_DAY"
	CardReissueParamsShippingMethodBulkExpedited        CardReissueParamsShippingMethod = "BULK_EXPEDITED"
	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 CardReissuedWebhookEvent added in v0.98.0 

type CardReissuedWebhookEvent struct {
	// The type of event that occurred.
	EventType CardReissuedWebhookEventEventType `json:"event_type,required"`
	// The token of the card that was reissued.
	CardToken string                       `json:"card_token" format:"uuid"`
	JSON      cardReissuedWebhookEventJSON `json:"-"`
}

func (*CardReissuedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardReissuedWebhookEventEventType added in v0.98.0 

type CardReissuedWebhookEventEventType string

The type of event that occurred. 

const (
	CardReissuedWebhookEventEventTypeCardReissued CardReissuedWebhookEventEventType = "card.reissued"
)

func (CardReissuedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardReissuedWebhookEventEventType) 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. 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 or UPS depending on card manufacturer, Express, 3-day
	//     shipping, with tracking
	//   - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
	//     tracking
	//   - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
	//     or similar international option, with tracking
	//   - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
	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. 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 or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
  • `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
  • `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
  • `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
const (
	CardRenewParamsShippingMethod2Day                 CardRenewParamsShippingMethod = "2_DAY"
	CardRenewParamsShippingMethodBulkExpedited        CardRenewParamsShippingMethod = "BULK_EXPEDITED"
	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 CardRenewedWebhookEvent added in v0.98.0 

type CardRenewedWebhookEvent struct {
	// The type of event that occurred.
	EventType CardRenewedWebhookEventEventType `json:"event_type,required"`
	// The token of the card that was renewed.
	CardToken string `json:"card_token" format:"uuid"`
	// The new expiration month of the card.
	ExpMonth string `json:"exp_month"`
	// The new expiration year of the card.
	ExpYear string `json:"exp_year"`
	// The previous expiration month of the card.
	PreviousExpMonth string `json:"previous_exp_month"`
	// The previous expiration year of the card.
	PreviousExpYear string                      `json:"previous_exp_year"`
	JSON            cardRenewedWebhookEventJSON `json:"-"`
}

func (*CardRenewedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardRenewedWebhookEventEventType added in v0.98.0 

type CardRenewedWebhookEventEventType string

The type of event that occurred. 

const (
	CardRenewedWebhookEventEventTypeCardRenewed CardRenewedWebhookEventEventType = "card.renewed"
)

func (CardRenewedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardRenewedWebhookEventEventType) 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
	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) ConvertPhysical added in v0.64.0 

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

Convert a virtual card into a physical card and manufacture it. Customer must supply relevant fields for physical card creation including `product_id`, `carrier`, `shipping_method`, and `shipping_address`. The card token will be unchanged. The card's type will be altered to `PHYSICAL`. The card will be set to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment cycle. Virtual cards created on card programs which do not support physical cards cannot be converted. The card program cannot be changed as part of the conversion. Cards must be in an `OPEN` state to be converted. Only applies to cards of type `VIRTUAL` (or existing cards with deprecated types of `DIGITAL_WALLET` and `UNLOCKED`).

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 (see Embedded Card UI or Changelog for upcoming changes in January). 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[NonPCICard], err error)

List cards.

func (*CardService) ListAutoPaging 

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

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 `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 (e.g. card is physically damaged). The PAN, expiry, and CVC2 will remain the same and the original card can continue to be used until the new card is activated. Only applies to cards of type `PHYSICAL`. A card can be reissued or renewed a total of 8 times.

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)

Applies to card types `PHYSICAL` and `VIRTUAL`. For `PHYSICAL`, creates a new card with the same card token and PAN, but updated expiry and CVC2 code. The original card will keep working for card-present transactions until the new card is activated. For card-not-present transactions, the original card details (expiry, CVC2) will also keep working until the new card is activated. A `PHYSICAL` card can be reissued or renewed a total of 8 times. For `VIRTUAL`, the card will retain the same card token and PAN and receive an updated expiry and CVC2 code. `product_id`, `shipping_method`, `shipping_address`, `carrier` are only relevant for renewing `PHYSICAL` cards.

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.

_Note: setting a card to a `CLOSED` state is a final action that cannot be undone._

func (*CardService) WebProvision added in v0.78.0 

func (r *CardService) WebProvision(ctx context.Context, cardToken string, body CardWebProvisionParams, opts ...option.RequestOption) (res *CardWebProvisionResponse, err error)

Allow your cardholders to directly add payment cards to the device's digital wallet from a browser on the web.

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

type CardShippedWebhookEvent added in v0.98.0 

type CardShippedWebhookEvent struct {
	// The token of the bulk order associated with this card shipment, if applicable.
	BulkOrderToken string `json:"bulk_order_token,required,nullable" format:"uuid"`
	// The token of the card that was shipped.
	CardToken string `json:"card_token,required" format:"uuid"`
	// The type of event that occurred.
	EventType CardShippedWebhookEventEventType `json:"event_type,required"`
	// The specific shipping method used to ship the card.
	ShippingMethod CardShippedWebhookEventShippingMethod `json:"shipping_method,required"`
	// The tracking number of the shipment.
	TrackingNumber string                      `json:"tracking_number,required,nullable"`
	JSON           cardShippedWebhookEventJSON `json:"-"`
}

func (*CardShippedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardShippedWebhookEventEventType added in v0.98.0 

type CardShippedWebhookEventEventType string

The type of event that occurred. 

const (
	CardShippedWebhookEventEventTypeCardShipped CardShippedWebhookEventEventType = "card.shipped"
)

func (CardShippedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardShippedWebhookEventEventType) IsKnown() bool

type CardShippedWebhookEventShippingMethod added in v0.98.0 

type CardShippedWebhookEventShippingMethod string

The specific shipping method used to ship the card. 

const (
	CardShippedWebhookEventShippingMethodExUsExpeditedWithTracking             CardShippedWebhookEventShippingMethod = "Ex-US expedited with tracking"
	CardShippedWebhookEventShippingMethodExUsStandardWithTracking              CardShippedWebhookEventShippingMethod = "Ex-US standard with tracking"
	CardShippedWebhookEventShippingMethodExUsStandardWithoutTracking           CardShippedWebhookEventShippingMethod = "Ex-US standard without tracking"
	CardShippedWebhookEventShippingMethodFedEx2Days                            CardShippedWebhookEventShippingMethod = "FedEx 2 days"
	CardShippedWebhookEventShippingMethodFedExExpress                          CardShippedWebhookEventShippingMethod = "FedEx express"
	CardShippedWebhookEventShippingMethodFedExOvernight                        CardShippedWebhookEventShippingMethod = "FedEx overnight"
	CardShippedWebhookEventShippingMethodUspsPriority                          CardShippedWebhookEventShippingMethod = "USPS priority"
	CardShippedWebhookEventShippingMethodUspsWithTracking                      CardShippedWebhookEventShippingMethod = "USPS with tracking"
	CardShippedWebhookEventShippingMethodUspsWithoutTrackingEnvelope           CardShippedWebhookEventShippingMethod = "USPS without tracking envelope"
	CardShippedWebhookEventShippingMethodUspsWithoutTrackingEnvelopeNonMachine CardShippedWebhookEventShippingMethod = "USPS without tracking envelope non-machine"
	CardShippedWebhookEventShippingMethodUspsWithoutTrackingFlat               CardShippedWebhookEventShippingMethod = "USPS without tracking flat"
)

func (CardShippedWebhookEventShippingMethod) IsKnown added in v0.98.0 

func (r CardShippedWebhookEventShippingMethod) IsKnown() bool

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 (e.g. 100000 would be a $1,000 limit).
	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 CardTransactionEnhancedDataCreatedWebhookEvent added in v0.98.0 

type CardTransactionEnhancedDataCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType CardTransactionEnhancedDataCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      cardTransactionEnhancedDataCreatedWebhookEventJSON      `json:"-"`
	EnhancedData
}

func (*CardTransactionEnhancedDataCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardTransactionEnhancedDataCreatedWebhookEventEventType added in v0.98.0 

type CardTransactionEnhancedDataCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	CardTransactionEnhancedDataCreatedWebhookEventEventTypeCardTransactionEnhancedDataCreated CardTransactionEnhancedDataCreatedWebhookEventEventType = "card_transaction.enhanced_data.created"
)

func (CardTransactionEnhancedDataCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardTransactionEnhancedDataCreatedWebhookEventEventType) IsKnown() bool

type CardTransactionEnhancedDataUpdatedWebhookEvent added in v0.98.0 

type CardTransactionEnhancedDataUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType CardTransactionEnhancedDataUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      cardTransactionEnhancedDataUpdatedWebhookEventJSON      `json:"-"`
	EnhancedData
}

func (*CardTransactionEnhancedDataUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardTransactionEnhancedDataUpdatedWebhookEventEventType added in v0.98.0 

type CardTransactionEnhancedDataUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	CardTransactionEnhancedDataUpdatedWebhookEventEventTypeCardTransactionEnhancedDataUpdated CardTransactionEnhancedDataUpdatedWebhookEventEventType = "card_transaction.enhanced_data.updated"
)

func (CardTransactionEnhancedDataUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardTransactionEnhancedDataUpdatedWebhookEventEventType) IsKnown() bool

type CardTransactionUpdatedWebhookEvent added in v0.98.0 

type CardTransactionUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType CardTransactionUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      cardTransactionUpdatedWebhookEventJSON      `json:"-"`
	Transaction
}

func (*CardTransactionUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type CardTransactionUpdatedWebhookEventEventType added in v0.98.0 

type CardTransactionUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	CardTransactionUpdatedWebhookEventEventTypeCardTransactionUpdated CardTransactionUpdatedWebhookEventEventType = "card_transaction.updated"
)

func (CardTransactionUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r CardTransactionUpdatedWebhookEventEventType) IsKnown() bool

type CardUpdateParams 

type CardUpdateParams struct {
	// Additional context or information related to the card.
	Comment param.Field[string] `json:"comment"`
	// 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"`
	// Globally unique identifier for the card's network program. Currently applicable
	// to Visa cards participating in Account Level Management only.
	NetworkProgramToken param.Field[string] `json:"network_program_token" format:"uuid"`
	// 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 (e.g. 100000 would be a
	// $1,000 limit). 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"`
	// Card state substatus values:
	//
	//   - `LOST` - The physical card is no longer in the cardholder's possession due to
	//     being lost or never received by the cardholder.
	//   - `COMPROMISED` - Card information has been exposed, potentially leading to
	//     unauthorized access. This may involve physical card theft, cloning, or online
	//     data breaches.
	//   - `DAMAGED` - The physical card is not functioning properly, such as having chip
	//     failures or a demagnetized magnetic stripe.
	//   - `END_USER_REQUEST` - The cardholder requested the closure of the card for
	//     reasons unrelated to fraud or damage, such as switching to a different product
	//     or closing the account.
	//   - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
	//     or damage, such as account inactivity, product or policy changes, or
	//     technology upgrades.
	//   - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
	//     period, applicable to statuses like `PAUSED` or `CLOSED`.
	//   - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
	//     activities that require review. This can involve prompting the cardholder to
	//     confirm legitimate use or report confirmed fraud.
	//   - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
	//     review.
	//   - `EXPIRED` - The card has expired and has been closed without being reissued.
	//   - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
	//     returned.
	//   - `OTHER` - The reason for the status does not fall into any of the above
	//     categories. A comment should be provided to specify the reason.
	Substatus param.Field[CardUpdateParamsSubstatus] `json:"substatus"`
}

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 CardUpdateParamsSubstatus added in v0.84.0 

type CardUpdateParamsSubstatus string

Card state substatus values:

  • `LOST` - The physical card is no longer in the cardholder's possession due to being lost or never received by the cardholder.
  • `COMPROMISED` - Card information has been exposed, potentially leading to unauthorized access. This may involve physical card theft, cloning, or online data breaches.
  • `DAMAGED` - The physical card is not functioning properly, such as having chip failures or a demagnetized magnetic stripe.
  • `END_USER_REQUEST` - The cardholder requested the closure of the card for reasons unrelated to fraud or damage, such as switching to a different product or closing the account.
  • `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud or damage, such as account inactivity, product or policy changes, or technology upgrades.
  • `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified period, applicable to statuses like `PAUSED` or `CLOSED`.
  • `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or activities that require review. This can involve prompting the cardholder to confirm legitimate use or report confirmed fraud.
  • `INTERNAL_REVIEW` - The card is temporarily paused pending further internal review.
  • `EXPIRED` - The card has expired and has been closed without being reissued.
  • `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been returned.
  • `OTHER` - The reason for the status does not fall into any of the above categories. A comment should be provided to specify the reason.
const (
	CardUpdateParamsSubstatusLost               CardUpdateParamsSubstatus = "LOST"
	CardUpdateParamsSubstatusCompromised        CardUpdateParamsSubstatus = "COMPROMISED"
	CardUpdateParamsSubstatusDamaged            CardUpdateParamsSubstatus = "DAMAGED"
	CardUpdateParamsSubstatusEndUserRequest     CardUpdateParamsSubstatus = "END_USER_REQUEST"
	CardUpdateParamsSubstatusIssuerRequest      CardUpdateParamsSubstatus = "ISSUER_REQUEST"
	CardUpdateParamsSubstatusNotActive          CardUpdateParamsSubstatus = "NOT_ACTIVE"
	CardUpdateParamsSubstatusSuspiciousActivity CardUpdateParamsSubstatus = "SUSPICIOUS_ACTIVITY"
	CardUpdateParamsSubstatusInternalReview     CardUpdateParamsSubstatus = "INTERNAL_REVIEW"
	CardUpdateParamsSubstatusExpired            CardUpdateParamsSubstatus = "EXPIRED"
	CardUpdateParamsSubstatusUndeliverable      CardUpdateParamsSubstatus = "UNDELIVERABLE"
	CardUpdateParamsSubstatusOther              CardUpdateParamsSubstatus = "OTHER"
)

func (CardUpdateParamsSubstatus) IsKnown added in v0.84.0 

func (r CardUpdateParamsSubstatus) IsKnown() bool

type CardWebProvisionParams added in v0.78.0 

type CardWebProvisionParams struct {
	// Only applicable if `digital_wallet` is GOOGLE_PAY. Google Pay Web Push
	// Provisioning device identifier required for the tokenization flow
	ClientDeviceID param.Field[string] `json:"client_device_id" format:"uuid"`
	// Only applicable if `digital_wallet` is GOOGLE_PAY. Google Pay Web Push
	// Provisioning wallet account identifier required for the tokenization flow
	ClientWalletAccountID param.Field[string] `json:"client_wallet_account_id" format:"uuid"`
	// Name of digital wallet provider.
	DigitalWallet param.Field[CardWebProvisionParamsDigitalWallet] `json:"digital_wallet"`
	// Only applicable if `digital_wallet` is GOOGLE_PAY. Google Pay Web Push
	// Provisioning session identifier required for the FPAN flow.
	ServerSessionID param.Field[string] `json:"server_session_id" format:"uuid"`
}

func (CardWebProvisionParams) MarshalJSON added in v0.78.0 

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

type CardWebProvisionParamsDigitalWallet added in v0.78.0 

type CardWebProvisionParamsDigitalWallet string

Name of digital wallet provider. 

const (
	CardWebProvisionParamsDigitalWalletApplePay  CardWebProvisionParamsDigitalWallet = "APPLE_PAY"
	CardWebProvisionParamsDigitalWalletGooglePay CardWebProvisionParamsDigitalWallet = "GOOGLE_PAY"
)

func (CardWebProvisionParamsDigitalWallet) IsKnown added in v0.78.0 

func (r CardWebProvisionParamsDigitalWallet) IsKnown() bool

type CardWebProvisionResponse added in v0.78.0 

type CardWebProvisionResponse struct {
	// A base64 encoded and encrypted payload representing card data for the Google Pay
	// UWPP FPAN flow.
	GoogleOpc string `json:"google_opc"`
	// This field can have the runtime type of
	// [CardWebProvisionResponseAppleWebPushProvisioningResponseJws].
	Jws interface{} `json:"jws"`
	// A unique identifier for the JWS object.
	State string `json:"state"`
	// A base64 encoded and encrypted payload representing card data for the Google Pay
	// UWPP tokenization flow.
	TspOpc string                       `json:"tsp_opc"`
	JSON   cardWebProvisionResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (CardWebProvisionResponse) AsUnion added in v0.98.0 

func (r CardWebProvisionResponse) AsUnion() CardWebProvisionResponseUnion

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

Possible runtime types of the union are CardWebProvisionResponseAppleWebPushProvisioningResponse, CardWebProvisionResponseGoogleWebPushProvisioningResponse.

func (*CardWebProvisionResponse) UnmarshalJSON added in v0.78.0 

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

type CardWebProvisionResponseAppleWebPushProvisioningResponse added in v0.98.0 

type CardWebProvisionResponseAppleWebPushProvisioningResponse struct {
	// JWS object required for handoff to Apple's script.
	Jws CardWebProvisionResponseAppleWebPushProvisioningResponseJws `json:"jws"`
	// A unique identifier for the JWS object.
	State string                                                       `json:"state"`
	JSON  cardWebProvisionResponseAppleWebPushProvisioningResponseJSON `json:"-"`
}

func (*CardWebProvisionResponseAppleWebPushProvisioningResponse) UnmarshalJSON added in v0.98.0 

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

type CardWebProvisionResponseAppleWebPushProvisioningResponseJws added in v0.98.0 

type CardWebProvisionResponseAppleWebPushProvisioningResponseJws struct {
	// JWS unprotected headers containing header parameters that aren't
	// integrity-protected by the JWS signature.
	Header CardWebProvisionResponseAppleWebPushProvisioningResponseJwsHeader `json:"header"`
	// Base64url encoded JSON object containing the provisioning payload.
	Payload string `json:"payload"`
	// Base64url encoded JWS protected headers containing the header parameters that
	// are integrity-protected by the JWS signature.
	Protected string `json:"protected"`
	// Base64url encoded signature of the JWS object.
	Signature string                                                          `json:"signature"`
	JSON      cardWebProvisionResponseAppleWebPushProvisioningResponseJwsJSON `json:"-"`
}

JWS object required for handoff to Apple's script.

func (*CardWebProvisionResponseAppleWebPushProvisioningResponseJws) UnmarshalJSON added in v0.98.0 

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

type CardWebProvisionResponseAppleWebPushProvisioningResponseJwsHeader added in v0.98.0 

type CardWebProvisionResponseAppleWebPushProvisioningResponseJwsHeader struct {
	// The ID for the JWS Public Key of the key pair used to generate the signature.
	Kid  string                                                                `json:"kid"`
	JSON cardWebProvisionResponseAppleWebPushProvisioningResponseJwsHeaderJSON `json:"-"`
}

JWS unprotected headers containing header parameters that aren't integrity-protected by the JWS signature.

func (*CardWebProvisionResponseAppleWebPushProvisioningResponseJwsHeader) UnmarshalJSON added in v0.98.0 

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

type CardWebProvisionResponseGoogleWebPushProvisioningResponse added in v0.98.0 

type CardWebProvisionResponseGoogleWebPushProvisioningResponse struct {
	// A base64 encoded and encrypted payload representing card data for the Google Pay
	// UWPP FPAN flow.
	GoogleOpc string `json:"google_opc"`
	// A base64 encoded and encrypted payload representing card data for the Google Pay
	// UWPP tokenization flow.
	TspOpc string                                                        `json:"tsp_opc"`
	JSON   cardWebProvisionResponseGoogleWebPushProvisioningResponseJSON `json:"-"`
}

func (*CardWebProvisionResponseGoogleWebPushProvisioningResponse) UnmarshalJSON added in v0.98.0 

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

type CardWebProvisionResponseUnion added in v0.98.0 

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

Union satisfied by CardWebProvisionResponseAppleWebPushProvisioningResponse or CardWebProvisionResponseGoogleWebPushProvisioningResponse.

type CardholderAuthentication added in v0.98.0 

type CardholderAuthentication struct {
	// Indicates the method used to authenticate the cardholder.
	AuthenticationMethod CardholderAuthenticationAuthenticationMethod `json:"authentication_method,required"`
	// Indicates the outcome of the 3DS authentication process.
	AuthenticationResult CardholderAuthenticationAuthenticationResult `json:"authentication_result,required"`
	// Indicates which party made the 3DS authentication decision.
	DecisionMadeBy CardholderAuthenticationDecisionMadeBy `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.
	//   - `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 CardholderAuthenticationLiabilityShift `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"`
	JSON                       cardholderAuthenticationJSON `json:"-"`
}

func (*CardholderAuthentication) UnmarshalJSON added in v0.98.0 

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

type CardholderAuthenticationAuthenticationMethod added in v0.98.0 

type CardholderAuthenticationAuthenticationMethod string

Indicates the method used to authenticate the cardholder. 

const (
	CardholderAuthenticationAuthenticationMethodFrictionless CardholderAuthenticationAuthenticationMethod = "FRICTIONLESS"
	CardholderAuthenticationAuthenticationMethodChallenge    CardholderAuthenticationAuthenticationMethod = "CHALLENGE"
	CardholderAuthenticationAuthenticationMethodNone         CardholderAuthenticationAuthenticationMethod = "NONE"
)

func (CardholderAuthenticationAuthenticationMethod) IsKnown added in v0.98.0 

func (r CardholderAuthenticationAuthenticationMethod) IsKnown() bool

type CardholderAuthenticationAuthenticationResult added in v0.98.0 

type CardholderAuthenticationAuthenticationResult string

Indicates the outcome of the 3DS authentication process. 

const (
	CardholderAuthenticationAuthenticationResultAttempts CardholderAuthenticationAuthenticationResult = "ATTEMPTS"
	CardholderAuthenticationAuthenticationResultDecline  CardholderAuthenticationAuthenticationResult = "DECLINE"
	CardholderAuthenticationAuthenticationResultNone     CardholderAuthenticationAuthenticationResult = "NONE"
	CardholderAuthenticationAuthenticationResultSuccess  CardholderAuthenticationAuthenticationResult = "SUCCESS"
)

func (CardholderAuthenticationAuthenticationResult) IsKnown added in v0.98.0 

func (r CardholderAuthenticationAuthenticationResult) IsKnown() bool

type CardholderAuthenticationDecisionMadeBy added in v0.98.0 

type CardholderAuthenticationDecisionMadeBy string

Indicates which party made the 3DS authentication decision. 

const (
	CardholderAuthenticationDecisionMadeByCustomerRules    CardholderAuthenticationDecisionMadeBy = "CUSTOMER_RULES"
	CardholderAuthenticationDecisionMadeByCustomerEndpoint CardholderAuthenticationDecisionMadeBy = "CUSTOMER_ENDPOINT"
	CardholderAuthenticationDecisionMadeByLithicDefault    CardholderAuthenticationDecisionMadeBy = "LITHIC_DEFAULT"
	CardholderAuthenticationDecisionMadeByLithicRules      CardholderAuthenticationDecisionMadeBy = "LITHIC_RULES"
	CardholderAuthenticationDecisionMadeByNetwork          CardholderAuthenticationDecisionMadeBy = "NETWORK"
	CardholderAuthenticationDecisionMadeByUnknown          CardholderAuthenticationDecisionMadeBy = "UNKNOWN"
)

func (CardholderAuthenticationDecisionMadeBy) IsKnown added in v0.98.0 

func (r CardholderAuthenticationDecisionMadeBy) IsKnown() bool

type CardholderAuthenticationLiabilityShift added in v0.98.0 

type CardholderAuthenticationLiabilityShift 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.
  • `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 (
	CardholderAuthenticationLiabilityShift3DSAuthenticated   CardholderAuthenticationLiabilityShift = "3DS_AUTHENTICATED"
	CardholderAuthenticationLiabilityShiftTokenAuthenticated CardholderAuthenticationLiabilityShift = "TOKEN_AUTHENTICATED"
	CardholderAuthenticationLiabilityShiftNone               CardholderAuthenticationLiabilityShift = "NONE"
)

func (CardholderAuthenticationLiabilityShift) IsKnown added in v0.98.0 

func (r CardholderAuthenticationLiabilityShift) IsKnown() bool

type CarrierParam added in v0.6.7 

type CarrierParam = shared.CarrierParam

This is an alias to an internal type.

type CategoryBalances added in v0.96.0 

type CategoryBalances struct {
	Fees      int64                `json:"fees,required"`
	Interest  int64                `json:"interest,required"`
	Principal int64                `json:"principal,required"`
	JSON      categoryBalancesJSON `json:"-"`
}

func (*CategoryBalances) UnmarshalJSON added in v0.96.0 

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

type CategoryDetails added in v0.96.0 

type CategoryDetails struct {
	BalanceTransfers string              `json:"balance_transfers,required"`
	CashAdvances     string              `json:"cash_advances,required"`
	Purchases        string              `json:"purchases,required"`
	JSON             categoryDetailsJSON `json:"-"`
}

func (*CategoryDetails) UnmarshalJSON added in v0.96.0 

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

type ChallengeResponseParam added in v0.58.0 

type ChallengeResponseParam struct {
	// Globally unique identifier for 3DS Authentication that resulted in
	// PENDING_CHALLENGE authentication result.
	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"`
}

Response from Card Program to a 3DS Authentication challenge

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
	CardBulkOrders          *CardBulkOrderService
	Balances                *BalanceService
	Disputes                *DisputeService
	DisputesV2              *DisputesV2Service
	Events                  *EventService
	Transfers               *TransferService
	FinancialAccounts       *FinancialAccountService
	Transactions            *TransactionService
	ResponderEndpoints      *ResponderEndpointService
	ExternalBankAccounts    *ExternalBankAccountService
	Payments                *PaymentService
	ThreeDS                 *ThreeDSService
	Reports                 *ReportService
	CardPrograms            *CardProgramService
	DigitalCardArt          *DigitalCardArtService
	BookTransfers           *BookTransferService
	CreditProducts          *CreditProductService
	ExternalPayments        *ExternalPaymentService
	ManagementOperations    *ManagementOperationService
	InternalTransaction     *InternalTransactionService
	FundingEvents           *FundingEventService
	Fraud                   *FraudService
	NetworkPrograms         *NetworkProgramService
	AccountActivity         *AccountActivityService
	TransferLimits          *TransferLimitService
	Webhooks                *WebhookService
}

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, LITHIC_BASE_URL). 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 Conditional3DSActionParameters added in v0.82.0 

type Conditional3DSActionParameters struct {
	// The action to take if the conditions are met.
	Action     Conditional3DSActionParametersAction      `json:"action,required"`
	Conditions []Conditional3DsActionParametersCondition `json:"conditions,required"`
	JSON       conditional3DsActionParametersJSON        `json:"-"`
}

func (*Conditional3DSActionParameters) UnmarshalJSON added in v0.82.0 

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

type Conditional3DSActionParametersAction added in v0.82.0 

type Conditional3DSActionParametersAction string

The action to take if the conditions are met. 

const (
	Conditional3DSActionParametersActionDecline   Conditional3DSActionParametersAction = "DECLINE"
	Conditional3DSActionParametersActionChallenge Conditional3DSActionParametersAction = "CHALLENGE"
)

func (Conditional3DSActionParametersAction) IsKnown added in v0.82.0 

func (r Conditional3DSActionParametersAction) IsKnown() bool

type Conditional3DSActionParametersConditionsAttribute added in v0.82.0 

type Conditional3DSActionParametersConditionsAttribute 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-character 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.
  • `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`: Mastercard only: Assessment by the network of the authentication risk level, with a higher value indicating a higher amount of risk.
  • `MESSAGE_CATEGORY`: The category of the authentication being processed.
  • `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address data with the cardholder KYC data if it exists. Valid values are `MATCH`, `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
const (
	Conditional3DSActionParametersConditionsAttributeMcc               Conditional3DSActionParametersConditionsAttribute = "MCC"
	Conditional3DSActionParametersConditionsAttributeCountry           Conditional3DSActionParametersConditionsAttribute = "COUNTRY"
	Conditional3DSActionParametersConditionsAttributeCurrency          Conditional3DSActionParametersConditionsAttribute = "CURRENCY"
	Conditional3DSActionParametersConditionsAttributeMerchantID        Conditional3DSActionParametersConditionsAttribute = "MERCHANT_ID"
	Conditional3DSActionParametersConditionsAttributeDescriptor        Conditional3DSActionParametersConditionsAttribute = "DESCRIPTOR"
	Conditional3DSActionParametersConditionsAttributeTransactionAmount Conditional3DSActionParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	Conditional3DSActionParametersConditionsAttributeRiskScore         Conditional3DSActionParametersConditionsAttribute = "RISK_SCORE"
	Conditional3DSActionParametersConditionsAttributeMessageCategory   Conditional3DSActionParametersConditionsAttribute = "MESSAGE_CATEGORY"
	Conditional3DSActionParametersConditionsAttributeAddressMatch      Conditional3DSActionParametersConditionsAttribute = "ADDRESS_MATCH"
)

func (Conditional3DSActionParametersConditionsAttribute) IsKnown added in v0.82.0 

func (r Conditional3DSActionParametersConditionsAttribute) IsKnown() bool

type Conditional3DsActionParametersCondition added in v0.82.0 

type Conditional3DsActionParametersCondition 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-character 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.
	//   - `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`: Mastercard only: Assessment by the network of the authentication
	//     risk level, with a higher value indicating a higher amount of risk.
	//   - `MESSAGE_CATEGORY`: The category of the authentication being processed.
	//   - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
	//     data with the cardholder KYC data if it exists. Valid values are `MATCH`,
	//     `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
	Attribute Conditional3DSActionParametersConditionsAttribute `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation ConditionalOperation `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value ConditionalValueUnion                       `json:"value,required" format:"date-time"`
	JSON  conditional3DsActionParametersConditionJSON `json:"-"`
}

func (*Conditional3DsActionParametersCondition) UnmarshalJSON added in v0.82.0 

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

type ConditionalACHActionParameters added in v0.96.0 

type ConditionalACHActionParameters struct {
	// The action to take if the conditions are met
	Action     ConditionalACHActionParametersAction      `json:"action,required"`
	Conditions []ConditionalACHActionParametersCondition `json:"conditions,required"`
	JSON       conditionalACHActionParametersJSON        `json:"-"`
}

func (*ConditionalACHActionParameters) UnmarshalJSON added in v0.96.0 

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

type ConditionalACHActionParametersAction added in v0.96.0 

type ConditionalACHActionParametersAction struct {
	// Approve the ACH transaction
	Type ConditionalACHActionParametersActionType `json:"type,required"`
	// NACHA return code to use when returning the transaction. Note that the list of
	// available return codes is subject to an allowlist configured at the program
	// level
	Code ConditionalACHActionParametersActionCode `json:"code"`
	JSON conditionalACHActionParametersActionJSON `json:"-"`
	// contains filtered or unexported fields
}

The action to take if the conditions are met

func (ConditionalACHActionParametersAction) AsUnion added in v0.96.0 

func (r ConditionalACHActionParametersAction) AsUnion() ConditionalACHActionParametersActionUnion

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

Possible runtime types of the union are ConditionalACHActionParametersActionApproveAction, ConditionalACHActionParametersActionReturnAction.

func (*ConditionalACHActionParametersAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalACHActionParametersActionApproveAction added in v0.96.0 

type ConditionalACHActionParametersActionApproveAction struct {
	// Approve the ACH transaction
	Type ConditionalACHActionParametersActionApproveActionType `json:"type,required"`
	JSON conditionalACHActionParametersActionApproveActionJSON `json:"-"`
}

func (*ConditionalACHActionParametersActionApproveAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalACHActionParametersActionApproveActionType added in v0.96.0 

type ConditionalACHActionParametersActionApproveActionType string

Approve the ACH transaction 

const (
	ConditionalACHActionParametersActionApproveActionTypeApprove ConditionalACHActionParametersActionApproveActionType = "APPROVE"
)

func (ConditionalACHActionParametersActionApproveActionType) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersActionApproveActionType) IsKnown() bool

type ConditionalACHActionParametersActionCode added in v0.96.0 

type ConditionalACHActionParametersActionCode string

NACHA return code to use when returning the transaction. Note that the list of available return codes is subject to an allowlist configured at the program level 

const (
	ConditionalACHActionParametersActionCodeR01 ConditionalACHActionParametersActionCode = "R01"
	ConditionalACHActionParametersActionCodeR02 ConditionalACHActionParametersActionCode = "R02"
	ConditionalACHActionParametersActionCodeR03 ConditionalACHActionParametersActionCode = "R03"
	ConditionalACHActionParametersActionCodeR04 ConditionalACHActionParametersActionCode = "R04"
	ConditionalACHActionParametersActionCodeR05 ConditionalACHActionParametersActionCode = "R05"
	ConditionalACHActionParametersActionCodeR06 ConditionalACHActionParametersActionCode = "R06"
	ConditionalACHActionParametersActionCodeR07 ConditionalACHActionParametersActionCode = "R07"
	ConditionalACHActionParametersActionCodeR08 ConditionalACHActionParametersActionCode = "R08"
	ConditionalACHActionParametersActionCodeR09 ConditionalACHActionParametersActionCode = "R09"
	ConditionalACHActionParametersActionCodeR10 ConditionalACHActionParametersActionCode = "R10"
	ConditionalACHActionParametersActionCodeR11 ConditionalACHActionParametersActionCode = "R11"
	ConditionalACHActionParametersActionCodeR12 ConditionalACHActionParametersActionCode = "R12"
	ConditionalACHActionParametersActionCodeR13 ConditionalACHActionParametersActionCode = "R13"
	ConditionalACHActionParametersActionCodeR14 ConditionalACHActionParametersActionCode = "R14"
	ConditionalACHActionParametersActionCodeR15 ConditionalACHActionParametersActionCode = "R15"
	ConditionalACHActionParametersActionCodeR16 ConditionalACHActionParametersActionCode = "R16"
	ConditionalACHActionParametersActionCodeR17 ConditionalACHActionParametersActionCode = "R17"
	ConditionalACHActionParametersActionCodeR18 ConditionalACHActionParametersActionCode = "R18"
	ConditionalACHActionParametersActionCodeR19 ConditionalACHActionParametersActionCode = "R19"
	ConditionalACHActionParametersActionCodeR20 ConditionalACHActionParametersActionCode = "R20"
	ConditionalACHActionParametersActionCodeR21 ConditionalACHActionParametersActionCode = "R21"
	ConditionalACHActionParametersActionCodeR22 ConditionalACHActionParametersActionCode = "R22"
	ConditionalACHActionParametersActionCodeR23 ConditionalACHActionParametersActionCode = "R23"
	ConditionalACHActionParametersActionCodeR24 ConditionalACHActionParametersActionCode = "R24"
	ConditionalACHActionParametersActionCodeR25 ConditionalACHActionParametersActionCode = "R25"
	ConditionalACHActionParametersActionCodeR26 ConditionalACHActionParametersActionCode = "R26"
	ConditionalACHActionParametersActionCodeR27 ConditionalACHActionParametersActionCode = "R27"
	ConditionalACHActionParametersActionCodeR28 ConditionalACHActionParametersActionCode = "R28"
	ConditionalACHActionParametersActionCodeR29 ConditionalACHActionParametersActionCode = "R29"
	ConditionalACHActionParametersActionCodeR30 ConditionalACHActionParametersActionCode = "R30"
	ConditionalACHActionParametersActionCodeR31 ConditionalACHActionParametersActionCode = "R31"
	ConditionalACHActionParametersActionCodeR32 ConditionalACHActionParametersActionCode = "R32"
	ConditionalACHActionParametersActionCodeR33 ConditionalACHActionParametersActionCode = "R33"
	ConditionalACHActionParametersActionCodeR34 ConditionalACHActionParametersActionCode = "R34"
	ConditionalACHActionParametersActionCodeR35 ConditionalACHActionParametersActionCode = "R35"
	ConditionalACHActionParametersActionCodeR36 ConditionalACHActionParametersActionCode = "R36"
	ConditionalACHActionParametersActionCodeR37 ConditionalACHActionParametersActionCode = "R37"
	ConditionalACHActionParametersActionCodeR38 ConditionalACHActionParametersActionCode = "R38"
	ConditionalACHActionParametersActionCodeR39 ConditionalACHActionParametersActionCode = "R39"
	ConditionalACHActionParametersActionCodeR40 ConditionalACHActionParametersActionCode = "R40"
	ConditionalACHActionParametersActionCodeR41 ConditionalACHActionParametersActionCode = "R41"
	ConditionalACHActionParametersActionCodeR42 ConditionalACHActionParametersActionCode = "R42"
	ConditionalACHActionParametersActionCodeR43 ConditionalACHActionParametersActionCode = "R43"
	ConditionalACHActionParametersActionCodeR44 ConditionalACHActionParametersActionCode = "R44"
	ConditionalACHActionParametersActionCodeR45 ConditionalACHActionParametersActionCode = "R45"
	ConditionalACHActionParametersActionCodeR46 ConditionalACHActionParametersActionCode = "R46"
	ConditionalACHActionParametersActionCodeR47 ConditionalACHActionParametersActionCode = "R47"
	ConditionalACHActionParametersActionCodeR50 ConditionalACHActionParametersActionCode = "R50"
	ConditionalACHActionParametersActionCodeR51 ConditionalACHActionParametersActionCode = "R51"
	ConditionalACHActionParametersActionCodeR52 ConditionalACHActionParametersActionCode = "R52"
	ConditionalACHActionParametersActionCodeR53 ConditionalACHActionParametersActionCode = "R53"
	ConditionalACHActionParametersActionCodeR61 ConditionalACHActionParametersActionCode = "R61"
	ConditionalACHActionParametersActionCodeR62 ConditionalACHActionParametersActionCode = "R62"
	ConditionalACHActionParametersActionCodeR67 ConditionalACHActionParametersActionCode = "R67"
	ConditionalACHActionParametersActionCodeR68 ConditionalACHActionParametersActionCode = "R68"
	ConditionalACHActionParametersActionCodeR69 ConditionalACHActionParametersActionCode = "R69"
	ConditionalACHActionParametersActionCodeR70 ConditionalACHActionParametersActionCode = "R70"
	ConditionalACHActionParametersActionCodeR71 ConditionalACHActionParametersActionCode = "R71"
	ConditionalACHActionParametersActionCodeR72 ConditionalACHActionParametersActionCode = "R72"
	ConditionalACHActionParametersActionCodeR73 ConditionalACHActionParametersActionCode = "R73"
	ConditionalACHActionParametersActionCodeR74 ConditionalACHActionParametersActionCode = "R74"
	ConditionalACHActionParametersActionCodeR75 ConditionalACHActionParametersActionCode = "R75"
	ConditionalACHActionParametersActionCodeR76 ConditionalACHActionParametersActionCode = "R76"
	ConditionalACHActionParametersActionCodeR77 ConditionalACHActionParametersActionCode = "R77"
	ConditionalACHActionParametersActionCodeR80 ConditionalACHActionParametersActionCode = "R80"
	ConditionalACHActionParametersActionCodeR81 ConditionalACHActionParametersActionCode = "R81"
	ConditionalACHActionParametersActionCodeR82 ConditionalACHActionParametersActionCode = "R82"
	ConditionalACHActionParametersActionCodeR83 ConditionalACHActionParametersActionCode = "R83"
	ConditionalACHActionParametersActionCodeR84 ConditionalACHActionParametersActionCode = "R84"
	ConditionalACHActionParametersActionCodeR85 ConditionalACHActionParametersActionCode = "R85"
)

func (ConditionalACHActionParametersActionCode) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersActionCode) IsKnown() bool

type ConditionalACHActionParametersActionReturnAction added in v0.96.0 

type ConditionalACHActionParametersActionReturnAction struct {
	// NACHA return code to use when returning the transaction. Note that the list of
	// available return codes is subject to an allowlist configured at the program
	// level
	Code ConditionalACHActionParametersActionReturnActionCode `json:"code,required"`
	// Return the ACH transaction
	Type ConditionalACHActionParametersActionReturnActionType `json:"type,required"`
	JSON conditionalACHActionParametersActionReturnActionJSON `json:"-"`
}

func (*ConditionalACHActionParametersActionReturnAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalACHActionParametersActionReturnActionCode added in v0.96.0 

type ConditionalACHActionParametersActionReturnActionCode string

NACHA return code to use when returning the transaction. Note that the list of available return codes is subject to an allowlist configured at the program level 

const (
	ConditionalACHActionParametersActionReturnActionCodeR01 ConditionalACHActionParametersActionReturnActionCode = "R01"
	ConditionalACHActionParametersActionReturnActionCodeR02 ConditionalACHActionParametersActionReturnActionCode = "R02"
	ConditionalACHActionParametersActionReturnActionCodeR03 ConditionalACHActionParametersActionReturnActionCode = "R03"
	ConditionalACHActionParametersActionReturnActionCodeR04 ConditionalACHActionParametersActionReturnActionCode = "R04"
	ConditionalACHActionParametersActionReturnActionCodeR05 ConditionalACHActionParametersActionReturnActionCode = "R05"
	ConditionalACHActionParametersActionReturnActionCodeR06 ConditionalACHActionParametersActionReturnActionCode = "R06"
	ConditionalACHActionParametersActionReturnActionCodeR07 ConditionalACHActionParametersActionReturnActionCode = "R07"
	ConditionalACHActionParametersActionReturnActionCodeR08 ConditionalACHActionParametersActionReturnActionCode = "R08"
	ConditionalACHActionParametersActionReturnActionCodeR09 ConditionalACHActionParametersActionReturnActionCode = "R09"
	ConditionalACHActionParametersActionReturnActionCodeR10 ConditionalACHActionParametersActionReturnActionCode = "R10"
	ConditionalACHActionParametersActionReturnActionCodeR11 ConditionalACHActionParametersActionReturnActionCode = "R11"
	ConditionalACHActionParametersActionReturnActionCodeR12 ConditionalACHActionParametersActionReturnActionCode = "R12"
	ConditionalACHActionParametersActionReturnActionCodeR13 ConditionalACHActionParametersActionReturnActionCode = "R13"
	ConditionalACHActionParametersActionReturnActionCodeR14 ConditionalACHActionParametersActionReturnActionCode = "R14"
	ConditionalACHActionParametersActionReturnActionCodeR15 ConditionalACHActionParametersActionReturnActionCode = "R15"
	ConditionalACHActionParametersActionReturnActionCodeR16 ConditionalACHActionParametersActionReturnActionCode = "R16"
	ConditionalACHActionParametersActionReturnActionCodeR17 ConditionalACHActionParametersActionReturnActionCode = "R17"
	ConditionalACHActionParametersActionReturnActionCodeR18 ConditionalACHActionParametersActionReturnActionCode = "R18"
	ConditionalACHActionParametersActionReturnActionCodeR19 ConditionalACHActionParametersActionReturnActionCode = "R19"
	ConditionalACHActionParametersActionReturnActionCodeR20 ConditionalACHActionParametersActionReturnActionCode = "R20"
	ConditionalACHActionParametersActionReturnActionCodeR21 ConditionalACHActionParametersActionReturnActionCode = "R21"
	ConditionalACHActionParametersActionReturnActionCodeR22 ConditionalACHActionParametersActionReturnActionCode = "R22"
	ConditionalACHActionParametersActionReturnActionCodeR23 ConditionalACHActionParametersActionReturnActionCode = "R23"
	ConditionalACHActionParametersActionReturnActionCodeR24 ConditionalACHActionParametersActionReturnActionCode = "R24"
	ConditionalACHActionParametersActionReturnActionCodeR25 ConditionalACHActionParametersActionReturnActionCode = "R25"
	ConditionalACHActionParametersActionReturnActionCodeR26 ConditionalACHActionParametersActionReturnActionCode = "R26"
	ConditionalACHActionParametersActionReturnActionCodeR27 ConditionalACHActionParametersActionReturnActionCode = "R27"
	ConditionalACHActionParametersActionReturnActionCodeR28 ConditionalACHActionParametersActionReturnActionCode = "R28"
	ConditionalACHActionParametersActionReturnActionCodeR29 ConditionalACHActionParametersActionReturnActionCode = "R29"
	ConditionalACHActionParametersActionReturnActionCodeR30 ConditionalACHActionParametersActionReturnActionCode = "R30"
	ConditionalACHActionParametersActionReturnActionCodeR31 ConditionalACHActionParametersActionReturnActionCode = "R31"
	ConditionalACHActionParametersActionReturnActionCodeR32 ConditionalACHActionParametersActionReturnActionCode = "R32"
	ConditionalACHActionParametersActionReturnActionCodeR33 ConditionalACHActionParametersActionReturnActionCode = "R33"
	ConditionalACHActionParametersActionReturnActionCodeR34 ConditionalACHActionParametersActionReturnActionCode = "R34"
	ConditionalACHActionParametersActionReturnActionCodeR35 ConditionalACHActionParametersActionReturnActionCode = "R35"
	ConditionalACHActionParametersActionReturnActionCodeR36 ConditionalACHActionParametersActionReturnActionCode = "R36"
	ConditionalACHActionParametersActionReturnActionCodeR37 ConditionalACHActionParametersActionReturnActionCode = "R37"
	ConditionalACHActionParametersActionReturnActionCodeR38 ConditionalACHActionParametersActionReturnActionCode = "R38"
	ConditionalACHActionParametersActionReturnActionCodeR39 ConditionalACHActionParametersActionReturnActionCode = "R39"
	ConditionalACHActionParametersActionReturnActionCodeR40 ConditionalACHActionParametersActionReturnActionCode = "R40"
	ConditionalACHActionParametersActionReturnActionCodeR41 ConditionalACHActionParametersActionReturnActionCode = "R41"
	ConditionalACHActionParametersActionReturnActionCodeR42 ConditionalACHActionParametersActionReturnActionCode = "R42"
	ConditionalACHActionParametersActionReturnActionCodeR43 ConditionalACHActionParametersActionReturnActionCode = "R43"
	ConditionalACHActionParametersActionReturnActionCodeR44 ConditionalACHActionParametersActionReturnActionCode = "R44"
	ConditionalACHActionParametersActionReturnActionCodeR45 ConditionalACHActionParametersActionReturnActionCode = "R45"
	ConditionalACHActionParametersActionReturnActionCodeR46 ConditionalACHActionParametersActionReturnActionCode = "R46"
	ConditionalACHActionParametersActionReturnActionCodeR47 ConditionalACHActionParametersActionReturnActionCode = "R47"
	ConditionalACHActionParametersActionReturnActionCodeR50 ConditionalACHActionParametersActionReturnActionCode = "R50"
	ConditionalACHActionParametersActionReturnActionCodeR51 ConditionalACHActionParametersActionReturnActionCode = "R51"
	ConditionalACHActionParametersActionReturnActionCodeR52 ConditionalACHActionParametersActionReturnActionCode = "R52"
	ConditionalACHActionParametersActionReturnActionCodeR53 ConditionalACHActionParametersActionReturnActionCode = "R53"
	ConditionalACHActionParametersActionReturnActionCodeR61 ConditionalACHActionParametersActionReturnActionCode = "R61"
	ConditionalACHActionParametersActionReturnActionCodeR62 ConditionalACHActionParametersActionReturnActionCode = "R62"
	ConditionalACHActionParametersActionReturnActionCodeR67 ConditionalACHActionParametersActionReturnActionCode = "R67"
	ConditionalACHActionParametersActionReturnActionCodeR68 ConditionalACHActionParametersActionReturnActionCode = "R68"
	ConditionalACHActionParametersActionReturnActionCodeR69 ConditionalACHActionParametersActionReturnActionCode = "R69"
	ConditionalACHActionParametersActionReturnActionCodeR70 ConditionalACHActionParametersActionReturnActionCode = "R70"
	ConditionalACHActionParametersActionReturnActionCodeR71 ConditionalACHActionParametersActionReturnActionCode = "R71"
	ConditionalACHActionParametersActionReturnActionCodeR72 ConditionalACHActionParametersActionReturnActionCode = "R72"
	ConditionalACHActionParametersActionReturnActionCodeR73 ConditionalACHActionParametersActionReturnActionCode = "R73"
	ConditionalACHActionParametersActionReturnActionCodeR74 ConditionalACHActionParametersActionReturnActionCode = "R74"
	ConditionalACHActionParametersActionReturnActionCodeR75 ConditionalACHActionParametersActionReturnActionCode = "R75"
	ConditionalACHActionParametersActionReturnActionCodeR76 ConditionalACHActionParametersActionReturnActionCode = "R76"
	ConditionalACHActionParametersActionReturnActionCodeR77 ConditionalACHActionParametersActionReturnActionCode = "R77"
	ConditionalACHActionParametersActionReturnActionCodeR80 ConditionalACHActionParametersActionReturnActionCode = "R80"
	ConditionalACHActionParametersActionReturnActionCodeR81 ConditionalACHActionParametersActionReturnActionCode = "R81"
	ConditionalACHActionParametersActionReturnActionCodeR82 ConditionalACHActionParametersActionReturnActionCode = "R82"
	ConditionalACHActionParametersActionReturnActionCodeR83 ConditionalACHActionParametersActionReturnActionCode = "R83"
	ConditionalACHActionParametersActionReturnActionCodeR84 ConditionalACHActionParametersActionReturnActionCode = "R84"
	ConditionalACHActionParametersActionReturnActionCodeR85 ConditionalACHActionParametersActionReturnActionCode = "R85"
)

func (ConditionalACHActionParametersActionReturnActionCode) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersActionReturnActionCode) IsKnown() bool

type ConditionalACHActionParametersActionReturnActionType added in v0.96.0 

type ConditionalACHActionParametersActionReturnActionType string

Return the ACH transaction 

const (
	ConditionalACHActionParametersActionReturnActionTypeReturn ConditionalACHActionParametersActionReturnActionType = "RETURN"
)

func (ConditionalACHActionParametersActionReturnActionType) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersActionReturnActionType) IsKnown() bool

type ConditionalACHActionParametersActionType added in v0.96.0 

type ConditionalACHActionParametersActionType string

Approve the ACH transaction 

const (
	ConditionalACHActionParametersActionTypeApprove ConditionalACHActionParametersActionType = "APPROVE"
	ConditionalACHActionParametersActionTypeReturn  ConditionalACHActionParametersActionType = "RETURN"
)

func (ConditionalACHActionParametersActionType) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersActionType) IsKnown() bool

type ConditionalACHActionParametersActionUnion added in v0.96.0 

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

The action to take if the conditions are met

Union satisfied by ConditionalACHActionParametersActionApproveAction or ConditionalACHActionParametersActionReturnAction.

type ConditionalACHActionParametersCondition added in v0.96.0 

type ConditionalACHActionParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `COMPANY_NAME`: The name of the company initiating the ACH transaction.
	//   - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company
	//     ID) of the entity initiating the ACH transaction.
	//   - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format.
	//   - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units
	//     (cents).
	//   - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction.
	//     Valid values include PPD (Prearranged Payment and Deposit Entry), CCD
	//     (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
	//     (Telephone-Initiated Entry), and others.
	//   - `MEMO`: Optional memo or description field included with the ACH transaction.
	Attribute ConditionalACHActionParametersConditionsAttribute `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation ConditionalOperation `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value ConditionalValueUnion                       `json:"value,required" format:"date-time"`
	JSON  conditionalACHActionParametersConditionJSON `json:"-"`
}

func (*ConditionalACHActionParametersCondition) UnmarshalJSON added in v0.96.0 

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

type ConditionalACHActionParametersConditionsAttribute added in v0.96.0 

type ConditionalACHActionParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `COMPANY_NAME`: The name of the company initiating the ACH transaction.
  • `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company ID) of the entity initiating the ACH transaction.
  • `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format.
  • `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units (cents).
  • `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. Valid values include PPD (Prearranged Payment and Deposit Entry), CCD (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL (Telephone-Initiated Entry), and others.
  • `MEMO`: Optional memo or description field included with the ACH transaction.
const (
	ConditionalACHActionParametersConditionsAttributeCompanyName       ConditionalACHActionParametersConditionsAttribute = "COMPANY_NAME"
	ConditionalACHActionParametersConditionsAttributeCompanyID         ConditionalACHActionParametersConditionsAttribute = "COMPANY_ID"
	ConditionalACHActionParametersConditionsAttributeTimestamp         ConditionalACHActionParametersConditionsAttribute = "TIMESTAMP"
	ConditionalACHActionParametersConditionsAttributeTransactionAmount ConditionalACHActionParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	ConditionalACHActionParametersConditionsAttributeSecCode           ConditionalACHActionParametersConditionsAttribute = "SEC_CODE"
	ConditionalACHActionParametersConditionsAttributeMemo              ConditionalACHActionParametersConditionsAttribute = "MEMO"
)

func (ConditionalACHActionParametersConditionsAttribute) IsKnown added in v0.96.0 

func (r ConditionalACHActionParametersConditionsAttribute) IsKnown() bool

type ConditionalAttribute added in v0.64.0 

type ConditionalAttribute 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-character 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.
  • `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the trailing 15 minutes before the authorization.
  • `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the trailing hour up and until the authorization.
  • `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the trailing 24 hours up and until the authorization.
  • `CARD_STATE`: The current state of the card associated with the transaction. Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
  • `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction. Valid values are `TRUE`, `FALSE`.
  • `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`, `OK`, `BLOCKED`.
  • `WALLET_TYPE`: For transactions using a digital wallet token, indicates the source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`, `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
  • `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address data with the cardholder KYC data if it exists. Valid values are `MATCH`, `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
const (
	ConditionalAttributeMcc                     ConditionalAttribute = "MCC"
	ConditionalAttributeCountry                 ConditionalAttribute = "COUNTRY"
	ConditionalAttributeCurrency                ConditionalAttribute = "CURRENCY"
	ConditionalAttributeMerchantID              ConditionalAttribute = "MERCHANT_ID"
	ConditionalAttributeDescriptor              ConditionalAttribute = "DESCRIPTOR"
	ConditionalAttributeLiabilityShift          ConditionalAttribute = "LIABILITY_SHIFT"
	ConditionalAttributePanEntryMode            ConditionalAttribute = "PAN_ENTRY_MODE"
	ConditionalAttributeTransactionAmount       ConditionalAttribute = "TRANSACTION_AMOUNT"
	ConditionalAttributeRiskScore               ConditionalAttribute = "RISK_SCORE"
	ConditionalAttributeCardTransactionCount15M ConditionalAttribute = "CARD_TRANSACTION_COUNT_15M"
	ConditionalAttributeCardTransactionCount1H  ConditionalAttribute = "CARD_TRANSACTION_COUNT_1H"
	ConditionalAttributeCardTransactionCount24H ConditionalAttribute = "CARD_TRANSACTION_COUNT_24H"
	ConditionalAttributeCardState               ConditionalAttribute = "CARD_STATE"
	ConditionalAttributePinEntered              ConditionalAttribute = "PIN_ENTERED"
	ConditionalAttributePinStatus               ConditionalAttribute = "PIN_STATUS"
	ConditionalAttributeWalletType              ConditionalAttribute = "WALLET_TYPE"
	ConditionalAttributeAddressMatch            ConditionalAttribute = "ADDRESS_MATCH"
)

func (ConditionalAttribute) IsKnown added in v0.64.0 

func (r ConditionalAttribute) IsKnown() bool

type ConditionalAuthorizationActionParameters added in v0.96.0 

type ConditionalAuthorizationActionParameters struct {
	// The action to take if the conditions are met.
	Action     ConditionalAuthorizationActionParametersAction      `json:"action,required"`
	Conditions []ConditionalAuthorizationActionParametersCondition `json:"conditions,required"`
	JSON       conditionalAuthorizationActionParametersJSON        `json:"-"`
}

func (*ConditionalAuthorizationActionParameters) UnmarshalJSON added in v0.96.0 

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

type ConditionalAuthorizationActionParametersAction added in v0.96.0 

type ConditionalAuthorizationActionParametersAction string

The action to take if the conditions are met. 

const (
	ConditionalAuthorizationActionParametersActionDecline   ConditionalAuthorizationActionParametersAction = "DECLINE"
	ConditionalAuthorizationActionParametersActionChallenge ConditionalAuthorizationActionParametersAction = "CHALLENGE"
)

func (ConditionalAuthorizationActionParametersAction) IsKnown added in v0.96.0 

func (r ConditionalAuthorizationActionParametersAction) IsKnown() bool

type ConditionalAuthorizationActionParametersCondition added in v0.96.0 

type ConditionalAuthorizationActionParametersCondition 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-character 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.
	//   - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
	//     represents the amount of cash being withdrawn or advanced.
	//   - `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.
	//   - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
	//     trailing 15 minutes before the authorization.
	//   - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
	//     trailing hour up and until the authorization.
	//   - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
	//     trailing 24 hours up and until the authorization.
	//   - `CARD_STATE`: The current state of the card associated with the transaction.
	//     Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
	//     `PENDING_FULFILLMENT`.
	//   - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
	//     Valid values are `TRUE`, `FALSE`.
	//   - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
	//     `OK`, `BLOCKED`.
	//   - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
	//     source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
	//     `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
	//   - `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates
	//     the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
	//   - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
	//     data with the cardholder KYC data if it exists. Valid values are `MATCH`,
	//     `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
	Attribute ConditionalAuthorizationActionParametersConditionsAttribute `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation ConditionalOperation `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value ConditionalValueUnion                                 `json:"value,required" format:"date-time"`
	JSON  conditionalAuthorizationActionParametersConditionJSON `json:"-"`
}

func (*ConditionalAuthorizationActionParametersCondition) UnmarshalJSON added in v0.96.0 

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

type ConditionalAuthorizationActionParametersConditionsAttribute added in v0.96.0 

type ConditionalAuthorizationActionParametersConditionsAttribute 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-character 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.
  • `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This represents the amount of cash being withdrawn or advanced.
  • `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.
  • `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the trailing 15 minutes before the authorization.
  • `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the trailing hour up and until the authorization.
  • `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the trailing 24 hours up and until the authorization.
  • `CARD_STATE`: The current state of the card associated with the transaction. Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
  • `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction. Valid values are `TRUE`, `FALSE`.
  • `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`, `OK`, `BLOCKED`.
  • `WALLET_TYPE`: For transactions using a digital wallet token, indicates the source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`, `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
  • `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
  • `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address data with the cardholder KYC data if it exists. Valid values are `MATCH`, `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
const (
	ConditionalAuthorizationActionParametersConditionsAttributeMcc                     ConditionalAuthorizationActionParametersConditionsAttribute = "MCC"
	ConditionalAuthorizationActionParametersConditionsAttributeCountry                 ConditionalAuthorizationActionParametersConditionsAttribute = "COUNTRY"
	ConditionalAuthorizationActionParametersConditionsAttributeCurrency                ConditionalAuthorizationActionParametersConditionsAttribute = "CURRENCY"
	ConditionalAuthorizationActionParametersConditionsAttributeMerchantID              ConditionalAuthorizationActionParametersConditionsAttribute = "MERCHANT_ID"
	ConditionalAuthorizationActionParametersConditionsAttributeDescriptor              ConditionalAuthorizationActionParametersConditionsAttribute = "DESCRIPTOR"
	ConditionalAuthorizationActionParametersConditionsAttributeLiabilityShift          ConditionalAuthorizationActionParametersConditionsAttribute = "LIABILITY_SHIFT"
	ConditionalAuthorizationActionParametersConditionsAttributePanEntryMode            ConditionalAuthorizationActionParametersConditionsAttribute = "PAN_ENTRY_MODE"
	ConditionalAuthorizationActionParametersConditionsAttributeTransactionAmount       ConditionalAuthorizationActionParametersConditionsAttribute = "TRANSACTION_AMOUNT"
	ConditionalAuthorizationActionParametersConditionsAttributeCashAmount              ConditionalAuthorizationActionParametersConditionsAttribute = "CASH_AMOUNT"
	ConditionalAuthorizationActionParametersConditionsAttributeRiskScore               ConditionalAuthorizationActionParametersConditionsAttribute = "RISK_SCORE"
	ConditionalAuthorizationActionParametersConditionsAttributeCardTransactionCount15M ConditionalAuthorizationActionParametersConditionsAttribute = "CARD_TRANSACTION_COUNT_15M"
	ConditionalAuthorizationActionParametersConditionsAttributeCardTransactionCount1H  ConditionalAuthorizationActionParametersConditionsAttribute = "CARD_TRANSACTION_COUNT_1H"
	ConditionalAuthorizationActionParametersConditionsAttributeCardTransactionCount24H ConditionalAuthorizationActionParametersConditionsAttribute = "CARD_TRANSACTION_COUNT_24H"
	ConditionalAuthorizationActionParametersConditionsAttributeCardState               ConditionalAuthorizationActionParametersConditionsAttribute = "CARD_STATE"
	ConditionalAuthorizationActionParametersConditionsAttributePinEntered              ConditionalAuthorizationActionParametersConditionsAttribute = "PIN_ENTERED"
	ConditionalAuthorizationActionParametersConditionsAttributePinStatus               ConditionalAuthorizationActionParametersConditionsAttribute = "PIN_STATUS"
	ConditionalAuthorizationActionParametersConditionsAttributeWalletType              ConditionalAuthorizationActionParametersConditionsAttribute = "WALLET_TYPE"
	ConditionalAuthorizationActionParametersConditionsAttributeTransactionInitiator    ConditionalAuthorizationActionParametersConditionsAttribute = "TRANSACTION_INITIATOR"
	ConditionalAuthorizationActionParametersConditionsAttributeAddressMatch            ConditionalAuthorizationActionParametersConditionsAttribute = "ADDRESS_MATCH"
)

func (ConditionalAuthorizationActionParametersConditionsAttribute) IsKnown added in v0.96.0 

func (r ConditionalAuthorizationActionParametersConditionsAttribute) IsKnown() bool

type ConditionalBlockParameters added in v0.64.0 

type ConditionalBlockParameters struct {
	Conditions []AuthRuleCondition            `json:"conditions,required"`
	JSON       conditionalBlockParametersJSON `json:"-"`
}

func (*ConditionalBlockParameters) UnmarshalJSON added in v0.64.0 

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

type ConditionalOperation added in v0.96.0 

type ConditionalOperation string

The operation to apply to the attribute 

const (
	ConditionalOperationIsOneOf                ConditionalOperation = "IS_ONE_OF"
	ConditionalOperationIsNotOneOf             ConditionalOperation = "IS_NOT_ONE_OF"
	ConditionalOperationMatches                ConditionalOperation = "MATCHES"
	ConditionalOperationDoesNotMatch           ConditionalOperation = "DOES_NOT_MATCH"
	ConditionalOperationIsEqualTo              ConditionalOperation = "IS_EQUAL_TO"
	ConditionalOperationIsNotEqualTo           ConditionalOperation = "IS_NOT_EQUAL_TO"
	ConditionalOperationIsGreaterThan          ConditionalOperation = "IS_GREATER_THAN"
	ConditionalOperationIsGreaterThanOrEqualTo ConditionalOperation = "IS_GREATER_THAN_OR_EQUAL_TO"
	ConditionalOperationIsLessThan             ConditionalOperation = "IS_LESS_THAN"
	ConditionalOperationIsLessThanOrEqualTo    ConditionalOperation = "IS_LESS_THAN_OR_EQUAL_TO"
	ConditionalOperationIsAfter                ConditionalOperation = "IS_AFTER"
	ConditionalOperationIsBefore               ConditionalOperation = "IS_BEFORE"
	ConditionalOperationContainsAny            ConditionalOperation = "CONTAINS_ANY"
	ConditionalOperationContainsAll            ConditionalOperation = "CONTAINS_ALL"
	ConditionalOperationContainsNone           ConditionalOperation = "CONTAINS_NONE"
)

func (ConditionalOperation) IsKnown added in v0.96.0 

func (r ConditionalOperation) IsKnown() bool

type ConditionalTokenizationActionParameters added in v0.96.0 

type ConditionalTokenizationActionParameters struct {
	// The action to take if the conditions are met
	Action     ConditionalTokenizationActionParametersAction      `json:"action,required"`
	Conditions []ConditionalTokenizationActionParametersCondition `json:"conditions,required"`
	JSON       conditionalTokenizationActionParametersJSON        `json:"-"`
}

func (*ConditionalTokenizationActionParameters) UnmarshalJSON added in v0.96.0 

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

type ConditionalTokenizationActionParametersAction added in v0.96.0 

type ConditionalTokenizationActionParametersAction struct {
	// Decline the tokenization request
	Type ConditionalTokenizationActionParametersActionType `json:"type,required"`
	// Reason code for declining the tokenization request
	Reason ConditionalTokenizationActionParametersActionReason `json:"reason"`
	JSON   conditionalTokenizationActionParametersActionJSON   `json:"-"`
	// contains filtered or unexported fields
}

The action to take if the conditions are met

func (ConditionalTokenizationActionParametersAction) AsUnion added in v0.96.0 

func (r ConditionalTokenizationActionParametersAction) AsUnion() ConditionalTokenizationActionParametersActionUnion

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

Possible runtime types of the union are ConditionalTokenizationActionParametersActionDeclineAction, ConditionalTokenizationActionParametersActionRequireTfaAction.

func (*ConditionalTokenizationActionParametersAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalTokenizationActionParametersActionDeclineAction added in v0.96.0 

type ConditionalTokenizationActionParametersActionDeclineAction struct {
	// Decline the tokenization request
	Type ConditionalTokenizationActionParametersActionDeclineActionType `json:"type,required"`
	// Reason code for declining the tokenization request
	Reason ConditionalTokenizationActionParametersActionDeclineActionReason `json:"reason"`
	JSON   conditionalTokenizationActionParametersActionDeclineActionJSON   `json:"-"`
}

func (*ConditionalTokenizationActionParametersActionDeclineAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalTokenizationActionParametersActionDeclineActionReason added in v0.96.0 

type ConditionalTokenizationActionParametersActionDeclineActionReason string

Reason code for declining the tokenization request 

const (
	ConditionalTokenizationActionParametersActionDeclineActionReasonAccountScore1                  ConditionalTokenizationActionParametersActionDeclineActionReason = "ACCOUNT_SCORE_1"
	ConditionalTokenizationActionParametersActionDeclineActionReasonDeviceScore1                   ConditionalTokenizationActionParametersActionDeclineActionReason = "DEVICE_SCORE_1"
	ConditionalTokenizationActionParametersActionDeclineActionReasonAllWalletDeclineReasonsPresent ConditionalTokenizationActionParametersActionDeclineActionReason = "ALL_WALLET_DECLINE_REASONS_PRESENT"
	ConditionalTokenizationActionParametersActionDeclineActionReasonWalletRecommendedDecisionRed   ConditionalTokenizationActionParametersActionDeclineActionReason = "WALLET_RECOMMENDED_DECISION_RED"
	ConditionalTokenizationActionParametersActionDeclineActionReasonCvcMismatch                    ConditionalTokenizationActionParametersActionDeclineActionReason = "CVC_MISMATCH"
	ConditionalTokenizationActionParametersActionDeclineActionReasonCardExpiryMonthMismatch        ConditionalTokenizationActionParametersActionDeclineActionReason = "CARD_EXPIRY_MONTH_MISMATCH"
	ConditionalTokenizationActionParametersActionDeclineActionReasonCardExpiryYearMismatch         ConditionalTokenizationActionParametersActionDeclineActionReason = "CARD_EXPIRY_YEAR_MISMATCH"
	ConditionalTokenizationActionParametersActionDeclineActionReasonCardInvalidState               ConditionalTokenizationActionParametersActionDeclineActionReason = "CARD_INVALID_STATE"
	ConditionalTokenizationActionParametersActionDeclineActionReasonCustomerRedPath                ConditionalTokenizationActionParametersActionDeclineActionReason = "CUSTOMER_RED_PATH"
	ConditionalTokenizationActionParametersActionDeclineActionReasonInvalidCustomerResponse        ConditionalTokenizationActionParametersActionDeclineActionReason = "INVALID_CUSTOMER_RESPONSE"
	ConditionalTokenizationActionParametersActionDeclineActionReasonNetworkFailure                 ConditionalTokenizationActionParametersActionDeclineActionReason = "NETWORK_FAILURE"
	ConditionalTokenizationActionParametersActionDeclineActionReasonGenericDecline                 ConditionalTokenizationActionParametersActionDeclineActionReason = "GENERIC_DECLINE"
	ConditionalTokenizationActionParametersActionDeclineActionReasonDigitalCardArtRequired         ConditionalTokenizationActionParametersActionDeclineActionReason = "DIGITAL_CARD_ART_REQUIRED"
)

func (ConditionalTokenizationActionParametersActionDeclineActionReason) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionDeclineActionReason) IsKnown() bool

type ConditionalTokenizationActionParametersActionDeclineActionType added in v0.96.0 

type ConditionalTokenizationActionParametersActionDeclineActionType string

Decline the tokenization request 

const (
	ConditionalTokenizationActionParametersActionDeclineActionTypeDecline ConditionalTokenizationActionParametersActionDeclineActionType = "DECLINE"
)

func (ConditionalTokenizationActionParametersActionDeclineActionType) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionDeclineActionType) IsKnown() bool

type ConditionalTokenizationActionParametersActionReason added in v0.96.0 

type ConditionalTokenizationActionParametersActionReason string

Reason code for declining the tokenization request 

const (
	ConditionalTokenizationActionParametersActionReasonAccountScore1                  ConditionalTokenizationActionParametersActionReason = "ACCOUNT_SCORE_1"
	ConditionalTokenizationActionParametersActionReasonDeviceScore1                   ConditionalTokenizationActionParametersActionReason = "DEVICE_SCORE_1"
	ConditionalTokenizationActionParametersActionReasonAllWalletDeclineReasonsPresent ConditionalTokenizationActionParametersActionReason = "ALL_WALLET_DECLINE_REASONS_PRESENT"
	ConditionalTokenizationActionParametersActionReasonWalletRecommendedDecisionRed   ConditionalTokenizationActionParametersActionReason = "WALLET_RECOMMENDED_DECISION_RED"
	ConditionalTokenizationActionParametersActionReasonCvcMismatch                    ConditionalTokenizationActionParametersActionReason = "CVC_MISMATCH"
	ConditionalTokenizationActionParametersActionReasonCardExpiryMonthMismatch        ConditionalTokenizationActionParametersActionReason = "CARD_EXPIRY_MONTH_MISMATCH"
	ConditionalTokenizationActionParametersActionReasonCardExpiryYearMismatch         ConditionalTokenizationActionParametersActionReason = "CARD_EXPIRY_YEAR_MISMATCH"
	ConditionalTokenizationActionParametersActionReasonCardInvalidState               ConditionalTokenizationActionParametersActionReason = "CARD_INVALID_STATE"
	ConditionalTokenizationActionParametersActionReasonCustomerRedPath                ConditionalTokenizationActionParametersActionReason = "CUSTOMER_RED_PATH"
	ConditionalTokenizationActionParametersActionReasonInvalidCustomerResponse        ConditionalTokenizationActionParametersActionReason = "INVALID_CUSTOMER_RESPONSE"
	ConditionalTokenizationActionParametersActionReasonNetworkFailure                 ConditionalTokenizationActionParametersActionReason = "NETWORK_FAILURE"
	ConditionalTokenizationActionParametersActionReasonGenericDecline                 ConditionalTokenizationActionParametersActionReason = "GENERIC_DECLINE"
	ConditionalTokenizationActionParametersActionReasonDigitalCardArtRequired         ConditionalTokenizationActionParametersActionReason = "DIGITAL_CARD_ART_REQUIRED"
	ConditionalTokenizationActionParametersActionReasonWalletRecommendedTfa           ConditionalTokenizationActionParametersActionReason = "WALLET_RECOMMENDED_TFA"
	ConditionalTokenizationActionParametersActionReasonSuspiciousActivity             ConditionalTokenizationActionParametersActionReason = "SUSPICIOUS_ACTIVITY"
	ConditionalTokenizationActionParametersActionReasonDeviceRecentlyLost             ConditionalTokenizationActionParametersActionReason = "DEVICE_RECENTLY_LOST"
	ConditionalTokenizationActionParametersActionReasonTooManyRecentAttempts          ConditionalTokenizationActionParametersActionReason = "TOO_MANY_RECENT_ATTEMPTS"
	ConditionalTokenizationActionParametersActionReasonTooManyRecentTokens            ConditionalTokenizationActionParametersActionReason = "TOO_MANY_RECENT_TOKENS"
	ConditionalTokenizationActionParametersActionReasonTooManyDifferentCardholders    ConditionalTokenizationActionParametersActionReason = "TOO_MANY_DIFFERENT_CARDHOLDERS"
	ConditionalTokenizationActionParametersActionReasonOutsideHomeTerritory           ConditionalTokenizationActionParametersActionReason = "OUTSIDE_HOME_TERRITORY"
	ConditionalTokenizationActionParametersActionReasonHasSuspendedTokens             ConditionalTokenizationActionParametersActionReason = "HAS_SUSPENDED_TOKENS"
	ConditionalTokenizationActionParametersActionReasonHighRisk                       ConditionalTokenizationActionParametersActionReason = "HIGH_RISK"
	ConditionalTokenizationActionParametersActionReasonAccountScoreLow                ConditionalTokenizationActionParametersActionReason = "ACCOUNT_SCORE_LOW"
	ConditionalTokenizationActionParametersActionReasonDeviceScoreLow                 ConditionalTokenizationActionParametersActionReason = "DEVICE_SCORE_LOW"
	ConditionalTokenizationActionParametersActionReasonCardStateTfa                   ConditionalTokenizationActionParametersActionReason = "CARD_STATE_TFA"
	ConditionalTokenizationActionParametersActionReasonHardcodedTfa                   ConditionalTokenizationActionParametersActionReason = "HARDCODED_TFA"
	ConditionalTokenizationActionParametersActionReasonCustomerRuleTfa                ConditionalTokenizationActionParametersActionReason = "CUSTOMER_RULE_TFA"
	ConditionalTokenizationActionParametersActionReasonDeviceHostCardEmulation        ConditionalTokenizationActionParametersActionReason = "DEVICE_HOST_CARD_EMULATION"
)

func (ConditionalTokenizationActionParametersActionReason) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionReason) IsKnown() bool

type ConditionalTokenizationActionParametersActionRequireTfaAction added in v0.96.0 

type ConditionalTokenizationActionParametersActionRequireTfaAction struct {
	// Require two-factor authentication for the tokenization request
	Type ConditionalTokenizationActionParametersActionRequireTfaActionType `json:"type,required"`
	// Reason code for requiring two-factor authentication
	Reason ConditionalTokenizationActionParametersActionRequireTfaActionReason `json:"reason"`
	JSON   conditionalTokenizationActionParametersActionRequireTfaActionJSON   `json:"-"`
}

func (*ConditionalTokenizationActionParametersActionRequireTfaAction) UnmarshalJSON added in v0.96.0 

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

type ConditionalTokenizationActionParametersActionRequireTfaActionReason added in v0.96.0 

type ConditionalTokenizationActionParametersActionRequireTfaActionReason string

Reason code for requiring two-factor authentication 

const (
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonWalletRecommendedTfa        ConditionalTokenizationActionParametersActionRequireTfaActionReason = "WALLET_RECOMMENDED_TFA"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonSuspiciousActivity          ConditionalTokenizationActionParametersActionRequireTfaActionReason = "SUSPICIOUS_ACTIVITY"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonDeviceRecentlyLost          ConditionalTokenizationActionParametersActionRequireTfaActionReason = "DEVICE_RECENTLY_LOST"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonTooManyRecentAttempts       ConditionalTokenizationActionParametersActionRequireTfaActionReason = "TOO_MANY_RECENT_ATTEMPTS"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonTooManyRecentTokens         ConditionalTokenizationActionParametersActionRequireTfaActionReason = "TOO_MANY_RECENT_TOKENS"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonTooManyDifferentCardholders ConditionalTokenizationActionParametersActionRequireTfaActionReason = "TOO_MANY_DIFFERENT_CARDHOLDERS"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonOutsideHomeTerritory        ConditionalTokenizationActionParametersActionRequireTfaActionReason = "OUTSIDE_HOME_TERRITORY"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonHasSuspendedTokens          ConditionalTokenizationActionParametersActionRequireTfaActionReason = "HAS_SUSPENDED_TOKENS"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonHighRisk                    ConditionalTokenizationActionParametersActionRequireTfaActionReason = "HIGH_RISK"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonAccountScoreLow             ConditionalTokenizationActionParametersActionRequireTfaActionReason = "ACCOUNT_SCORE_LOW"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonDeviceScoreLow              ConditionalTokenizationActionParametersActionRequireTfaActionReason = "DEVICE_SCORE_LOW"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonCardStateTfa                ConditionalTokenizationActionParametersActionRequireTfaActionReason = "CARD_STATE_TFA"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonHardcodedTfa                ConditionalTokenizationActionParametersActionRequireTfaActionReason = "HARDCODED_TFA"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonCustomerRuleTfa             ConditionalTokenizationActionParametersActionRequireTfaActionReason = "CUSTOMER_RULE_TFA"
	ConditionalTokenizationActionParametersActionRequireTfaActionReasonDeviceHostCardEmulation     ConditionalTokenizationActionParametersActionRequireTfaActionReason = "DEVICE_HOST_CARD_EMULATION"
)

func (ConditionalTokenizationActionParametersActionRequireTfaActionReason) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionRequireTfaActionReason) IsKnown() bool

type ConditionalTokenizationActionParametersActionRequireTfaActionType added in v0.96.0 

type ConditionalTokenizationActionParametersActionRequireTfaActionType string

Require two-factor authentication for the tokenization request 

const (
	ConditionalTokenizationActionParametersActionRequireTfaActionTypeRequireTfa ConditionalTokenizationActionParametersActionRequireTfaActionType = "REQUIRE_TFA"
)

func (ConditionalTokenizationActionParametersActionRequireTfaActionType) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionRequireTfaActionType) IsKnown() bool

type ConditionalTokenizationActionParametersActionType added in v0.96.0 

type ConditionalTokenizationActionParametersActionType string

Decline the tokenization request 

const (
	ConditionalTokenizationActionParametersActionTypeDecline    ConditionalTokenizationActionParametersActionType = "DECLINE"
	ConditionalTokenizationActionParametersActionTypeRequireTfa ConditionalTokenizationActionParametersActionType = "REQUIRE_TFA"
)

func (ConditionalTokenizationActionParametersActionType) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersActionType) IsKnown() bool

type ConditionalTokenizationActionParametersActionUnion added in v0.96.0 

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

The action to take if the conditions are met

Union satisfied by ConditionalTokenizationActionParametersActionDeclineAction or ConditionalTokenizationActionParametersActionRequireTfaAction.

type ConditionalTokenizationActionParametersCondition added in v0.96.0 

type ConditionalTokenizationActionParametersCondition struct {
	// The attribute to target.
	//
	// The following attributes may be targeted:
	//
	//   - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format.
	//   - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was
	//     initiated (e.g., DIGITAL_WALLET, ECOMMERCE).
	//   - `TOKENIZATION_SOURCE`: The source of the tokenization request.
	//   - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid
	//     values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`,
	//     `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`,
	//     `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`,
	//     `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`.
	//   - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet.
	//     Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2
	//     = medium risk).
	//   - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet.
	//     Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2
	//     = medium risk).
	//   - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet
	//     provider. Valid values include APPROVE, DECLINE,
	//     REQUIRE_ADDITIONAL_AUTHENTICATION.
	//   - `WALLET_RECOMMENDATION_REASONS`: List of reasons provided by the digital
	//     wallet provider for the recommended decision. Valid values are
	//     `ACCOUNT_CARD_TOO_NEW`, `ACCOUNT_RECENTLY_CHANGED`, `ACCOUNT_TOO_NEW`,
	//     `ACCOUNT_TOO_NEW_SINCE_LAUNCH`, `DEVICE_RECENTLY_LOST`,
	//     `HAS_SUSPENDED_TOKENS`, `HIGH_RISK`, `INACTIVE_ACCOUNT`, `LOW_ACCOUNT_SCORE`,
	//     `LOW_DEVICE_SCORE`, `OUTSIDE_HOME_TERRITORY`, `SUSPICIOUS_ACTIVITY`,
	//     `TOO_MANY_DIFFERENT_CARDHOLDERS`, `TOO_MANY_RECENT_ATTEMPTS`,
	//     `TOO_MANY_RECENT_TOKENS`, `UNABLE_TO_ASSESS`.
	//   - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token.
	//   - `WALLET_TOKEN_STATUS`: The current status of the wallet token.
	//   - `CARD_STATE`: The state of the card being tokenized. Valid values are
	//     `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
	Attribute ConditionalTokenizationActionParametersConditionsAttribute `json:"attribute,required"`
	// The operation to apply to the attribute
	Operation ConditionalOperation `json:"operation,required"`
	// A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
	Value ConditionalValueUnion                                `json:"value,required" format:"date-time"`
	JSON  conditionalTokenizationActionParametersConditionJSON `json:"-"`
}

func (*ConditionalTokenizationActionParametersCondition) UnmarshalJSON added in v0.96.0 

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

type ConditionalTokenizationActionParametersConditionsAttribute added in v0.96.0 

type ConditionalTokenizationActionParametersConditionsAttribute string

The attribute to target.

The following attributes may be targeted:

  • `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format.
  • `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was initiated (e.g., DIGITAL_WALLET, ECOMMERCE).
  • `TOKENIZATION_SOURCE`: The source of the tokenization request.
  • `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`.
  • `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 = medium risk).
  • `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 = medium risk).
  • `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet provider. Valid values include APPROVE, DECLINE, REQUIRE_ADDITIONAL_AUTHENTICATION.
  • `WALLET_RECOMMENDATION_REASONS`: List of reasons provided by the digital wallet provider for the recommended decision. Valid values are `ACCOUNT_CARD_TOO_NEW`, `ACCOUNT_RECENTLY_CHANGED`, `ACCOUNT_TOO_NEW`, `ACCOUNT_TOO_NEW_SINCE_LAUNCH`, `DEVICE_RECENTLY_LOST`, `HAS_SUSPENDED_TOKENS`, `HIGH_RISK`, `INACTIVE_ACCOUNT`, `LOW_ACCOUNT_SCORE`, `LOW_DEVICE_SCORE`, `OUTSIDE_HOME_TERRITORY`, `SUSPICIOUS_ACTIVITY`, `TOO_MANY_DIFFERENT_CARDHOLDERS`, `TOO_MANY_RECENT_ATTEMPTS`, `TOO_MANY_RECENT_TOKENS`, `UNABLE_TO_ASSESS`.
  • `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token.
  • `WALLET_TOKEN_STATUS`: The current status of the wallet token.
  • `CARD_STATE`: The state of the card being tokenized. Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
const (
	ConditionalTokenizationActionParametersConditionsAttributeTimestamp                   ConditionalTokenizationActionParametersConditionsAttribute = "TIMESTAMP"
	ConditionalTokenizationActionParametersConditionsAttributeTokenizationChannel         ConditionalTokenizationActionParametersConditionsAttribute = "TOKENIZATION_CHANNEL"
	ConditionalTokenizationActionParametersConditionsAttributeTokenizationSource          ConditionalTokenizationActionParametersConditionsAttribute = "TOKENIZATION_SOURCE"
	ConditionalTokenizationActionParametersConditionsAttributeTokenRequestorName          ConditionalTokenizationActionParametersConditionsAttribute = "TOKEN_REQUESTOR_NAME"
	ConditionalTokenizationActionParametersConditionsAttributeWalletAccountScore          ConditionalTokenizationActionParametersConditionsAttribute = "WALLET_ACCOUNT_SCORE"
	ConditionalTokenizationActionParametersConditionsAttributeWalletDeviceScore           ConditionalTokenizationActionParametersConditionsAttribute = "WALLET_DEVICE_SCORE"
	ConditionalTokenizationActionParametersConditionsAttributeWalletRecommendedDecision   ConditionalTokenizationActionParametersConditionsAttribute = "WALLET_RECOMMENDED_DECISION"
	ConditionalTokenizationActionParametersConditionsAttributeWalletRecommendationReasons ConditionalTokenizationActionParametersConditionsAttribute = "WALLET_RECOMMENDATION_REASONS"
	ConditionalTokenizationActionParametersConditionsAttributeTokenRequestorID            ConditionalTokenizationActionParametersConditionsAttribute = "TOKEN_REQUESTOR_ID"
	ConditionalTokenizationActionParametersConditionsAttributeWalletTokenStatus           ConditionalTokenizationActionParametersConditionsAttribute = "WALLET_TOKEN_STATUS"
	ConditionalTokenizationActionParametersConditionsAttributeCardState                   ConditionalTokenizationActionParametersConditionsAttribute = "CARD_STATE"
)

func (ConditionalTokenizationActionParametersConditionsAttribute) IsKnown added in v0.96.0 

func (r ConditionalTokenizationActionParametersConditionsAttribute) IsKnown() bool

type ConditionalValueListOfStrings added in v0.96.0 

type ConditionalValueListOfStrings []string

func (ConditionalValueListOfStrings) ImplementsConditionalValueUnion added in v0.96.0 

func (r ConditionalValueListOfStrings) ImplementsConditionalValueUnion()

type ConditionalValueListOfStringsParam added in v0.96.0 

type ConditionalValueListOfStringsParam []string

func (ConditionalValueListOfStringsParam) ImplementsConditionalValueUnionParam added in v0.96.0 

func (r ConditionalValueListOfStringsParam) ImplementsConditionalValueUnionParam()

type ConditionalValueUnion added in v0.96.0 

type ConditionalValueUnion interface {
	ImplementsConditionalValueUnion()
}

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

Union satisfied by shared.UnionString, shared.UnionInt, ConditionalValueListOfStrings or shared.UnionTime.

type ConditionalValueUnionParam added in v0.96.0 

type ConditionalValueUnionParam interface {
	ImplementsConditionalValueUnionParam()
}

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

Satisfied by shared.UnionString, shared.UnionInt, ConditionalValueListOfStringsParam, shared.UnionTime.

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 CreditProductService added in v0.64.0 

type CreditProductService struct {
	Options        []option.RequestOption
	ExtendedCredit *CreditProductExtendedCreditService
	PrimeRates     *CreditProductPrimeRateService
}

CreditProductService 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 NewCreditProductService method instead.

func NewCreditProductService added in v0.64.0 

func NewCreditProductService(opts ...option.RequestOption) (r *CreditProductService)

NewCreditProductService 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 Currency added in v0.50.0 

type Currency = shared.Currency

3-character alphabetic ISO 4217 currency

This is an alias to an internal type.

type Device added in v0.98.0 

type Device struct {
	// The IMEI number of the device being provisioned. For Amex, this field contains
	// device ID instead as IMEI is not provided
	Imei string `json:"imei,required,nullable"`
	// The IP address of the device initiating the request
	IPAddress string `json:"ip_address,required,nullable"`
	// Latitude and longitude where the device is located during the authorization
	// attempt
	Location string     `json:"location,required,nullable"`
	JSON     deviceJSON `json:"-"`
}

func (*Device) UnmarshalJSON added in v0.98.0 

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

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 DigitalWalletTokenMetadata added in v0.98.0 

type DigitalWalletTokenMetadata struct {
	// Contains the information of the account responsible for the payment.
	PaymentAccountInfo DigitalWalletTokenMetadataPaymentAccountInfo `json:"payment_account_info,required"`
	// The current status of the digital wallet token. Pending or declined.
	Status string `json:"status,required"`
	// The identifier of the Payment App instance within a device that will be
	// provisioned with a token
	PaymentAppInstanceID string `json:"payment_app_instance_id,nullable"`
	// The party that requested the digitization
	TokenRequestorID string `json:"token_requestor_id"`
	// Human-readable name of the wallet that the token_requestor_id maps to.
	TokenRequestorName DigitalWalletTokenMetadataTokenRequestorName `json:"token_requestor_name"`
	JSON               digitalWalletTokenMetadataJSON               `json:"-"`
}

Contains the metadata for the digital wallet being tokenized.

func (*DigitalWalletTokenMetadata) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenMetadataPaymentAccountInfo added in v0.98.0 

type DigitalWalletTokenMetadataPaymentAccountInfo struct {
	// Additional information that can be used to identify the account holder, such as
	// name, address, etc
	AccountHolderData DigitalWalletTokenMetadataPaymentAccountInfoAccountHolderData `json:"account_holder_data,required"`
	// Reference to the PAN that is unique per Wallet Provider
	PanUniqueReference string `json:"pan_unique_reference,nullable"`
	// The unique account reference assigned to the PAN
	PaymentAccountReference string `json:"payment_account_reference,nullable"`
	// A unique reference assigned following the allocation of a token used to identify
	// the token for the duration of its lifetime.
	TokenUniqueReference string                                           `json:"token_unique_reference,nullable"`
	JSON                 digitalWalletTokenMetadataPaymentAccountInfoJSON `json:"-"`
}

Contains the information of the account responsible for the payment.

func (*DigitalWalletTokenMetadataPaymentAccountInfo) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenMetadataPaymentAccountInfoAccountHolderData added in v0.98.0 

type DigitalWalletTokenMetadataPaymentAccountInfoAccountHolderData struct {
	// The phone number, may contain country code along with phone number when
	// countryDialInCode is not present
	PhoneNumber string                                                            `json:"phone_number,nullable"`
	JSON        digitalWalletTokenMetadataPaymentAccountInfoAccountHolderDataJSON `json:"-"`
}

Additional information that can be used to identify the account holder, such as name, address, etc

func (*DigitalWalletTokenMetadataPaymentAccountInfoAccountHolderData) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenMetadataTokenRequestorName added in v0.98.0 

type DigitalWalletTokenMetadataTokenRequestorName string

Human-readable name of the wallet that the token_requestor_id maps to. 

const (
	DigitalWalletTokenMetadataTokenRequestorNameAmazonOne    DigitalWalletTokenMetadataTokenRequestorName = "AMAZON_ONE"
	DigitalWalletTokenMetadataTokenRequestorNameAndroidPay   DigitalWalletTokenMetadataTokenRequestorName = "ANDROID_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameApplePay     DigitalWalletTokenMetadataTokenRequestorName = "APPLE_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameFacebook     DigitalWalletTokenMetadataTokenRequestorName = "FACEBOOK"
	DigitalWalletTokenMetadataTokenRequestorNameFitbitPay    DigitalWalletTokenMetadataTokenRequestorName = "FITBIT_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameGarminPay    DigitalWalletTokenMetadataTokenRequestorName = "GARMIN_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameMicrosoftPay DigitalWalletTokenMetadataTokenRequestorName = "MICROSOFT_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameNetflix      DigitalWalletTokenMetadataTokenRequestorName = "NETFLIX"
	DigitalWalletTokenMetadataTokenRequestorNameSamsungPay   DigitalWalletTokenMetadataTokenRequestorName = "SAMSUNG_PAY"
	DigitalWalletTokenMetadataTokenRequestorNameUnknown      DigitalWalletTokenMetadataTokenRequestorName = "UNKNOWN"
	DigitalWalletTokenMetadataTokenRequestorNameVisaCheckout DigitalWalletTokenMetadataTokenRequestorName = "VISA_CHECKOUT"
)

func (DigitalWalletTokenMetadataTokenRequestorName) IsKnown added in v0.98.0 

func (r DigitalWalletTokenMetadataTokenRequestorName) IsKnown() bool

type DigitalWalletTokenizationApprovalRequestWebhookEvent added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken string `json:"account_token,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// Contains the metadata for the customer tokenization decision.
	CustomerTokenizationDecision DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecision `json:"customer_tokenization_decision,required,nullable"`
	// The name of this event
	EventType DigitalWalletTokenizationApprovalRequestWebhookEventEventType `json:"event_type,required"`
	// Whether Lithic decisioned on the token, and if so, what the decision was.
	// APPROVED/VERIFICATION_REQUIRED/DENIED.
	IssuerDecision DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision `json:"issuer_decision,required"`
	// The channel through which the tokenization was made.
	TokenizationChannel DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel `json:"tokenization_channel,required"`
	// Unique identifier for the digital wallet token attempt
	TokenizationToken     string                `json:"tokenization_token,required"`
	WalletDecisioningInfo WalletDecisioningInfo `json:"wallet_decisioning_info,required"`
	Device                Device                `json:"device"`
	// Contains the metadata for the digital wallet being tokenized.
	DigitalWalletTokenMetadata DigitalWalletTokenMetadata `json:"digital_wallet_token_metadata"`
	// Results from rules that were evaluated for this tokenization
	RuleResults []TokenizationRuleResult `json:"rule_results"`
	// List of reasons why the tokenization was declined
	TokenizationDeclineReasons []TokenizationDeclineReason `json:"tokenization_decline_reasons"`
	// The source of the tokenization.
	TokenizationSource DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource `json:"tokenization_source"`
	// List of reasons why two-factor authentication was required
	TokenizationTfaReasons []TokenizationTfaReason                                  `json:"tokenization_tfa_reasons"`
	JSON                   digitalWalletTokenizationApprovalRequestWebhookEventJSON `json:"-"`
}

func (*DigitalWalletTokenizationApprovalRequestWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecision added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecision struct {
	// The outcome of the customer's decision
	Outcome DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome `json:"outcome,required"`
	// The customer's subscribed URL
	ResponderURL string `json:"responder_url,required"`
	// Time in ms it took for the customer's URL to respond
	Latency string `json:"latency"`
	// The response code that the customer provided
	ResponseCode string                                                                               `json:"response_code"`
	JSON         digitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionJSON `json:"-"`
}

Contains the metadata for the customer tokenization decision.

func (*DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecision) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome string

The outcome of the customer's decision 

const (
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeApproved                        DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "APPROVED"
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeDeclined                        DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "DECLINED"
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeError                           DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "ERROR"
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeInvalidResponse                 DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "INVALID_RESPONSE"
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeRequireAdditionalAuthentication DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "REQUIRE_ADDITIONAL_AUTHENTICATION"
	DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeTimeout                         DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "TIMEOUT"
)

func (DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome) IsKnown() bool

type DigitalWalletTokenizationApprovalRequestWebhookEventEventType added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventEventType string

The name of this event 

const (
	DigitalWalletTokenizationApprovalRequestWebhookEventEventTypeDigitalWalletTokenizationApprovalRequest DigitalWalletTokenizationApprovalRequestWebhookEventEventType = "digital_wallet.tokenization_approval_request"
)

func (DigitalWalletTokenizationApprovalRequestWebhookEventEventType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationApprovalRequestWebhookEventEventType) IsKnown() bool

type DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision string

Whether Lithic decisioned on the token, and if so, what the decision was. APPROVED/VERIFICATION_REQUIRED/DENIED. 

const (
	DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecisionApproved             DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision = "APPROVED"
	DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecisionDenied               DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision = "DENIED"
	DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecisionVerificationRequired DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision = "VERIFICATION_REQUIRED"
)

func (DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationApprovalRequestWebhookEventIssuerDecision) IsKnown() bool

type DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel string

The channel through which the tokenization was made. 

const (
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannelDigitalWallet DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel = "DIGITAL_WALLET"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannelMerchant      DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel = "MERCHANT"
)

func (DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationChannel) IsKnown() bool

type DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource added in v0.98.0 

type DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource string

The source of the tokenization. 

const (
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourceAccountOnFile   DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "ACCOUNT_ON_FILE"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourceContactlessTap  DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "CONTACTLESS_TAP"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourceManualProvision DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "MANUAL_PROVISION"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourcePushProvision   DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "PUSH_PROVISION"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourceToken           DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "TOKEN"
	DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSourceUnknown         DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource = "UNKNOWN"
)

func (DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationApprovalRequestWebhookEventTokenizationSource) IsKnown() bool

type DigitalWalletTokenizationResultWebhookEvent added in v0.98.0 

type DigitalWalletTokenizationResultWebhookEvent struct {
	// Account token
	AccountToken string `json:"account_token,required"`
	// Card token
	CardToken string `json:"card_token,required"`
	// Created date
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType DigitalWalletTokenizationResultWebhookEventEventType `json:"event_type,required"`
	// The result of the tokenization request.
	TokenizationResultDetails DigitalWalletTokenizationResultWebhookEventTokenizationResultDetails `json:"tokenization_result_details,required"`
	// Tokenization token
	TokenizationToken string                                          `json:"tokenization_token,required"`
	JSON              digitalWalletTokenizationResultWebhookEventJSON `json:"-"`
}

func (*DigitalWalletTokenizationResultWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationResultWebhookEventEventType added in v0.98.0 

type DigitalWalletTokenizationResultWebhookEventEventType string

The type of event that occurred. 

const (
	DigitalWalletTokenizationResultWebhookEventEventTypeDigitalWalletTokenizationResult DigitalWalletTokenizationResultWebhookEventEventType = "digital_wallet.tokenization_result"
)

func (DigitalWalletTokenizationResultWebhookEventEventType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationResultWebhookEventEventType) IsKnown() bool

type DigitalWalletTokenizationResultWebhookEventTokenizationResultDetails added in v0.98.0 

type DigitalWalletTokenizationResultWebhookEventTokenizationResultDetails struct {
	// Lithic's tokenization decision.
	IssuerDecision string `json:"issuer_decision,required"`
	// List of reasons why the tokenization was declined
	TokenizationDeclineReasons []DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason `json:"tokenization_decline_reasons,required"`
	// The customer's tokenization decision if applicable.
	CustomerDecision string `json:"customer_decision,nullable"`
	// Results from rules that were evaluated for this tokenization
	RuleResults []TokenizationRuleResult `json:"rule_results"`
	// An RFC 3339 timestamp indicating when the tokenization succeeded.
	TokenActivatedDateTime time.Time `json:"token_activated_date_time,nullable" format:"date-time"`
	// List of reasons why two-factor authentication was required
	TokenizationTfaReasons []TokenizationTfaReason `json:"tokenization_tfa_reasons"`
	// The wallet's recommended decision.
	WalletDecision string                                                                   `json:"wallet_decision,nullable"`
	JSON           digitalWalletTokenizationResultWebhookEventTokenizationResultDetailsJSON `json:"-"`
}

The result of the tokenization request.

func (*DigitalWalletTokenizationResultWebhookEventTokenizationResultDetails) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason added in v0.98.0 

type DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason string
const (
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonAccountScore1                  DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "ACCOUNT_SCORE_1"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonAllWalletDeclineReasonsPresent DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "ALL_WALLET_DECLINE_REASONS_PRESENT"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardExpiryMonthMismatch        DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_EXPIRY_MONTH_MISMATCH"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardExpiryYearMismatch         DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_EXPIRY_YEAR_MISMATCH"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardInvalidState               DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_INVALID_STATE"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCustomerRedPath                DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CUSTOMER_RED_PATH"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCvcMismatch                    DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CVC_MISMATCH"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonDeviceScore1                   DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "DEVICE_SCORE_1"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonGenericDecline                 DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "GENERIC_DECLINE"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonInvalidCustomerResponse        DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "INVALID_CUSTOMER_RESPONSE"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonNetworkFailure                 DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "NETWORK_FAILURE"
	DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonWalletRecommendedDecisionRed   DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "WALLET_RECOMMENDED_DECISION_RED"
)

func (DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason) IsKnown() bool

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken     string                                                                               `json:"account_token,required"`
	ActivationMethod DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod `json:"activation_method,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType `json:"event_type,required"`
	// Unique identifier for the tokenization
	TokenizationToken string                                                                   `json:"tokenization_token,required"`
	JSON              digitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventJSON `json:"-"`
}

func (*DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod 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"
	Type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType `json:"type,required"`
	// The location to which the authentication code was sent. The format depends on
	// the ActivationMethod.Type field. If Type is Email, the Value will be the email
	// address. If the Type is Sms, the Value will be the phone number.
	Value string                                                                                   `json:"value,required"`
	JSON  digitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodJSON `json:"-"`
}

func (*DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType 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 (
	DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodTypeEmailToCardholderAddress DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType = "EMAIL_TO_CARDHOLDER_ADDRESS"
	DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodTypeTextToCardholderNumber   DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType = "TEXT_TO_CARDHOLDER_NUMBER"
)

func (DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType) IsKnown() bool

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType string

The type of event that occurred. 

const (
	DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
)

func (DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType) IsKnown() bool

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken     string                                                                           `json:"account_token,required"`
	ActivationMethod DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod `json:"activation_method,required"`
	// Authentication code to provide to the user tokenizing a card.
	AuthenticationCode string `json:"authentication_code,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType `json:"event_type,required"`
	// Unique identifier for the tokenization
	TokenizationToken string                                                               `json:"tokenization_token,required"`
	JSON              digitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventJSON `json:"-"`
}

func (*DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod 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"
	Type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType `json:"type,required"`
	// The location where the user wants to receive the authentication code. The format
	// depends on the ActivationMethod.Type field. If Type is Email, the Value will be
	// the email address. If the Type is Sms, the Value will be the phone number.
	Value string                                                                               `json:"value,required"`
	JSON  digitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodJSON `json:"-"`
}

func (*DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType 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 (
	DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodTypeEmailToCardholderAddress DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType = "EMAIL_TO_CARDHOLDER_ADDRESS"
	DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodTypeTextToCardholderNumber   DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType = "TEXT_TO_CARDHOLDER_NUMBER"
)

func (DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType) IsKnown() bool

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType added in v0.98.0 

type DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType string

The type of event that occurred. 

const (
	DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType = "digital_wallet.tokenization_two_factor_authentication_code"
)

func (DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventEventType) IsKnown() bool

type DigitalWalletTokenizationUpdatedWebhookEvent added in v0.98.0 

type DigitalWalletTokenizationUpdatedWebhookEvent struct {
	// Account token
	AccountToken string `json:"account_token,required"`
	// Card token
	CardToken string `json:"card_token,required"`
	// Created date
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType    DigitalWalletTokenizationUpdatedWebhookEventEventType `json:"event_type,required"`
	Tokenization Tokenization                                          `json:"tokenization,required"`
	JSON         digitalWalletTokenizationUpdatedWebhookEventJSON      `json:"-"`
}

func (*DigitalWalletTokenizationUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DigitalWalletTokenizationUpdatedWebhookEventEventType added in v0.98.0 

type DigitalWalletTokenizationUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	DigitalWalletTokenizationUpdatedWebhookEventEventTypeDigitalWalletTokenizationUpdated DigitalWalletTokenizationUpdatedWebhookEventEventType = "digital_wallet.tokenization_updated"
)

func (DigitalWalletTokenizationUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r DigitalWalletTokenizationUpdatedWebhookEventEventType) IsKnown() bool

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"`
	// 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 DisputeEvidenceUploadFailedWebhookEvent added in v0.98.0 

type DisputeEvidenceUploadFailedWebhookEvent struct {
	// The type of event that occurred.
	EventType DisputeEvidenceUploadFailedWebhookEventEventType `json:"event_type,required"`
	JSON      disputeEvidenceUploadFailedWebhookEventJSON      `json:"-"`
	DisputeEvidence
}

Dispute evidence.

func (*DisputeEvidenceUploadFailedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DisputeEvidenceUploadFailedWebhookEventEventType added in v0.98.0 

type DisputeEvidenceUploadFailedWebhookEventEventType string

The type of event that occurred. 

const (
	DisputeEvidenceUploadFailedWebhookEventEventTypeDisputeEvidenceUploadFailed DisputeEvidenceUploadFailedWebhookEventEventType = "dispute_evidence.upload_failed"
)

func (DisputeEvidenceUploadFailedWebhookEventEventType) IsKnown added in v0.98.0 

func (r DisputeEvidenceUploadFailedWebhookEventEventType) IsKnown() bool

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 DisputeTransactionCreatedWebhookEvent added in v0.98.0 

type DisputeTransactionCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType DisputeTransactionCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      disputeTransactionCreatedWebhookEventJSON      `json:"-"`
	DisputeV2
}

The Dispute object tracks the progression of a dispute throughout its lifecycle.

func (*DisputeTransactionCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DisputeTransactionCreatedWebhookEventEventType added in v0.98.0 

type DisputeTransactionCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	DisputeTransactionCreatedWebhookEventEventTypeDisputeTransactionCreated DisputeTransactionCreatedWebhookEventEventType = "dispute_transaction.created"
)

func (DisputeTransactionCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r DisputeTransactionCreatedWebhookEventEventType) IsKnown() bool

type DisputeTransactionUpdatedWebhookEvent added in v0.98.0 

type DisputeTransactionUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType DisputeTransactionUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      disputeTransactionUpdatedWebhookEventJSON      `json:"-"`
	DisputeV2
}

The Dispute object tracks the progression of a dispute throughout its lifecycle.

func (*DisputeTransactionUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DisputeTransactionUpdatedWebhookEventEventType added in v0.98.0 

type DisputeTransactionUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	DisputeTransactionUpdatedWebhookEventEventTypeDisputeTransactionUpdated DisputeTransactionUpdatedWebhookEventEventType = "dispute_transaction.updated"
)

func (DisputeTransactionUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r DisputeTransactionUpdatedWebhookEventEventType) 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 DisputeUpdatedWebhookEvent added in v0.98.0 

type DisputeUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType DisputeUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      disputeUpdatedWebhookEventJSON      `json:"-"`
	Dispute
}

Dispute.

func (*DisputeUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type DisputeUpdatedWebhookEventEventType added in v0.98.0 

type DisputeUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	DisputeUpdatedWebhookEventEventTypeDisputeUpdated DisputeUpdatedWebhookEventEventType = "dispute.updated"
)

func (DisputeUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r DisputeUpdatedWebhookEventEventType) IsKnown() bool

type DisputeUploadEvidenceParams added in v0.3.1 

type DisputeUploadEvidenceParams struct {
}

type DisputeV2 added in v0.96.0 

type DisputeV2 struct {
	// Token assigned by Lithic for the dispute, in UUID format.
	Token string `json:"token,required" format:"uuid"`
	// Token for the account associated with the dispute, in UUID format.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Token for the card used in the dispute, in UUID format.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Identifier assigned by the network for this dispute.
	CaseID string `json:"case_id,required,nullable"`
	// When the dispute was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Three-letter ISO 4217 currency code.
	Currency string `json:"currency,required"`
	// Dispute resolution outcome
	Disposition DisputeV2Disposition `json:"disposition,required,nullable"`
	// Chronological list of events that have occurred in the dispute lifecycle
	Events []DisputeV2Event `json:"events,required"`
	// Current breakdown of how liability is allocated for the disputed amount
	LiabilityAllocation DisputeV2LiabilityAllocation `json:"liability_allocation,required"`
	Merchant            shared.Merchant              `json:"merchant,required"`
	// Card network handling the dispute.
	Network DisputeV2Network `json:"network,required"`
	// Current status of the dispute.
	Status DisputeV2Status `json:"status,required,nullable"`
	// Contains identifiers for the transaction and specific event within being
	// disputed; null if no transaction can be identified
	TransactionSeries DisputeV2TransactionSeries `json:"transaction_series,required,nullable"`
	// When the dispute was last updated.
	Updated time.Time     `json:"updated,required" format:"date-time"`
	JSON    disputeV2JSON `json:"-"`
}

The Dispute object tracks the progression of a dispute throughout its lifecycle.

func (*DisputeV2) UnmarshalJSON added in v0.96.0 

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

type DisputeV2Disposition added in v0.96.0 

type DisputeV2Disposition string

Dispute resolution outcome 

const (
	DisputeV2DispositionWon          DisputeV2Disposition = "WON"
	DisputeV2DispositionLost         DisputeV2Disposition = "LOST"
	DisputeV2DispositionPartiallyWon DisputeV2Disposition = "PARTIALLY_WON"
	DisputeV2DispositionWithdrawn    DisputeV2Disposition = "WITHDRAWN"
	DisputeV2DispositionDenied       DisputeV2Disposition = "DENIED"
)

func (DisputeV2Disposition) IsKnown added in v0.96.0 

func (r DisputeV2Disposition) IsKnown() bool

type DisputeV2Event added in v0.96.0 

type DisputeV2Event struct {
	// Unique identifier for the event, in UUID format
	Token string `json:"token,required" format:"uuid"`
	// When the event occurred
	Created time.Time `json:"created,required" format:"date-time"`
	// Details specific to the event type
	Data DisputeV2EventsData `json:"data,required"`
	// Type of event
	Type DisputeV2EventsType `json:"type,required"`
	JSON disputeV2EventJSON  `json:"-"`
}

Event that occurred in the dispute lifecycle

func (*DisputeV2Event) UnmarshalJSON added in v0.96.0 

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

type DisputeV2EventsData added in v0.96.0 

type DisputeV2EventsData struct {
	// Amount in minor units
	Amount int64 `json:"amount,required,nullable"`
	// Event type discriminator
	Type DisputeV2EventsDataType `json:"type,required"`
	// Action taken in this stage
	Action DisputeV2EventsDataAction `json:"action"`
	// Dispute resolution outcome
	Disposition DisputeV2EventsDataDisposition `json:"disposition,nullable"`
	// Direction of funds flow
	Polarity DisputeV2EventsDataPolarity `json:"polarity"`
	// Reason for the action
	Reason string `json:"reason,nullable"`
	// Current stage of the dispute workflow
	Stage DisputeV2EventsDataStage `json:"stage"`
	JSON  disputeV2EventsDataJSON  `json:"-"`
	// contains filtered or unexported fields
}

Details specific to the event type

func (DisputeV2EventsData) AsUnion added in v0.96.0 

func (r DisputeV2EventsData) AsUnion() DisputeV2EventsDataUnion

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

Possible runtime types of the union are DisputeV2EventsDataWorkflow, DisputeV2EventsDataFinancial, DisputeV2EventsDataCardholderLiability.

func (*DisputeV2EventsData) UnmarshalJSON added in v0.96.0 

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

type DisputeV2EventsDataAction added in v0.96.0 

type DisputeV2EventsDataAction string

Action taken in this stage 

const (
	DisputeV2EventsDataActionOpened                    DisputeV2EventsDataAction = "OPENED"
	DisputeV2EventsDataActionClosed                    DisputeV2EventsDataAction = "CLOSED"
	DisputeV2EventsDataActionReopened                  DisputeV2EventsDataAction = "REOPENED"
	DisputeV2EventsDataActionProvisionalCreditGranted  DisputeV2EventsDataAction = "PROVISIONAL_CREDIT_GRANTED"
	DisputeV2EventsDataActionProvisionalCreditReversed DisputeV2EventsDataAction = "PROVISIONAL_CREDIT_REVERSED"
	DisputeV2EventsDataActionWrittenOff                DisputeV2EventsDataAction = "WRITTEN_OFF"
)

func (DisputeV2EventsDataAction) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataAction) IsKnown() bool

type DisputeV2EventsDataCardholderLiability added in v0.96.0 

type DisputeV2EventsDataCardholderLiability struct {
	// Action taken regarding cardholder liability
	Action DisputeV2EventsDataCardholderLiabilityAction `json:"action,required"`
	// Amount in minor units
	Amount int64 `json:"amount,required"`
	// Reason for the action
	Reason string `json:"reason,required"`
	// Event type discriminator
	Type DisputeV2EventsDataCardholderLiabilityType `json:"type,required"`
	JSON disputeV2EventsDataCardholderLiabilityJSON `json:"-"`
}

Details specific to cardholder liability events

func (*DisputeV2EventsDataCardholderLiability) UnmarshalJSON added in v0.96.0 

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

type DisputeV2EventsDataCardholderLiabilityAction added in v0.96.0 

type DisputeV2EventsDataCardholderLiabilityAction string

Action taken regarding cardholder liability 

const (
	DisputeV2EventsDataCardholderLiabilityActionProvisionalCreditGranted  DisputeV2EventsDataCardholderLiabilityAction = "PROVISIONAL_CREDIT_GRANTED"
	DisputeV2EventsDataCardholderLiabilityActionProvisionalCreditReversed DisputeV2EventsDataCardholderLiabilityAction = "PROVISIONAL_CREDIT_REVERSED"
	DisputeV2EventsDataCardholderLiabilityActionWrittenOff                DisputeV2EventsDataCardholderLiabilityAction = "WRITTEN_OFF"
)

func (DisputeV2EventsDataCardholderLiabilityAction) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataCardholderLiabilityAction) IsKnown() bool

type DisputeV2EventsDataCardholderLiabilityType added in v0.96.0 

type DisputeV2EventsDataCardholderLiabilityType string

Event type discriminator 

const (
	DisputeV2EventsDataCardholderLiabilityTypeCardholderLiability DisputeV2EventsDataCardholderLiabilityType = "CARDHOLDER_LIABILITY"
)

func (DisputeV2EventsDataCardholderLiabilityType) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataCardholderLiabilityType) IsKnown() bool

type DisputeV2EventsDataDisposition added in v0.96.0 

type DisputeV2EventsDataDisposition string

Dispute resolution outcome 

const (
	DisputeV2EventsDataDispositionWon          DisputeV2EventsDataDisposition = "WON"
	DisputeV2EventsDataDispositionLost         DisputeV2EventsDataDisposition = "LOST"
	DisputeV2EventsDataDispositionPartiallyWon DisputeV2EventsDataDisposition = "PARTIALLY_WON"
	DisputeV2EventsDataDispositionWithdrawn    DisputeV2EventsDataDisposition = "WITHDRAWN"
	DisputeV2EventsDataDispositionDenied       DisputeV2EventsDataDisposition = "DENIED"
)

func (DisputeV2EventsDataDisposition) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataDisposition) IsKnown() bool

type DisputeV2EventsDataFinancial added in v0.96.0 

type DisputeV2EventsDataFinancial struct {
	// Amount in minor units
	Amount int64 `json:"amount,required"`
	// Direction of funds flow
	Polarity DisputeV2EventsDataFinancialPolarity `json:"polarity,required"`
	// Stage at which the financial event occurred
	Stage DisputeV2EventsDataFinancialStage `json:"stage,required"`
	// Event type discriminator
	Type DisputeV2EventsDataFinancialType `json:"type,required"`
	JSON disputeV2EventsDataFinancialJSON `json:"-"`
}

Details specific to financial events

func (*DisputeV2EventsDataFinancial) UnmarshalJSON added in v0.96.0 

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

type DisputeV2EventsDataFinancialPolarity added in v0.96.0 

type DisputeV2EventsDataFinancialPolarity string

Direction of funds flow 

const (
	DisputeV2EventsDataFinancialPolarityCredit DisputeV2EventsDataFinancialPolarity = "CREDIT"
	DisputeV2EventsDataFinancialPolarityDebit  DisputeV2EventsDataFinancialPolarity = "DEBIT"
)

func (DisputeV2EventsDataFinancialPolarity) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataFinancialPolarity) IsKnown() bool

type DisputeV2EventsDataFinancialStage added in v0.96.0 

type DisputeV2EventsDataFinancialStage string

Stage at which the financial event occurred 

const (
	DisputeV2EventsDataFinancialStageChargeback     DisputeV2EventsDataFinancialStage = "CHARGEBACK"
	DisputeV2EventsDataFinancialStageRepresentment  DisputeV2EventsDataFinancialStage = "REPRESENTMENT"
	DisputeV2EventsDataFinancialStagePrearbitration DisputeV2EventsDataFinancialStage = "PREARBITRATION"
	DisputeV2EventsDataFinancialStageArbitration    DisputeV2EventsDataFinancialStage = "ARBITRATION"
	DisputeV2EventsDataFinancialStageCollaboration  DisputeV2EventsDataFinancialStage = "COLLABORATION"
)

func (DisputeV2EventsDataFinancialStage) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataFinancialStage) IsKnown() bool

type DisputeV2EventsDataFinancialType added in v0.96.0 

type DisputeV2EventsDataFinancialType string

Event type discriminator 

const (
	DisputeV2EventsDataFinancialTypeFinancial DisputeV2EventsDataFinancialType = "FINANCIAL"
)

func (DisputeV2EventsDataFinancialType) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataFinancialType) IsKnown() bool

type DisputeV2EventsDataPolarity added in v0.96.0 

type DisputeV2EventsDataPolarity string

Direction of funds flow 

const (
	DisputeV2EventsDataPolarityCredit DisputeV2EventsDataPolarity = "CREDIT"
	DisputeV2EventsDataPolarityDebit  DisputeV2EventsDataPolarity = "DEBIT"
)

func (DisputeV2EventsDataPolarity) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataPolarity) IsKnown() bool

type DisputeV2EventsDataStage added in v0.96.0 

type DisputeV2EventsDataStage string

Current stage of the dispute workflow 

const (
	DisputeV2EventsDataStageClaim          DisputeV2EventsDataStage = "CLAIM"
	DisputeV2EventsDataStageChargeback     DisputeV2EventsDataStage = "CHARGEBACK"
	DisputeV2EventsDataStageRepresentment  DisputeV2EventsDataStage = "REPRESENTMENT"
	DisputeV2EventsDataStagePrearbitration DisputeV2EventsDataStage = "PREARBITRATION"
	DisputeV2EventsDataStageArbitration    DisputeV2EventsDataStage = "ARBITRATION"
	DisputeV2EventsDataStageCollaboration  DisputeV2EventsDataStage = "COLLABORATION"
)

func (DisputeV2EventsDataStage) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataStage) IsKnown() bool

type DisputeV2EventsDataType added in v0.96.0 

type DisputeV2EventsDataType string

Event type discriminator 

const (
	DisputeV2EventsDataTypeWorkflow            DisputeV2EventsDataType = "WORKFLOW"
	DisputeV2EventsDataTypeFinancial           DisputeV2EventsDataType = "FINANCIAL"
	DisputeV2EventsDataTypeCardholderLiability DisputeV2EventsDataType = "CARDHOLDER_LIABILITY"
)

func (DisputeV2EventsDataType) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataType) IsKnown() bool

type DisputeV2EventsDataUnion added in v0.96.0 

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

Details specific to the event type

Union satisfied by DisputeV2EventsDataWorkflow, DisputeV2EventsDataFinancial or DisputeV2EventsDataCardholderLiability.

type DisputeV2EventsDataWorkflow added in v0.96.0 

type DisputeV2EventsDataWorkflow struct {
	// Action taken in this stage
	Action DisputeV2EventsDataWorkflowAction `json:"action,required"`
	// Amount in minor units
	Amount int64 `json:"amount,required,nullable"`
	// Dispute resolution outcome
	Disposition DisputeV2EventsDataWorkflowDisposition `json:"disposition,required,nullable"`
	// Reason for the action
	Reason string `json:"reason,required,nullable"`
	// Current stage of the dispute workflow
	Stage DisputeV2EventsDataWorkflowStage `json:"stage,required"`
	// Event type discriminator
	Type DisputeV2EventsDataWorkflowType `json:"type,required"`
	JSON disputeV2EventsDataWorkflowJSON `json:"-"`
}

Details specific to workflow events

func (*DisputeV2EventsDataWorkflow) UnmarshalJSON added in v0.96.0 

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

type DisputeV2EventsDataWorkflowAction added in v0.96.0 

type DisputeV2EventsDataWorkflowAction string

Action taken in this stage 

const (
	DisputeV2EventsDataWorkflowActionOpened   DisputeV2EventsDataWorkflowAction = "OPENED"
	DisputeV2EventsDataWorkflowActionClosed   DisputeV2EventsDataWorkflowAction = "CLOSED"
	DisputeV2EventsDataWorkflowActionReopened DisputeV2EventsDataWorkflowAction = "REOPENED"
)

func (DisputeV2EventsDataWorkflowAction) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataWorkflowAction) IsKnown() bool

type DisputeV2EventsDataWorkflowDisposition added in v0.96.0 

type DisputeV2EventsDataWorkflowDisposition string

Dispute resolution outcome 

const (
	DisputeV2EventsDataWorkflowDispositionWon          DisputeV2EventsDataWorkflowDisposition = "WON"
	DisputeV2EventsDataWorkflowDispositionLost         DisputeV2EventsDataWorkflowDisposition = "LOST"
	DisputeV2EventsDataWorkflowDispositionPartiallyWon DisputeV2EventsDataWorkflowDisposition = "PARTIALLY_WON"
	DisputeV2EventsDataWorkflowDispositionWithdrawn    DisputeV2EventsDataWorkflowDisposition = "WITHDRAWN"
	DisputeV2EventsDataWorkflowDispositionDenied       DisputeV2EventsDataWorkflowDisposition = "DENIED"
)

func (DisputeV2EventsDataWorkflowDisposition) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataWorkflowDisposition) IsKnown() bool

type DisputeV2EventsDataWorkflowStage added in v0.96.0 

type DisputeV2EventsDataWorkflowStage string

Current stage of the dispute workflow 

const (
	DisputeV2EventsDataWorkflowStageClaim DisputeV2EventsDataWorkflowStage = "CLAIM"
)

func (DisputeV2EventsDataWorkflowStage) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataWorkflowStage) IsKnown() bool

type DisputeV2EventsDataWorkflowType added in v0.96.0 

type DisputeV2EventsDataWorkflowType string

Event type discriminator 

const (
	DisputeV2EventsDataWorkflowTypeWorkflow DisputeV2EventsDataWorkflowType = "WORKFLOW"
)

func (DisputeV2EventsDataWorkflowType) IsKnown added in v0.96.0 

func (r DisputeV2EventsDataWorkflowType) IsKnown() bool

type DisputeV2EventsType added in v0.96.0 

type DisputeV2EventsType string

Type of event 

const (
	DisputeV2EventsTypeWorkflow            DisputeV2EventsType = "WORKFLOW"
	DisputeV2EventsTypeFinancial           DisputeV2EventsType = "FINANCIAL"
	DisputeV2EventsTypeCardholderLiability DisputeV2EventsType = "CARDHOLDER_LIABILITY"
)

func (DisputeV2EventsType) IsKnown added in v0.96.0 

func (r DisputeV2EventsType) IsKnown() bool

type DisputeV2LiabilityAllocation added in v0.96.0 

type DisputeV2LiabilityAllocation struct {
	// The amount that has been denied to the cardholder
	DeniedAmount int64 `json:"denied_amount,required"`
	// The initial amount disputed
	OriginalAmount int64 `json:"original_amount,required"`
	// The amount that has been recovered from the merchant through the dispute process
	RecoveredAmount int64 `json:"recovered_amount,required"`
	// Any disputed amount that is still outstanding, i.e. has not been recovered,
	// written off, or denied
	RemainingAmount int64 `json:"remaining_amount,required"`
	// The amount the issuer has chosen to write off
	WrittenOffAmount int64                            `json:"written_off_amount,required"`
	JSON             disputeV2LiabilityAllocationJSON `json:"-"`
}

Current breakdown of how liability is allocated for the disputed amount

func (*DisputeV2LiabilityAllocation) UnmarshalJSON added in v0.96.0 

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

type DisputeV2Network added in v0.96.0 

type DisputeV2Network string

Card network handling the dispute. 

const (
	DisputeV2NetworkVisa       DisputeV2Network = "VISA"
	DisputeV2NetworkMastercard DisputeV2Network = "MASTERCARD"
)

func (DisputeV2Network) IsKnown added in v0.96.0 

func (r DisputeV2Network) IsKnown() bool

type DisputeV2Status added in v0.96.0 

type DisputeV2Status string

Current status of the dispute. 

const (
	DisputeV2StatusOpen   DisputeV2Status = "OPEN"
	DisputeV2StatusClosed DisputeV2Status = "CLOSED"
)

func (DisputeV2Status) IsKnown added in v0.96.0 

func (r DisputeV2Status) IsKnown() bool

type DisputeV2TransactionSeries added in v0.96.0 

type DisputeV2TransactionSeries struct {
	// Token of the specific event in the original transaction being disputed, in UUID
	// format; null if no event can be identified
	RelatedTransactionEventToken string `json:"related_transaction_event_token,required,nullable" format:"uuid"`
	// Token of the original transaction being disputed, in UUID format
	RelatedTransactionToken string `json:"related_transaction_token,required" format:"uuid"`
	// The type of transaction series associating the dispute and the original
	// transaction. Always set to DISPUTE
	Type DisputeV2TransactionSeriesType `json:"type,required"`
	JSON disputeV2TransactionSeriesJSON `json:"-"`
}

Contains identifiers for the transaction and specific event within being disputed; null if no transaction can be identified

func (*DisputeV2TransactionSeries) UnmarshalJSON added in v0.96.0 

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

type DisputeV2TransactionSeriesType added in v0.96.0 

type DisputeV2TransactionSeriesType string

The type of transaction series associating the dispute and the original transaction. Always set to DISPUTE 

const (
	DisputeV2TransactionSeriesTypeDispute DisputeV2TransactionSeriesType = "DISPUTE"
)

func (DisputeV2TransactionSeriesType) IsKnown added in v0.96.0 

func (r DisputeV2TransactionSeriesType) IsKnown() bool

type DisputesV2ListParams added in v0.96.0 

type DisputesV2ListParams struct {
	// Filter by account token.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// RFC 3339 timestamp for filtering by created date, inclusive.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Filter by card token.
	CardToken param.Field[string] `query:"card_token" format:"uuid"`
	// Filter by the token of the transaction being disputed. Corresponds with
	// transaction_series.related_transaction_token in the Dispute.
	DisputedTransactionToken param.Field[string] `query:"disputed_transaction_token" format:"uuid"`
	// RFC 3339 timestamp for filtering by created date, inclusive.
	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"`
	// Number of items to return.
	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 (DisputesV2ListParams) URLQuery added in v0.96.0 

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

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

type DisputesV2Service added in v0.96.0 

type DisputesV2Service struct {
	Options []option.RequestOption
}

DisputesV2Service 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 NewDisputesV2Service method instead.

func NewDisputesV2Service added in v0.96.0 

func NewDisputesV2Service(opts ...option.RequestOption) (r *DisputesV2Service)

NewDisputesV2Service 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 (*DisputesV2Service) Get added in v0.96.0 

func (r *DisputesV2Service) Get(ctx context.Context, disputeToken string, opts ...option.RequestOption) (res *DisputeV2, err error)

Retrieves a specific dispute by its token.

func (*DisputesV2Service) List added in v0.96.0 

func (r *DisputesV2Service) List(ctx context.Context, query DisputesV2ListParams, opts ...option.RequestOption) (res *pagination.CursorPage[DisputeV2], err error)

Returns a paginated list of disputes.

func (*DisputesV2Service) ListAutoPaging added in v0.96.0 

func (r *DisputesV2Service) ListAutoPaging(ctx context.Context, query DisputesV2ListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[DisputeV2]

Returns a paginated list of disputes.

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"`
	// A customer identifier.
	CustomerReferenceNumber string `json:"customer_reference_number,nullable"`
	// A merchant identifier.
	MerchantReferenceNumber string `json:"merchant_reference_number,nullable"`
	// The date of the order.
	OrderDate time.Time              `json:"order_date,nullable" 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 string `json:"amount,nullable"`
	// A human-readable description of the item.
	Description string `json:"description,nullable"`
	// An identifier for the item purchased.
	ProductCode string `json:"product_code,nullable"`
	// The quantity of the item purchased.
	Quantity string                         `json:"quantity,nullable"`
	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,nullable"`
	// A flag indicating whether the transaction is tax exempt or not.
	Exempt EnhancedDataCommonTaxExempt `json:"exempt,nullable"`
	// The tax ID of the merchant.
	MerchantTaxID string                    `json:"merchant_tax_id,nullable"`
	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 the terminal at the time of sale, with leading
	// zeros stripped.
	DriverNumber string `json:"driver_number,nullable"`
	// The odometer reading entered into the terminal at the time of sale.
	Odometer int64 `json:"odometer,nullable"`
	// The type of fuel service.
	ServiceType EnhancedDataFleetServiceType `json:"service_type"`
	// The vehicle number entered into the terminal at the time of sale, with leading
	// zeros stripped.
	VehicleNumber string                `json:"vehicle_number,nullable"`
	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,nullable"`
	// The gross sale amount.
	GrossSale int64 `json:"gross_sale,nullable"`
	// The amount after discount.
	NetSale int64                             `json:"net_sale,nullable"`
	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 string `json:"quantity,nullable"`
	// The type of fuel purchased.
	Type EnhancedDataFleetFuelType `json:"type,nullable"`
	// Unit of measure for fuel disbursement.
	UnitOfMeasure EnhancedDataFleetFuelUnitOfMeasure `json:"unit_of_measure,nullable"`
	// The price per unit of fuel.
	UnitPrice int64                     `json:"unit_price,nullable"`
	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"`
	// The type of event that occurred. Possible values:
	//
	//   - account_holder_document.updated: Occurs when an account holder's document
	//     upload status has been updated
	//   - account_holder.created: Occurs when a new account_holder is created.
	//   - account_holder.updated: Occurs when an account_holder is updated.
	//   - account_holder.verification: Occurs when an asynchronous account_holder's
	//     verification is completed.
	//   - auth_rules.backtest_report.created: Auth Rules backtest report created.
	//   - balance.updated: Financial Account Balance Update
	//   - book_transfer_transaction.created: Occurs when a book transfer transaction is
	//     created.
	//   - book_transfer_transaction.updated: Occurs when a book transfer transaction is
	//     updated.
	//   - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
	//     data is processed for a transaction event.
	//   - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
	//     data is reprocessed for a transaction event.
	//   - card_transaction.updated: Occurs when a card transaction happens.
	//   - card.converted: Occurs when a card is converted from virtual to physical
	//     cards.
	//   - card.created: Occurs when a new card is created.
	//   - card.reissued: Occurs when a card is reissued.
	//   - card.renewed: Occurs when a card is renewed.
	//   - card.shipped: Occurs when a card is shipped.
	//   - digital_wallet.tokenization_approval_request: Occurs when a tokenization
	//     approval request is made. This event will be deprecated in the future. We
	//     recommend using `tokenization.approval_request` instead.
	//   - digital_wallet.tokenization_result: Occurs when a tokenization request
	//     succeeded or failed.
	//
	// This event will be deprecated in the future. We recommend using
	// `tokenization.result` instead.
	//
	//   - digital_wallet.tokenization_two_factor_authentication_code: Occurs when a
	//     tokenization request 2FA code is sent to the Lithic customer for self serve
	//     delivery.
	//
	// This event will be deprecated in the future. We recommend using
	// `tokenization.two_factor_authentication_code` instead.
	//
	//   - digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a
	//     tokenization request 2FA code is sent to our downstream messaging providers
	//     for delivery.
	//
	// This event will be deprecated in the future. We recommend using
	// `tokenization.two_factor_authentication_code_sent` instead.
	//
	//   - digital_wallet.tokenization_updated: Occurs when a tokenization's status has
	//     changed.
	//
	// This event will be deprecated in the future. We recommend using
	// `tokenization.updated` instead.
	//
	//   - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
	//   - dispute_transaction.created: Occurs when a new dispute transaction is created
	//   - dispute_transaction.updated: Occurs when a dispute transaction is updated
	//   - dispute.updated: Occurs when a dispute is updated.
	//   - external_bank_account.created: Occurs when an external bank account is
	//     created.
	//   - external_bank_account.updated: Occurs when an external bank account is
	//     updated.
	//   - external_payment.created: Occurs when an external payment is created.
	//   - external_payment.updated: Occurs when an external payment is updated.
	//   - financial_account.created: Occurs when a financial account is created.
	//   - financial_account.updated: Occurs when a financial account is updated.
	//   - funding_event.created: Occurs when a funding event is created.
	//   - internal_transaction.created: Occurs when an internal adjustment is created.
	//   - internal_transaction.updated: Occurs when an internal adjustment is updated.
	//   - loan_tape.created: Occurs when a loan tape is created.
	//   - loan_tape.updated: Occurs when a loan tape is updated.
	//   - management_operation.created: Occurs when an management operation is created.
	//   - management_operation.updated: Occurs when an management operation is updated.
	//   - network_total.created: Occurs when a network total is created.
	//   - network_total.updated: Occurs when a network total is updated.
	//   - payment_transaction.created: Occurs when a payment transaction is created.
	//   - payment_transaction.updated: Occurs when a payment transaction is updated.
	//   - settlement_report.updated: Occurs when a settlement report is created or
	//     updated.
	//   - statements.created: Occurs when a statement has been created
	//   - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
	//     event. Upon receiving this request, the Card Program should issue its own
	//     challenge to the cardholder. After a cardholder challenge is successfully
	//     completed, the Card Program needs to respond back to Lithic by call to
	//     [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
	//     Then the cardholder must navigate back to the merchant checkout flow to
	//     complete the transaction. Some merchants will include an `app_requestor_url`
	//     for app-based purchases; Lithic recommends triggering a redirect to that URL
	//     after the cardholder completes an app-based challenge.
	//   - three_ds_authentication.created: Occurs when a 3DS authentication is created.
	//   - three_ds_authentication.updated: Occurs when a 3DS authentication is updated
	//     (eg. challenge is completed).
	//   - tokenization.approval_request: Occurs when a tokenization approval request is
	//     made.
	//   - tokenization.result: Occurs when a tokenization request succeeded or failed.
	//   - tokenization.two_factor_authentication_code: Occurs when a tokenization
	//     request 2FA code is sent to the Lithic customer for self serve delivery.
	//   - tokenization.two_factor_authentication_code_sent: Occurs when a tokenization
	//     request 2FA code is sent to our downstream messaging providers for delivery.
	//   - tokenization.updated: Occurs when a 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 EventEventSubscriptionService added in v0.72.0 

type EventEventSubscriptionService struct {
	Options []option.RequestOption
}

EventEventSubscriptionService 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 NewEventEventSubscriptionService method instead.

func NewEventEventSubscriptionService added in v0.72.0 

func NewEventEventSubscriptionService(opts ...option.RequestOption) (r *EventEventSubscriptionService)

NewEventEventSubscriptionService 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 (*EventEventSubscriptionService) Resend added in v0.72.0 

func (r *EventEventSubscriptionService) Resend(ctx context.Context, eventToken string, eventSubscriptionToken string, opts ...option.RequestOption) (err error)

Resend an event to an event subscription.

type EventEventType 

type EventEventType string

The type of event that occurred. Possible values:

  • account_holder_document.updated: Occurs when an account holder's document upload status has been updated
  • account_holder.created: Occurs when a new account_holder is created.
  • account_holder.updated: Occurs when an account_holder is updated.
  • account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
  • auth_rules.backtest_report.created: Auth Rules backtest report created.
  • balance.updated: Financial Account Balance Update
  • book_transfer_transaction.created: Occurs when a book transfer transaction is created.
  • book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
  • card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
  • card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
  • card_transaction.updated: Occurs when a card transaction happens.
  • card.converted: Occurs when a card is converted from virtual to physical cards.
  • card.created: Occurs when a new card is created.
  • card.reissued: Occurs when a card is reissued.
  • card.renewed: Occurs when a card is renewed.
  • card.shipped: Occurs when a card is shipped.
  • digital_wallet.tokenization_approval_request: Occurs when a tokenization approval request is made. This event will be deprecated in the future. We recommend using `tokenization.approval_request` instead.
  • digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.

This event will be deprecated in the future. We recommend using `tokenization.result` instead.

  • digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.

  • digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.

  • digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.

This event will be deprecated in the future. We recommend using `tokenization.updated` instead.

  • dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
  • dispute_transaction.created: Occurs when a new dispute transaction is created
  • dispute_transaction.updated: Occurs when a dispute transaction is updated
  • dispute.updated: Occurs when a dispute is updated.
  • external_bank_account.created: Occurs when an external bank account is created.
  • external_bank_account.updated: Occurs when an external bank account is updated.
  • external_payment.created: Occurs when an external payment is created.
  • external_payment.updated: Occurs when an external payment is updated.
  • financial_account.created: Occurs when a financial account is created.
  • financial_account.updated: Occurs when a financial account is updated.
  • funding_event.created: Occurs when a funding event is created.
  • internal_transaction.created: Occurs when an internal adjustment is created.
  • internal_transaction.updated: Occurs when an internal adjustment is updated.
  • loan_tape.created: Occurs when a loan tape is created.
  • loan_tape.updated: Occurs when a loan tape is updated.
  • management_operation.created: Occurs when an management operation is created.
  • management_operation.updated: Occurs when an management operation is updated.
  • network_total.created: Occurs when a network total is created.
  • network_total.updated: Occurs when a network total is updated.
  • payment_transaction.created: Occurs when a payment transaction is created.
  • payment_transaction.updated: Occurs when a payment transaction is updated.
  • settlement_report.updated: Occurs when a settlement report is created or updated.
  • statements.created: Occurs when a statement has been created
  • three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.
  • three_ds_authentication.created: Occurs when a 3DS authentication is created.
  • three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).
  • tokenization.approval_request: Occurs when a tokenization approval request is made.
  • tokenization.result: Occurs when a tokenization request succeeded or failed.
  • tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.
  • tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.
  • tokenization.updated: Occurs when a tokenization's status has changed.
const (
	EventEventTypeAccountHolderDocumentUpdated                             EventEventType = "account_holder_document.updated"
	EventEventTypeAccountHolderCreated                                     EventEventType = "account_holder.created"
	EventEventTypeAccountHolderUpdated                                     EventEventType = "account_holder.updated"
	EventEventTypeAccountHolderVerification                                EventEventType = "account_holder.verification"
	EventEventTypeAuthRulesBacktestReportCreated                           EventEventType = "auth_rules.backtest_report.created"
	EventEventTypeBalanceUpdated                                           EventEventType = "balance.updated"
	EventEventTypeBookTransferTransactionCreated                           EventEventType = "book_transfer_transaction.created"
	EventEventTypeBookTransferTransactionUpdated                           EventEventType = "book_transfer_transaction.updated"
	EventEventTypeCardTransactionEnhancedDataCreated                       EventEventType = "card_transaction.enhanced_data.created"
	EventEventTypeCardTransactionEnhancedDataUpdated                       EventEventType = "card_transaction.enhanced_data.updated"
	EventEventTypeCardTransactionUpdated                                   EventEventType = "card_transaction.updated"
	EventEventTypeCardConverted                                            EventEventType = "card.converted"
	EventEventTypeCardCreated                                              EventEventType = "card.created"
	EventEventTypeCardReissued                                             EventEventType = "card.reissued"
	EventEventTypeCardRenewed                                              EventEventType = "card.renewed"
	EventEventTypeCardShipped                                              EventEventType = "card.shipped"
	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"
	EventEventTypeDisputeEvidenceUploadFailed                              EventEventType = "dispute_evidence.upload_failed"
	EventEventTypeDisputeTransactionCreated                                EventEventType = "dispute_transaction.created"
	EventEventTypeDisputeTransactionUpdated                                EventEventType = "dispute_transaction.updated"
	EventEventTypeDisputeUpdated                                           EventEventType = "dispute.updated"
	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"
	EventEventTypeFundingEventCreated                                      EventEventType = "funding_event.created"
	EventEventTypeInternalTransactionCreated                               EventEventType = "internal_transaction.created"
	EventEventTypeInternalTransactionUpdated                               EventEventType = "internal_transaction.updated"
	EventEventTypeLoanTapeCreated                                          EventEventType = "loan_tape.created"
	EventEventTypeLoanTapeUpdated                                          EventEventType = "loan_tape.updated"
	EventEventTypeManagementOperationCreated                               EventEventType = "management_operation.created"
	EventEventTypeManagementOperationUpdated                               EventEventType = "management_operation.updated"
	EventEventTypeNetworkTotalCreated                                      EventEventType = "network_total.created"
	EventEventTypeNetworkTotalUpdated                                      EventEventType = "network_total.updated"
	EventEventTypePaymentTransactionCreated                                EventEventType = "payment_transaction.created"
	EventEventTypePaymentTransactionUpdated                                EventEventType = "payment_transaction.updated"
	EventEventTypeSettlementReportUpdated                                  EventEventType = "settlement_report.updated"
	EventEventTypeStatementsCreated                                        EventEventType = "statements.created"
	EventEventTypeThreeDSAuthenticationChallenge                           EventEventType = "three_ds_authentication.challenge"
	EventEventTypeThreeDSAuthenticationCreated                             EventEventType = "three_ds_authentication.created"
	EventEventTypeThreeDSAuthenticationUpdated                             EventEventType = "three_ds_authentication.updated"
	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

The type of event that occurred. Possible values:

  • account_holder_document.updated: Occurs when an account holder's document upload status has been updated
  • account_holder.created: Occurs when a new account_holder is created.
  • account_holder.updated: Occurs when an account_holder is updated.
  • account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
  • auth_rules.backtest_report.created: Auth Rules backtest report created.
  • balance.updated: Financial Account Balance Update
  • book_transfer_transaction.created: Occurs when a book transfer transaction is created.
  • book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
  • card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
  • card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
  • card_transaction.updated: Occurs when a card transaction happens.
  • card.converted: Occurs when a card is converted from virtual to physical cards.
  • card.created: Occurs when a new card is created.
  • card.reissued: Occurs when a card is reissued.
  • card.renewed: Occurs when a card is renewed.
  • card.shipped: Occurs when a card is shipped.
  • digital_wallet.tokenization_approval_request: Occurs when a tokenization approval request is made. This event will be deprecated in the future. We recommend using `tokenization.approval_request` instead.
  • digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.

This event will be deprecated in the future. We recommend using `tokenization.result` instead.

  • digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.

  • digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.

  • digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.

This event will be deprecated in the future. We recommend using `tokenization.updated` instead.

  • dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
  • dispute_transaction.created: Occurs when a new dispute transaction is created
  • dispute_transaction.updated: Occurs when a dispute transaction is updated
  • dispute.updated: Occurs when a dispute is updated.
  • external_bank_account.created: Occurs when an external bank account is created.
  • external_bank_account.updated: Occurs when an external bank account is updated.
  • external_payment.created: Occurs when an external payment is created.
  • external_payment.updated: Occurs when an external payment is updated.
  • financial_account.created: Occurs when a financial account is created.
  • financial_account.updated: Occurs when a financial account is updated.
  • funding_event.created: Occurs when a funding event is created.
  • internal_transaction.created: Occurs when an internal adjustment is created.
  • internal_transaction.updated: Occurs when an internal adjustment is updated.
  • loan_tape.created: Occurs when a loan tape is created.
  • loan_tape.updated: Occurs when a loan tape is updated.
  • management_operation.created: Occurs when an management operation is created.
  • management_operation.updated: Occurs when an management operation is updated.
  • network_total.created: Occurs when a network total is created.
  • network_total.updated: Occurs when a network total is updated.
  • payment_transaction.created: Occurs when a payment transaction is created.
  • payment_transaction.updated: Occurs when a payment transaction is updated.
  • settlement_report.updated: Occurs when a settlement report is created or updated.
  • statements.created: Occurs when a statement has been created
  • three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.
  • three_ds_authentication.created: Occurs when a 3DS authentication is created.
  • three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).
  • tokenization.approval_request: Occurs when a tokenization approval request is made.
  • tokenization.result: Occurs when a tokenization request succeeded or failed.
  • tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.
  • tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.
  • tokenization.updated: Occurs when a tokenization's status has changed.
const (
	EventListParamsEventTypeAccountHolderDocumentUpdated                             EventListParamsEventType = "account_holder_document.updated"
	EventListParamsEventTypeAccountHolderCreated                                     EventListParamsEventType = "account_holder.created"
	EventListParamsEventTypeAccountHolderUpdated                                     EventListParamsEventType = "account_holder.updated"
	EventListParamsEventTypeAccountHolderVerification                                EventListParamsEventType = "account_holder.verification"
	EventListParamsEventTypeAuthRulesBacktestReportCreated                           EventListParamsEventType = "auth_rules.backtest_report.created"
	EventListParamsEventTypeBalanceUpdated                                           EventListParamsEventType = "balance.updated"
	EventListParamsEventTypeBookTransferTransactionCreated                           EventListParamsEventType = "book_transfer_transaction.created"
	EventListParamsEventTypeBookTransferTransactionUpdated                           EventListParamsEventType = "book_transfer_transaction.updated"
	EventListParamsEventTypeCardTransactionEnhancedDataCreated                       EventListParamsEventType = "card_transaction.enhanced_data.created"
	EventListParamsEventTypeCardTransactionEnhancedDataUpdated                       EventListParamsEventType = "card_transaction.enhanced_data.updated"
	EventListParamsEventTypeCardTransactionUpdated                                   EventListParamsEventType = "card_transaction.updated"
	EventListParamsEventTypeCardConverted                                            EventListParamsEventType = "card.converted"
	EventListParamsEventTypeCardCreated                                              EventListParamsEventType = "card.created"
	EventListParamsEventTypeCardReissued                                             EventListParamsEventType = "card.reissued"
	EventListParamsEventTypeCardRenewed                                              EventListParamsEventType = "card.renewed"
	EventListParamsEventTypeCardShipped                                              EventListParamsEventType = "card.shipped"
	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"
	EventListParamsEventTypeDisputeEvidenceUploadFailed                              EventListParamsEventType = "dispute_evidence.upload_failed"
	EventListParamsEventTypeDisputeTransactionCreated                                EventListParamsEventType = "dispute_transaction.created"
	EventListParamsEventTypeDisputeTransactionUpdated                                EventListParamsEventType = "dispute_transaction.updated"
	EventListParamsEventTypeDisputeUpdated                                           EventListParamsEventType = "dispute.updated"
	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"
	EventListParamsEventTypeFundingEventCreated                                      EventListParamsEventType = "funding_event.created"
	EventListParamsEventTypeInternalTransactionCreated                               EventListParamsEventType = "internal_transaction.created"
	EventListParamsEventTypeInternalTransactionUpdated                               EventListParamsEventType = "internal_transaction.updated"
	EventListParamsEventTypeLoanTapeCreated                                          EventListParamsEventType = "loan_tape.created"
	EventListParamsEventTypeLoanTapeUpdated                                          EventListParamsEventType = "loan_tape.updated"
	EventListParamsEventTypeManagementOperationCreated                               EventListParamsEventType = "management_operation.created"
	EventListParamsEventTypeManagementOperationUpdated                               EventListParamsEventType = "management_operation.updated"
	EventListParamsEventTypeNetworkTotalCreated                                      EventListParamsEventType = "network_total.created"
	EventListParamsEventTypeNetworkTotalUpdated                                      EventListParamsEventType = "network_total.updated"
	EventListParamsEventTypePaymentTransactionCreated                                EventListParamsEventType = "payment_transaction.created"
	EventListParamsEventTypePaymentTransactionUpdated                                EventListParamsEventType = "payment_transaction.updated"
	EventListParamsEventTypeSettlementReportUpdated                                  EventListParamsEventType = "settlement_report.updated"
	EventListParamsEventTypeStatementsCreated                                        EventListParamsEventType = "statements.created"
	EventListParamsEventTypeThreeDSAuthenticationChallenge                           EventListParamsEventType = "three_ds_authentication.challenge"
	EventListParamsEventTypeThreeDSAuthenticationCreated                             EventListParamsEventType = "three_ds_authentication.created"
	EventListParamsEventTypeThreeDSAuthenticationUpdated                             EventListParamsEventType = "three_ds_authentication.updated"
	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
	EventSubscriptions *EventEventSubscriptionService
}

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 EventStream added in v0.98.0 

type EventStream string

The event stream during which the rule will be evaluated. 

const (
	EventStreamAuthorization         EventStream = "AUTHORIZATION"
	EventStreamThreeDSAuthentication EventStream = "THREE_DS_AUTHENTICATION"
	EventStreamTokenization          EventStream = "TOKENIZATION"
	EventStreamACHCreditReceipt      EventStream = "ACH_CREDIT_RECEIPT"
	EventStreamACHDebitReceipt       EventStream = "ACH_DEBIT_RECEIPT"
)

func (EventStream) IsKnown added in v0.98.0 

func (r EventStream) IsKnown() bool

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

The type of event that occurred. Possible values:

  • account_holder_document.updated: Occurs when an account holder's document upload status has been updated
  • account_holder.created: Occurs when a new account_holder is created.
  • account_holder.updated: Occurs when an account_holder is updated.
  • account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
  • auth_rules.backtest_report.created: Auth Rules backtest report created.
  • balance.updated: Financial Account Balance Update
  • book_transfer_transaction.created: Occurs when a book transfer transaction is created.
  • book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
  • card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
  • card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
  • card_transaction.updated: Occurs when a card transaction happens.
  • card.converted: Occurs when a card is converted from virtual to physical cards.
  • card.created: Occurs when a new card is created.
  • card.reissued: Occurs when a card is reissued.
  • card.renewed: Occurs when a card is renewed.
  • card.shipped: Occurs when a card is shipped.
  • digital_wallet.tokenization_approval_request: Occurs when a tokenization approval request is made. This event will be deprecated in the future. We recommend using `tokenization.approval_request` instead.
  • digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.

This event will be deprecated in the future. We recommend using `tokenization.result` instead.

  • digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.

  • digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.

  • digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.

This event will be deprecated in the future. We recommend using `tokenization.updated` instead.

  • dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
  • dispute_transaction.created: Occurs when a new dispute transaction is created
  • dispute_transaction.updated: Occurs when a dispute transaction is updated
  • dispute.updated: Occurs when a dispute is updated.
  • external_bank_account.created: Occurs when an external bank account is created.
  • external_bank_account.updated: Occurs when an external bank account is updated.
  • external_payment.created: Occurs when an external payment is created.
  • external_payment.updated: Occurs when an external payment is updated.
  • financial_account.created: Occurs when a financial account is created.
  • financial_account.updated: Occurs when a financial account is updated.
  • funding_event.created: Occurs when a funding event is created.
  • internal_transaction.created: Occurs when an internal adjustment is created.
  • internal_transaction.updated: Occurs when an internal adjustment is updated.
  • loan_tape.created: Occurs when a loan tape is created.
  • loan_tape.updated: Occurs when a loan tape is updated.
  • management_operation.created: Occurs when an management operation is created.
  • management_operation.updated: Occurs when an management operation is updated.
  • network_total.created: Occurs when a network total is created.
  • network_total.updated: Occurs when a network total is updated.
  • payment_transaction.created: Occurs when a payment transaction is created.
  • payment_transaction.updated: Occurs when a payment transaction is updated.
  • settlement_report.updated: Occurs when a settlement report is created or updated.
  • statements.created: Occurs when a statement has been created
  • three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.
  • three_ds_authentication.created: Occurs when a 3DS authentication is created.
  • three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).
  • tokenization.approval_request: Occurs when a tokenization approval request is made.
  • tokenization.result: Occurs when a tokenization request succeeded or failed.
  • tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.
  • tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.
  • tokenization.updated: Occurs when a tokenization's status has changed.
const (
	EventSubscriptionEventTypeAccountHolderDocumentUpdated                             EventSubscriptionEventType = "account_holder_document.updated"
	EventSubscriptionEventTypeAccountHolderCreated                                     EventSubscriptionEventType = "account_holder.created"
	EventSubscriptionEventTypeAccountHolderUpdated                                     EventSubscriptionEventType = "account_holder.updated"
	EventSubscriptionEventTypeAccountHolderVerification                                EventSubscriptionEventType = "account_holder.verification"
	EventSubscriptionEventTypeAuthRulesBacktestReportCreated                           EventSubscriptionEventType = "auth_rules.backtest_report.created"
	EventSubscriptionEventTypeBalanceUpdated                                           EventSubscriptionEventType = "balance.updated"
	EventSubscriptionEventTypeBookTransferTransactionCreated                           EventSubscriptionEventType = "book_transfer_transaction.created"
	EventSubscriptionEventTypeBookTransferTransactionUpdated                           EventSubscriptionEventType = "book_transfer_transaction.updated"
	EventSubscriptionEventTypeCardTransactionEnhancedDataCreated                       EventSubscriptionEventType = "card_transaction.enhanced_data.created"
	EventSubscriptionEventTypeCardTransactionEnhancedDataUpdated                       EventSubscriptionEventType = "card_transaction.enhanced_data.updated"
	EventSubscriptionEventTypeCardTransactionUpdated                                   EventSubscriptionEventType = "card_transaction.updated"
	EventSubscriptionEventTypeCardConverted                                            EventSubscriptionEventType = "card.converted"
	EventSubscriptionEventTypeCardCreated                                              EventSubscriptionEventType = "card.created"
	EventSubscriptionEventTypeCardReissued                                             EventSubscriptionEventType = "card.reissued"
	EventSubscriptionEventTypeCardRenewed                                              EventSubscriptionEventType = "card.renewed"
	EventSubscriptionEventTypeCardShipped                                              EventSubscriptionEventType = "card.shipped"
	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"
	EventSubscriptionEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionEventType = "dispute_evidence.upload_failed"
	EventSubscriptionEventTypeDisputeTransactionCreated                                EventSubscriptionEventType = "dispute_transaction.created"
	EventSubscriptionEventTypeDisputeTransactionUpdated                                EventSubscriptionEventType = "dispute_transaction.updated"
	EventSubscriptionEventTypeDisputeUpdated                                           EventSubscriptionEventType = "dispute.updated"
	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"
	EventSubscriptionEventTypeFundingEventCreated                                      EventSubscriptionEventType = "funding_event.created"
	EventSubscriptionEventTypeInternalTransactionCreated                               EventSubscriptionEventType = "internal_transaction.created"
	EventSubscriptionEventTypeInternalTransactionUpdated                               EventSubscriptionEventType = "internal_transaction.updated"
	EventSubscriptionEventTypeLoanTapeCreated                                          EventSubscriptionEventType = "loan_tape.created"
	EventSubscriptionEventTypeLoanTapeUpdated                                          EventSubscriptionEventType = "loan_tape.updated"
	EventSubscriptionEventTypeManagementOperationCreated                               EventSubscriptionEventType = "management_operation.created"
	EventSubscriptionEventTypeManagementOperationUpdated                               EventSubscriptionEventType = "management_operation.updated"
	EventSubscriptionEventTypeNetworkTotalCreated                                      EventSubscriptionEventType = "network_total.created"
	EventSubscriptionEventTypeNetworkTotalUpdated                                      EventSubscriptionEventType = "network_total.updated"
	EventSubscriptionEventTypePaymentTransactionCreated                                EventSubscriptionEventType = "payment_transaction.created"
	EventSubscriptionEventTypePaymentTransactionUpdated                                EventSubscriptionEventType = "payment_transaction.updated"
	EventSubscriptionEventTypeSettlementReportUpdated                                  EventSubscriptionEventType = "settlement_report.updated"
	EventSubscriptionEventTypeStatementsCreated                                        EventSubscriptionEventType = "statements.created"
	EventSubscriptionEventTypeThreeDSAuthenticationChallenge                           EventSubscriptionEventType = "three_ds_authentication.challenge"
	EventSubscriptionEventTypeThreeDSAuthenticationCreated                             EventSubscriptionEventType = "three_ds_authentication.created"
	EventSubscriptionEventTypeThreeDSAuthenticationUpdated                             EventSubscriptionEventType = "three_ds_authentication.updated"
	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

The type of event that occurred. Possible values:

  • account_holder_document.updated: Occurs when an account holder's document upload status has been updated
  • account_holder.created: Occurs when a new account_holder is created.
  • account_holder.updated: Occurs when an account_holder is updated.
  • account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
  • auth_rules.backtest_report.created: Auth Rules backtest report created.
  • balance.updated: Financial Account Balance Update
  • book_transfer_transaction.created: Occurs when a book transfer transaction is created.
  • book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
  • card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
  • card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
  • card_transaction.updated: Occurs when a card transaction happens.
  • card.converted: Occurs when a card is converted from virtual to physical cards.
  • card.created: Occurs when a new card is created.
  • card.reissued: Occurs when a card is reissued.
  • card.renewed: Occurs when a card is renewed.
  • card.shipped: Occurs when a card is shipped.
  • digital_wallet.tokenization_approval_request: Occurs when a tokenization approval request is made. This event will be deprecated in the future. We recommend using `tokenization.approval_request` instead.
  • digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.

This event will be deprecated in the future. We recommend using `tokenization.result` instead.

  • digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.

  • digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.

  • digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.

This event will be deprecated in the future. We recommend using `tokenization.updated` instead.

  • dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
  • dispute_transaction.created: Occurs when a new dispute transaction is created
  • dispute_transaction.updated: Occurs when a dispute transaction is updated
  • dispute.updated: Occurs when a dispute is updated.
  • external_bank_account.created: Occurs when an external bank account is created.
  • external_bank_account.updated: Occurs when an external bank account is updated.
  • external_payment.created: Occurs when an external payment is created.
  • external_payment.updated: Occurs when an external payment is updated.
  • financial_account.created: Occurs when a financial account is created.
  • financial_account.updated: Occurs when a financial account is updated.
  • funding_event.created: Occurs when a funding event is created.
  • internal_transaction.created: Occurs when an internal adjustment is created.
  • internal_transaction.updated: Occurs when an internal adjustment is updated.
  • loan_tape.created: Occurs when a loan tape is created.
  • loan_tape.updated: Occurs when a loan tape is updated.
  • management_operation.created: Occurs when an management operation is created.
  • management_operation.updated: Occurs when an management operation is updated.
  • network_total.created: Occurs when a network total is created.
  • network_total.updated: Occurs when a network total is updated.
  • payment_transaction.created: Occurs when a payment transaction is created.
  • payment_transaction.updated: Occurs when a payment transaction is updated.
  • settlement_report.updated: Occurs when a settlement report is created or updated.
  • statements.created: Occurs when a statement has been created
  • three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.
  • three_ds_authentication.created: Occurs when a 3DS authentication is created.
  • three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).
  • tokenization.approval_request: Occurs when a tokenization approval request is made.
  • tokenization.result: Occurs when a tokenization request succeeded or failed.
  • tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.
  • tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.
  • tokenization.updated: Occurs when a tokenization's status has changed.
const (
	EventSubscriptionNewParamsEventTypeAccountHolderDocumentUpdated                             EventSubscriptionNewParamsEventType = "account_holder_document.updated"
	EventSubscriptionNewParamsEventTypeAccountHolderCreated                                     EventSubscriptionNewParamsEventType = "account_holder.created"
	EventSubscriptionNewParamsEventTypeAccountHolderUpdated                                     EventSubscriptionNewParamsEventType = "account_holder.updated"
	EventSubscriptionNewParamsEventTypeAccountHolderVerification                                EventSubscriptionNewParamsEventType = "account_holder.verification"
	EventSubscriptionNewParamsEventTypeAuthRulesBacktestReportCreated                           EventSubscriptionNewParamsEventType = "auth_rules.backtest_report.created"
	EventSubscriptionNewParamsEventTypeBalanceUpdated                                           EventSubscriptionNewParamsEventType = "balance.updated"
	EventSubscriptionNewParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionNewParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionNewParamsEventTypeBookTransferTransactionUpdated                           EventSubscriptionNewParamsEventType = "book_transfer_transaction.updated"
	EventSubscriptionNewParamsEventTypeCardTransactionEnhancedDataCreated                       EventSubscriptionNewParamsEventType = "card_transaction.enhanced_data.created"
	EventSubscriptionNewParamsEventTypeCardTransactionEnhancedDataUpdated                       EventSubscriptionNewParamsEventType = "card_transaction.enhanced_data.updated"
	EventSubscriptionNewParamsEventTypeCardTransactionUpdated                                   EventSubscriptionNewParamsEventType = "card_transaction.updated"
	EventSubscriptionNewParamsEventTypeCardConverted                                            EventSubscriptionNewParamsEventType = "card.converted"
	EventSubscriptionNewParamsEventTypeCardCreated                                              EventSubscriptionNewParamsEventType = "card.created"
	EventSubscriptionNewParamsEventTypeCardReissued                                             EventSubscriptionNewParamsEventType = "card.reissued"
	EventSubscriptionNewParamsEventTypeCardRenewed                                              EventSubscriptionNewParamsEventType = "card.renewed"
	EventSubscriptionNewParamsEventTypeCardShipped                                              EventSubscriptionNewParamsEventType = "card.shipped"
	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"
	EventSubscriptionNewParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionNewParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionNewParamsEventTypeDisputeTransactionCreated                                EventSubscriptionNewParamsEventType = "dispute_transaction.created"
	EventSubscriptionNewParamsEventTypeDisputeTransactionUpdated                                EventSubscriptionNewParamsEventType = "dispute_transaction.updated"
	EventSubscriptionNewParamsEventTypeDisputeUpdated                                           EventSubscriptionNewParamsEventType = "dispute.updated"
	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"
	EventSubscriptionNewParamsEventTypeFundingEventCreated                                      EventSubscriptionNewParamsEventType = "funding_event.created"
	EventSubscriptionNewParamsEventTypeInternalTransactionCreated                               EventSubscriptionNewParamsEventType = "internal_transaction.created"
	EventSubscriptionNewParamsEventTypeInternalTransactionUpdated                               EventSubscriptionNewParamsEventType = "internal_transaction.updated"
	EventSubscriptionNewParamsEventTypeLoanTapeCreated                                          EventSubscriptionNewParamsEventType = "loan_tape.created"
	EventSubscriptionNewParamsEventTypeLoanTapeUpdated                                          EventSubscriptionNewParamsEventType = "loan_tape.updated"
	EventSubscriptionNewParamsEventTypeManagementOperationCreated                               EventSubscriptionNewParamsEventType = "management_operation.created"
	EventSubscriptionNewParamsEventTypeManagementOperationUpdated                               EventSubscriptionNewParamsEventType = "management_operation.updated"
	EventSubscriptionNewParamsEventTypeNetworkTotalCreated                                      EventSubscriptionNewParamsEventType = "network_total.created"
	EventSubscriptionNewParamsEventTypeNetworkTotalUpdated                                      EventSubscriptionNewParamsEventType = "network_total.updated"
	EventSubscriptionNewParamsEventTypePaymentTransactionCreated                                EventSubscriptionNewParamsEventType = "payment_transaction.created"
	EventSubscriptionNewParamsEventTypePaymentTransactionUpdated                                EventSubscriptionNewParamsEventType = "payment_transaction.updated"
	EventSubscriptionNewParamsEventTypeSettlementReportUpdated                                  EventSubscriptionNewParamsEventType = "settlement_report.updated"
	EventSubscriptionNewParamsEventTypeStatementsCreated                                        EventSubscriptionNewParamsEventType = "statements.created"
	EventSubscriptionNewParamsEventTypeThreeDSAuthenticationChallenge                           EventSubscriptionNewParamsEventType = "three_ds_authentication.challenge"
	EventSubscriptionNewParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionNewParamsEventType = "three_ds_authentication.created"
	EventSubscriptionNewParamsEventTypeThreeDSAuthenticationUpdated                             EventSubscriptionNewParamsEventType = "three_ds_authentication.updated"
	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 (
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderDocumentUpdated                             EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder_document.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderCreated                                     EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderUpdated                                     EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderVerification                                EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.verification"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAuthRulesBacktestReportCreated                           EventSubscriptionSendSimulatedExampleParamsEventType = "auth_rules.backtest_report.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBalanceUpdated                                           EventSubscriptionSendSimulatedExampleParamsEventType = "balance.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionSendSimulatedExampleParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBookTransferTransactionUpdated                           EventSubscriptionSendSimulatedExampleParamsEventType = "book_transfer_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardTransactionEnhancedDataCreated                       EventSubscriptionSendSimulatedExampleParamsEventType = "card_transaction.enhanced_data.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardTransactionEnhancedDataUpdated                       EventSubscriptionSendSimulatedExampleParamsEventType = "card_transaction.enhanced_data.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardTransactionUpdated                                   EventSubscriptionSendSimulatedExampleParamsEventType = "card_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardConverted                                            EventSubscriptionSendSimulatedExampleParamsEventType = "card.converted"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardCreated                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardReissued                                             EventSubscriptionSendSimulatedExampleParamsEventType = "card.reissued"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardRenewed                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.renewed"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardShipped                                              EventSubscriptionSendSimulatedExampleParamsEventType = "card.shipped"
	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"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionSendSimulatedExampleParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeTransactionCreated                                EventSubscriptionSendSimulatedExampleParamsEventType = "dispute_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeTransactionUpdated                                EventSubscriptionSendSimulatedExampleParamsEventType = "dispute_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeUpdated                                           EventSubscriptionSendSimulatedExampleParamsEventType = "dispute.updated"
	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"
	EventSubscriptionSendSimulatedExampleParamsEventTypeFundingEventCreated                                      EventSubscriptionSendSimulatedExampleParamsEventType = "funding_event.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeInternalTransactionCreated                               EventSubscriptionSendSimulatedExampleParamsEventType = "internal_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeInternalTransactionUpdated                               EventSubscriptionSendSimulatedExampleParamsEventType = "internal_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeLoanTapeCreated                                          EventSubscriptionSendSimulatedExampleParamsEventType = "loan_tape.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeLoanTapeUpdated                                          EventSubscriptionSendSimulatedExampleParamsEventType = "loan_tape.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeManagementOperationCreated                               EventSubscriptionSendSimulatedExampleParamsEventType = "management_operation.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeManagementOperationUpdated                               EventSubscriptionSendSimulatedExampleParamsEventType = "management_operation.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeNetworkTotalCreated                                      EventSubscriptionSendSimulatedExampleParamsEventType = "network_total.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeNetworkTotalUpdated                                      EventSubscriptionSendSimulatedExampleParamsEventType = "network_total.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionCreated                                EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionUpdated                                EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeSettlementReportUpdated                                  EventSubscriptionSendSimulatedExampleParamsEventType = "settlement_report.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeStatementsCreated                                        EventSubscriptionSendSimulatedExampleParamsEventType = "statements.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeThreeDSAuthenticationChallenge                           EventSubscriptionSendSimulatedExampleParamsEventType = "three_ds_authentication.challenge"
	EventSubscriptionSendSimulatedExampleParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionSendSimulatedExampleParamsEventType = "three_ds_authentication.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeThreeDSAuthenticationUpdated                             EventSubscriptionSendSimulatedExampleParamsEventType = "three_ds_authentication.updated"
	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

The type of event that occurred. Possible values:

  • account_holder_document.updated: Occurs when an account holder's document upload status has been updated
  • account_holder.created: Occurs when a new account_holder is created.
  • account_holder.updated: Occurs when an account_holder is updated.
  • account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
  • auth_rules.backtest_report.created: Auth Rules backtest report created.
  • balance.updated: Financial Account Balance Update
  • book_transfer_transaction.created: Occurs when a book transfer transaction is created.
  • book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
  • card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
  • card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
  • card_transaction.updated: Occurs when a card transaction happens.
  • card.converted: Occurs when a card is converted from virtual to physical cards.
  • card.created: Occurs when a new card is created.
  • card.reissued: Occurs when a card is reissued.
  • card.renewed: Occurs when a card is renewed.
  • card.shipped: Occurs when a card is shipped.
  • digital_wallet.tokenization_approval_request: Occurs when a tokenization approval request is made. This event will be deprecated in the future. We recommend using `tokenization.approval_request` instead.
  • digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.

This event will be deprecated in the future. We recommend using `tokenization.result` instead.

  • digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.

  • digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.

This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.

  • digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.

This event will be deprecated in the future. We recommend using `tokenization.updated` instead.

  • dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
  • dispute_transaction.created: Occurs when a new dispute transaction is created
  • dispute_transaction.updated: Occurs when a dispute transaction is updated
  • dispute.updated: Occurs when a dispute is updated.
  • external_bank_account.created: Occurs when an external bank account is created.
  • external_bank_account.updated: Occurs when an external bank account is updated.
  • external_payment.created: Occurs when an external payment is created.
  • external_payment.updated: Occurs when an external payment is updated.
  • financial_account.created: Occurs when a financial account is created.
  • financial_account.updated: Occurs when a financial account is updated.
  • funding_event.created: Occurs when a funding event is created.
  • internal_transaction.created: Occurs when an internal adjustment is created.
  • internal_transaction.updated: Occurs when an internal adjustment is updated.
  • loan_tape.created: Occurs when a loan tape is created.
  • loan_tape.updated: Occurs when a loan tape is updated.
  • management_operation.created: Occurs when an management operation is created.
  • management_operation.updated: Occurs when an management operation is updated.
  • network_total.created: Occurs when a network total is created.
  • network_total.updated: Occurs when a network total is updated.
  • payment_transaction.created: Occurs when a payment transaction is created.
  • payment_transaction.updated: Occurs when a payment transaction is updated.
  • settlement_report.updated: Occurs when a settlement report is created or updated.
  • statements.created: Occurs when a statement has been created
  • three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.
  • three_ds_authentication.created: Occurs when a 3DS authentication is created.
  • three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).
  • tokenization.approval_request: Occurs when a tokenization approval request is made.
  • tokenization.result: Occurs when a tokenization request succeeded or failed.
  • tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.
  • tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.
  • tokenization.updated: Occurs when a tokenization's status has changed.
const (
	EventSubscriptionUpdateParamsEventTypeAccountHolderDocumentUpdated                             EventSubscriptionUpdateParamsEventType = "account_holder_document.updated"
	EventSubscriptionUpdateParamsEventTypeAccountHolderCreated                                     EventSubscriptionUpdateParamsEventType = "account_holder.created"
	EventSubscriptionUpdateParamsEventTypeAccountHolderUpdated                                     EventSubscriptionUpdateParamsEventType = "account_holder.updated"
	EventSubscriptionUpdateParamsEventTypeAccountHolderVerification                                EventSubscriptionUpdateParamsEventType = "account_holder.verification"
	EventSubscriptionUpdateParamsEventTypeAuthRulesBacktestReportCreated                           EventSubscriptionUpdateParamsEventType = "auth_rules.backtest_report.created"
	EventSubscriptionUpdateParamsEventTypeBalanceUpdated                                           EventSubscriptionUpdateParamsEventType = "balance.updated"
	EventSubscriptionUpdateParamsEventTypeBookTransferTransactionCreated                           EventSubscriptionUpdateParamsEventType = "book_transfer_transaction.created"
	EventSubscriptionUpdateParamsEventTypeBookTransferTransactionUpdated                           EventSubscriptionUpdateParamsEventType = "book_transfer_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeCardTransactionEnhancedDataCreated                       EventSubscriptionUpdateParamsEventType = "card_transaction.enhanced_data.created"
	EventSubscriptionUpdateParamsEventTypeCardTransactionEnhancedDataUpdated                       EventSubscriptionUpdateParamsEventType = "card_transaction.enhanced_data.updated"
	EventSubscriptionUpdateParamsEventTypeCardTransactionUpdated                                   EventSubscriptionUpdateParamsEventType = "card_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeCardConverted                                            EventSubscriptionUpdateParamsEventType = "card.converted"
	EventSubscriptionUpdateParamsEventTypeCardCreated                                              EventSubscriptionUpdateParamsEventType = "card.created"
	EventSubscriptionUpdateParamsEventTypeCardReissued                                             EventSubscriptionUpdateParamsEventType = "card.reissued"
	EventSubscriptionUpdateParamsEventTypeCardRenewed                                              EventSubscriptionUpdateParamsEventType = "card.renewed"
	EventSubscriptionUpdateParamsEventTypeCardShipped                                              EventSubscriptionUpdateParamsEventType = "card.shipped"
	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"
	EventSubscriptionUpdateParamsEventTypeDisputeEvidenceUploadFailed                              EventSubscriptionUpdateParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionUpdateParamsEventTypeDisputeTransactionCreated                                EventSubscriptionUpdateParamsEventType = "dispute_transaction.created"
	EventSubscriptionUpdateParamsEventTypeDisputeTransactionUpdated                                EventSubscriptionUpdateParamsEventType = "dispute_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeDisputeUpdated                                           EventSubscriptionUpdateParamsEventType = "dispute.updated"
	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"
	EventSubscriptionUpdateParamsEventTypeFundingEventCreated                                      EventSubscriptionUpdateParamsEventType = "funding_event.created"
	EventSubscriptionUpdateParamsEventTypeInternalTransactionCreated                               EventSubscriptionUpdateParamsEventType = "internal_transaction.created"
	EventSubscriptionUpdateParamsEventTypeInternalTransactionUpdated                               EventSubscriptionUpdateParamsEventType = "internal_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeLoanTapeCreated                                          EventSubscriptionUpdateParamsEventType = "loan_tape.created"
	EventSubscriptionUpdateParamsEventTypeLoanTapeUpdated                                          EventSubscriptionUpdateParamsEventType = "loan_tape.updated"
	EventSubscriptionUpdateParamsEventTypeManagementOperationCreated                               EventSubscriptionUpdateParamsEventType = "management_operation.created"
	EventSubscriptionUpdateParamsEventTypeManagementOperationUpdated                               EventSubscriptionUpdateParamsEventType = "management_operation.updated"
	EventSubscriptionUpdateParamsEventTypeNetworkTotalCreated                                      EventSubscriptionUpdateParamsEventType = "network_total.created"
	EventSubscriptionUpdateParamsEventTypeNetworkTotalUpdated                                      EventSubscriptionUpdateParamsEventType = "network_total.updated"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionCreated                                EventSubscriptionUpdateParamsEventType = "payment_transaction.created"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionUpdated                                EventSubscriptionUpdateParamsEventType = "payment_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeSettlementReportUpdated                                  EventSubscriptionUpdateParamsEventType = "settlement_report.updated"
	EventSubscriptionUpdateParamsEventTypeStatementsCreated                                        EventSubscriptionUpdateParamsEventType = "statements.created"
	EventSubscriptionUpdateParamsEventTypeThreeDSAuthenticationChallenge                           EventSubscriptionUpdateParamsEventType = "three_ds_authentication.challenge"
	EventSubscriptionUpdateParamsEventTypeThreeDSAuthenticationCreated                             EventSubscriptionUpdateParamsEventType = "three_ds_authentication.created"
	EventSubscriptionUpdateParamsEventTypeThreeDSAuthenticationUpdated                             EventSubscriptionUpdateParamsEventType = "three_ds_authentication.updated"
	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 ExternalBankAccount added in v0.98.0 

type ExternalBankAccount 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-character 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 ExternalBankAccountState `json:"state,required"`
	// Account Type
	Type ExternalBankAccountType `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 ExternalBankAccountVerificationState `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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	JSON                     externalBankAccountJSON `json:"-"`
}

func (*ExternalBankAccount) UnmarshalJSON added in v0.98.0 

func (r *ExternalBankAccount) 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,nullable"`
	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 ExternalBankAccountCreatedWebhookEvent added in v0.98.0 

type ExternalBankAccountCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ExternalBankAccountCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      externalBankAccountCreatedWebhookEventJSON      `json:"-"`
	ExternalBankAccount
}

func (*ExternalBankAccountCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ExternalBankAccountCreatedWebhookEventEventType added in v0.98.0 

type ExternalBankAccountCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	ExternalBankAccountCreatedWebhookEventEventTypeExternalBankAccountCreated ExternalBankAccountCreatedWebhookEventEventType = "external_bank_account.created"
)

func (ExternalBankAccountCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ExternalBankAccountCreatedWebhookEventEventType) IsKnown() bool

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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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"`
}

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 {
	// 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-character 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[ExternalBankAccountNewParamsBodyType] `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 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"`
	// 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-character 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-character 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 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, ExternalBankAccountNewParamsBodyExternallyVerifiedCreateBankAccountAPIRequest, ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequest, ExternalBankAccountNewParamsBody.

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequest added in v0.80.0 

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequest 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-character 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[ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType] `json:"type,required"`
	// Verification Method
	VerificationMethod param.Field[ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod] `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 (ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequest) MarshalJSON added in v0.80.0 

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

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType added in v0.80.0 

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType string

Account Type 

const (
	ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestTypeChecking ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType = "CHECKING"
	ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestTypeSavings  ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType = "SAVINGS"
)

func (ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType) IsKnown added in v0.80.0 

func (r ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestType) IsKnown() bool

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod added in v0.80.0 

type ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod string

Verification Method 

const (
	ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethodUnverified ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod = "UNVERIFIED"
)

func (ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod) IsKnown added in v0.80.0 

func (r ExternalBankAccountNewParamsBodyUnverifiedCreateBankAccountAPIRequestVerificationMethod) IsKnown() bool

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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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 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 *ExternalBankAccount, err error)

Retry external bank account prenote verification.

func (*ExternalBankAccountService) Unpause added in v0.96.0 

func (r *ExternalBankAccountService) Unpause(ctx context.Context, externalBankAccountToken string, opts ...option.RequestOption) (res *ExternalBankAccount, err error)

Unpause an external bank account

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 ExternalBankAccountState added in v0.98.0 

type ExternalBankAccountState string

Account State 

const (
	ExternalBankAccountStateEnabled ExternalBankAccountState = "ENABLED"
	ExternalBankAccountStateClosed  ExternalBankAccountState = "CLOSED"
	ExternalBankAccountStatePaused  ExternalBankAccountState = "PAUSED"
)

func (ExternalBankAccountState) IsKnown added in v0.98.0 

func (r ExternalBankAccountState) IsKnown() bool

type ExternalBankAccountType added in v0.98.0 

type ExternalBankAccountType string

Account Type 

const (
	ExternalBankAccountTypeChecking ExternalBankAccountType = "CHECKING"
	ExternalBankAccountTypeSavings  ExternalBankAccountType = "SAVINGS"
)

func (ExternalBankAccountType) IsKnown added in v0.98.0 

func (r ExternalBankAccountType) IsKnown() bool

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"`
	Type      param.Field[ExternalBankAccountUpdateParamsType] `json:"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 ExternalBankAccountUpdateParamsType added in v0.67.1 

type ExternalBankAccountUpdateParamsType string
const (
	ExternalBankAccountUpdateParamsTypeChecking ExternalBankAccountUpdateParamsType = "CHECKING"
	ExternalBankAccountUpdateParamsTypeSavings  ExternalBankAccountUpdateParamsType = "SAVINGS"
)

func (ExternalBankAccountUpdateParamsType) IsKnown added in v0.67.1 

func (r ExternalBankAccountUpdateParamsType) IsKnown() bool

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-character 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,nullable" format:"uuid"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// The financial account token of the operating account to fund the micro deposits
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// 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,nullable"`
	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 ExternalBankAccountUpdatedWebhookEvent added in v0.98.0 

type ExternalBankAccountUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ExternalBankAccountUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      externalBankAccountUpdatedWebhookEventJSON      `json:"-"`
	ExternalBankAccount
}

func (*ExternalBankAccountUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ExternalBankAccountUpdatedWebhookEventEventType added in v0.98.0 

type ExternalBankAccountUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	ExternalBankAccountUpdatedWebhookEventEventTypeExternalBankAccountUpdated ExternalBankAccountUpdatedWebhookEventEventType = "external_bank_account.updated"
)

func (ExternalBankAccountUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ExternalBankAccountUpdatedWebhookEventEventType) IsKnown() bool

type ExternalBankAccountVerificationState added in v0.98.0 

type ExternalBankAccountVerificationState string

Verification State 

const (
	ExternalBankAccountVerificationStatePending            ExternalBankAccountVerificationState = "PENDING"
	ExternalBankAccountVerificationStateEnabled            ExternalBankAccountVerificationState = "ENABLED"
	ExternalBankAccountVerificationStateFailedVerification ExternalBankAccountVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountVerificationStateInsufficientFunds  ExternalBankAccountVerificationState = "INSUFFICIENT_FUNDS"
)

func (ExternalBankAccountVerificationState) IsKnown added in v0.98.0 

func (r ExternalBankAccountVerificationState) IsKnown() bool

type ExternalPayment added in v0.51.0 

type ExternalPayment struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// The status of the transaction
	Status ExternalPaymentStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated  time.Time               `json:"updated,required" format:"date-time"`
	Category ExternalPaymentCategory `json:"category"`
	Currency string                  `json:"currency"`
	Events   []ExternalPaymentEvent  `json:"events"`
	// EXTERNAL_PAYMENT - External Payment Response
	Family                ExternalPaymentFamily      `json:"family"`
	FinancialAccountToken string                     `json:"financial_account_token" format:"uuid"`
	PaymentType           ExternalPaymentPaymentType `json:"payment_type"`
	PendingAmount         int64                      `json:"pending_amount"`
	Result                ExternalPaymentResult      `json:"result"`
	SettledAmount         int64                      `json:"settled_amount"`
	UserDefinedID         string                     `json:"user_defined_id,nullable"`
	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"
	ExternalPaymentCategoryExternalFednow   ExternalPaymentCategory = "EXTERNAL_FEDNOW"
	ExternalPaymentCategoryExternalRtp      ExternalPaymentCategory = "EXTERNAL_RTP"
	ExternalPaymentCategoryExternalTransfer ExternalPaymentCategory = "EXTERNAL_TRANSFER"
)

func (ExternalPaymentCategory) IsKnown added in v0.51.0 

func (r ExternalPaymentCategory) IsKnown() bool

type ExternalPaymentCreatedWebhookEvent added in v0.98.0 

type ExternalPaymentCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ExternalPaymentCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      externalPaymentCreatedWebhookEventJSON      `json:"-"`
	ExternalPayment
}

func (*ExternalPaymentCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ExternalPaymentCreatedWebhookEventEventType added in v0.98.0 

type ExternalPaymentCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	ExternalPaymentCreatedWebhookEventEventTypeExternalPaymentCreated ExternalPaymentCreatedWebhookEventEventType = "external_payment.created"
)

func (ExternalPaymentCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ExternalPaymentCreatedWebhookEventEventType) 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"
	ExternalPaymentEventsDetailedResultInsufficientFunds ExternalPaymentEventsDetailedResult = "INSUFFICIENT_FUNDS"
)

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"
	ExternalPaymentEventsTypeExternalFednowInitiated   ExternalPaymentEventsType = "EXTERNAL_FEDNOW_INITIATED"
	ExternalPaymentEventsTypeExternalFednowCanceled    ExternalPaymentEventsType = "EXTERNAL_FEDNOW_CANCELED"
	ExternalPaymentEventsTypeExternalFednowSettled     ExternalPaymentEventsType = "EXTERNAL_FEDNOW_SETTLED"
	ExternalPaymentEventsTypeExternalFednowReversed    ExternalPaymentEventsType = "EXTERNAL_FEDNOW_REVERSED"
	ExternalPaymentEventsTypeExternalFednowReleased    ExternalPaymentEventsType = "EXTERNAL_FEDNOW_RELEASED"
	ExternalPaymentEventsTypeExternalRtpInitiated      ExternalPaymentEventsType = "EXTERNAL_RTP_INITIATED"
	ExternalPaymentEventsTypeExternalRtpCanceled       ExternalPaymentEventsType = "EXTERNAL_RTP_CANCELED"
	ExternalPaymentEventsTypeExternalRtpSettled        ExternalPaymentEventsType = "EXTERNAL_RTP_SETTLED"
	ExternalPaymentEventsTypeExternalRtpReversed       ExternalPaymentEventsType = "EXTERNAL_RTP_REVERSED"
	ExternalPaymentEventsTypeExternalRtpReleased       ExternalPaymentEventsType = "EXTERNAL_RTP_RELEASED"
)

func (ExternalPaymentEventsType) IsKnown added in v0.51.0 

func (r ExternalPaymentEventsType) IsKnown() bool

type ExternalPaymentFamily added in v0.86.0 

type ExternalPaymentFamily string

EXTERNAL_PAYMENT - External Payment Response 

const (
	ExternalPaymentFamilyExternalPayment ExternalPaymentFamily = "EXTERNAL_PAYMENT"
)

func (ExternalPaymentFamily) IsKnown added in v0.86.0 

func (r ExternalPaymentFamily) 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"
	ExternalPaymentListParamsCategoryExternalFednow   ExternalPaymentListParamsCategory = "EXTERNAL_FEDNOW"
	ExternalPaymentListParamsCategoryExternalRtp      ExternalPaymentListParamsCategory = "EXTERNAL_RTP"
	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"
	ExternalPaymentListParamsStatusReturned ExternalPaymentListParamsStatus = "RETURNED"
)

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"`
	// 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"`
	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"
	ExternalPaymentNewParamsCategoryExternalFednow   ExternalPaymentNewParamsCategory = "EXTERNAL_FEDNOW"
	ExternalPaymentNewParamsCategoryExternalRtp      ExternalPaymentNewParamsCategory = "EXTERNAL_RTP"
	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

The status of the transaction 

const (
	ExternalPaymentStatusPending  ExternalPaymentStatus = "PENDING"
	ExternalPaymentStatusSettled  ExternalPaymentStatus = "SETTLED"
	ExternalPaymentStatusDeclined ExternalPaymentStatus = "DECLINED"
	ExternalPaymentStatusReversed ExternalPaymentStatus = "REVERSED"
	ExternalPaymentStatusCanceled ExternalPaymentStatus = "CANCELED"
	ExternalPaymentStatusReturned ExternalPaymentStatus = "RETURNED"
)

func (ExternalPaymentStatus) IsKnown added in v0.51.0 

func (r ExternalPaymentStatus) IsKnown() bool

type ExternalPaymentUpdatedWebhookEvent added in v0.98.0 

type ExternalPaymentUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ExternalPaymentUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      externalPaymentUpdatedWebhookEventJSON      `json:"-"`
	ExternalPayment
}

func (*ExternalPaymentUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ExternalPaymentUpdatedWebhookEventEventType added in v0.98.0 

type ExternalPaymentUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	ExternalPaymentUpdatedWebhookEventEventTypeExternalPaymentUpdated ExternalPaymentUpdatedWebhookEventEventType = "external_payment.updated"
)

func (ExternalPaymentUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ExternalPaymentUpdatedWebhookEventEventType) IsKnown() bool

type ExternalResource added in v0.84.0 

type ExternalResource struct {
	// Token identifying the external resource
	ExternalResourceToken string `json:"external_resource_token,required"`
	// Type of external resource associated with the management operation
	ExternalResourceType ExternalResourceType `json:"external_resource_type,required"`
	// Token identifying the external resource sub-resource
	ExternalResourceSubToken string               `json:"external_resource_sub_token"`
	JSON                     externalResourceJSON `json:"-"`
}

External resource associated with the management operation

func (*ExternalResource) UnmarshalJSON added in v0.84.0 

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

type ExternalResourceType added in v0.84.0 

type ExternalResourceType string

Type of external resource associated with the management operation 

const (
	ExternalResourceTypeStatement  ExternalResourceType = "STATEMENT"
	ExternalResourceTypeCollection ExternalResourceType = "COLLECTION"
	ExternalResourceTypeDispute    ExternalResourceType = "DISPUTE"
	ExternalResourceTypeUnknown    ExternalResourceType = "UNKNOWN"
)

func (ExternalResourceType) IsKnown added in v0.84.0 

func (r ExternalResourceType) 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"`
	// Status of the financial account
	Status FinancialAccountStatus `json:"status,required"`
	// Substatus for the financial account
	Substatus FinancialAccountSubstatus `json:"substatus,required,nullable"`
	Type      FinancialAccountType      `json:"type,required"`
	Updated   time.Time                 `json:"updated,required" format:"date-time"`
	// User-defined status for the financial account
	UserDefinedStatus string               `json:"user_defined_status,required,nullable"`
	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 FinancialAccountBalance added in v0.98.0 

type FinancialAccountBalance 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-character 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 FinancialAccountBalanceType `json:"type,required"`
	// Date and time for when the balance was last updated.
	Updated time.Time                   `json:"updated,required" format:"date-time"`
	JSON    financialAccountBalanceJSON `json:"-"`
}

Balance of a Financial Account

func (*FinancialAccountBalance) UnmarshalJSON added in v0.98.0 

func (r *FinancialAccountBalance) 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 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[FinancialAccountBalance], 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[FinancialAccountBalance]

Get the balances for a given financial account.

type FinancialAccountBalanceType added in v0.98.0 

type FinancialAccountBalanceType string

Type of financial account. 

const (
	FinancialAccountBalanceTypeIssuing   FinancialAccountBalanceType = "ISSUING"
	FinancialAccountBalanceTypeOperating FinancialAccountBalanceType = "OPERATING"
	FinancialAccountBalanceTypeReserve   FinancialAccountBalanceType = "RESERVE"
	FinancialAccountBalanceTypeSecurity  FinancialAccountBalanceType = "SECURITY"
)

func (FinancialAccountBalanceType) IsKnown added in v0.98.0 

func (r FinancialAccountBalanceType) IsKnown() bool

type FinancialAccountCreatedWebhookEvent added in v0.98.0 

type FinancialAccountCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType FinancialAccountCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      financialAccountCreatedWebhookEventJSON      `json:"-"`
	FinancialAccount
}

func (*FinancialAccountCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type FinancialAccountCreatedWebhookEventEventType added in v0.98.0 

type FinancialAccountCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	FinancialAccountCreatedWebhookEventEventTypeFinancialAccountCreated FinancialAccountCreatedWebhookEventEventType = "financial_account.created"
)

func (FinancialAccountCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r FinancialAccountCreatedWebhookEventEventType) 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"`
	AutoCollectionConfiguration FinancialAccountCreditConfigAutoCollectionConfiguration `json:"auto_collection_configuration,required"`
	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"`
	// 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 FinancialAccountCreditConfigAutoCollectionConfiguration added in v0.94.0 

type FinancialAccountCreditConfigAutoCollectionConfiguration struct {
	// If auto collection is enabled for this account
	AutoCollectionEnabled bool                                                        `json:"auto_collection_enabled,required"`
	JSON                  financialAccountCreditConfigAutoCollectionConfigurationJSON `json:"-"`
}

func (*FinancialAccountCreditConfigAutoCollectionConfiguration) UnmarshalJSON added in v0.94.0 

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

type FinancialAccountCreditConfiguration added in v0.51.0 

type FinancialAccountCreditConfiguration struct {
	AutoCollectionConfiguration FinancialAccountCreditConfigurationAutoCollectionConfiguration `json:"auto_collection_configuration,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"`
	// 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 FinancialAccountCreditConfigurationAutoCollectionConfiguration added in v0.94.0 

type FinancialAccountCreditConfigurationAutoCollectionConfiguration struct {
	// If auto collection is enabled for this account
	AutoCollectionEnabled bool                                                               `json:"auto_collection_enabled,required"`
	JSON                  financialAccountCreditConfigurationAutoCollectionConfigurationJSON `json:"-"`
}

func (*FinancialAccountCreditConfigurationAutoCollectionConfiguration) UnmarshalJSON added in v0.94.0 

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

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 {
	AutoCollectionConfiguration param.Field[FinancialAccountCreditConfigurationUpdateParamsAutoCollectionConfiguration] `json:"auto_collection_configuration"`
	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 FinancialAccountCreditConfigurationUpdateParamsAutoCollectionConfiguration added in v0.94.0 

type FinancialAccountCreditConfigurationUpdateParamsAutoCollectionConfiguration struct {
	// If auto collection is enabled for this account
	AutoCollectionEnabled param.Field[bool] `json:"auto_collection_enabled"`
}

func (FinancialAccountCreditConfigurationUpdateParamsAutoCollectionConfiguration) MarshalJSON added in v0.94.0 

func (r FinancialAccountCreditConfigurationUpdateParamsAutoCollectionConfiguration) 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"
	FinancialAccountListParamsTypeSecurity  FinancialAccountListParamsType = "SECURITY"
)

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 FinancialAccountRegisterAccountNumberParams added in v0.79.0 

type FinancialAccountRegisterAccountNumberParams struct {
	AccountNumber param.Field[string] `json:"account_number,required"`
}

func (FinancialAccountRegisterAccountNumberParams) MarshalJSON added in v0.79.0 

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

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) 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) RegisterAccountNumber added in v0.79.0 

func (r *FinancialAccountService) RegisterAccountNumber(ctx context.Context, financialAccountToken string, body FinancialAccountRegisterAccountNumberParams, opts ...option.RequestOption) (err error)

Register account number

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

func (*FinancialAccountService) UpdateStatus added in v0.70.0 

func (r *FinancialAccountService) UpdateStatus(ctx context.Context, financialAccountToken string, body FinancialAccountUpdateStatusParams, opts ...option.RequestOption) (res *FinancialAccount, err error)

Update financial account status

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 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[StatementLineItemsData], 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[StatementLineItemsData]

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 FinancialAccountStatus added in v0.68.0 

type FinancialAccountStatus string

Status of the financial account 

const (
	FinancialAccountStatusOpen      FinancialAccountStatus = "OPEN"
	FinancialAccountStatusClosed    FinancialAccountStatus = "CLOSED"
	FinancialAccountStatusSuspended FinancialAccountStatus = "SUSPENDED"
	FinancialAccountStatusPending   FinancialAccountStatus = "PENDING"
)

func (FinancialAccountStatus) IsKnown added in v0.68.0 

func (r FinancialAccountStatus) IsKnown() bool

type FinancialAccountSubstatus added in v0.72.0 

type FinancialAccountSubstatus string

Substatus for the financial account 

const (
	FinancialAccountSubstatusChargedOffDelinquent FinancialAccountSubstatus = "CHARGED_OFF_DELINQUENT"
	FinancialAccountSubstatusChargedOffFraud      FinancialAccountSubstatus = "CHARGED_OFF_FRAUD"
	FinancialAccountSubstatusEndUserRequest       FinancialAccountSubstatus = "END_USER_REQUEST"
	FinancialAccountSubstatusBankRequest          FinancialAccountSubstatus = "BANK_REQUEST"
	FinancialAccountSubstatusDelinquent           FinancialAccountSubstatus = "DELINQUENT"
)

func (FinancialAccountSubstatus) IsKnown added in v0.72.0 

func (r FinancialAccountSubstatus) IsKnown() bool

type FinancialAccountType 

type FinancialAccountType string
const (
	FinancialAccountTypeIssuing                    FinancialAccountType = "ISSUING"
	FinancialAccountTypeReserve                    FinancialAccountType = "RESERVE"
	FinancialAccountTypeOperating                  FinancialAccountType = "OPERATING"
	FinancialAccountTypeChargedOffFees             FinancialAccountType = "CHARGED_OFF_FEES"
	FinancialAccountTypeChargedOffInterest         FinancialAccountType = "CHARGED_OFF_INTEREST"
	FinancialAccountTypeChargedOffPrincipal        FinancialAccountType = "CHARGED_OFF_PRINCIPAL"
	FinancialAccountTypeSecurity                   FinancialAccountType = "SECURITY"
	FinancialAccountTypeProgramReceivables         FinancialAccountType = "PROGRAM_RECEIVABLES"
	FinancialAccountTypeCollection                 FinancialAccountType = "COLLECTION"
	FinancialAccountTypeProgramBankAccountsPayable FinancialAccountType = "PROGRAM_BANK_ACCOUNTS_PAYABLE"
)

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 FinancialAccountUpdateStatusParams added in v0.70.0 

type FinancialAccountUpdateStatusParams struct {
	// Status of the financial account
	Status param.Field[FinancialAccountUpdateStatusParamsStatus] `json:"status,required"`
	// Substatus for the financial account
	Substatus param.Field[FinancialAccountUpdateStatusParamsSubstatus] `json:"substatus,required"`
	// User-defined status for the financial account
	UserDefinedStatus param.Field[string] `json:"user_defined_status"`
}

func (FinancialAccountUpdateStatusParams) MarshalJSON added in v0.70.0 

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

type FinancialAccountUpdateStatusParamsStatus added in v0.70.0 

type FinancialAccountUpdateStatusParamsStatus string

Status of the financial account 

const (
	FinancialAccountUpdateStatusParamsStatusOpen      FinancialAccountUpdateStatusParamsStatus = "OPEN"
	FinancialAccountUpdateStatusParamsStatusClosed    FinancialAccountUpdateStatusParamsStatus = "CLOSED"
	FinancialAccountUpdateStatusParamsStatusSuspended FinancialAccountUpdateStatusParamsStatus = "SUSPENDED"
	FinancialAccountUpdateStatusParamsStatusPending   FinancialAccountUpdateStatusParamsStatus = "PENDING"
)

func (FinancialAccountUpdateStatusParamsStatus) IsKnown added in v0.70.0 

func (r FinancialAccountUpdateStatusParamsStatus) IsKnown() bool

type FinancialAccountUpdateStatusParamsSubstatus added in v0.72.0 

type FinancialAccountUpdateStatusParamsSubstatus string

Substatus for the financial account 

const (
	FinancialAccountUpdateStatusParamsSubstatusChargedOffFraud      FinancialAccountUpdateStatusParamsSubstatus = "CHARGED_OFF_FRAUD"
	FinancialAccountUpdateStatusParamsSubstatusEndUserRequest       FinancialAccountUpdateStatusParamsSubstatus = "END_USER_REQUEST"
	FinancialAccountUpdateStatusParamsSubstatusBankRequest          FinancialAccountUpdateStatusParamsSubstatus = "BANK_REQUEST"
	FinancialAccountUpdateStatusParamsSubstatusChargedOffDelinquent FinancialAccountUpdateStatusParamsSubstatus = "CHARGED_OFF_DELINQUENT"
)

func (FinancialAccountUpdateStatusParamsSubstatus) IsKnown added in v0.72.0 

func (r FinancialAccountUpdateStatusParamsSubstatus) IsKnown() bool

type FinancialAccountUpdatedWebhookEvent added in v0.98.0 

type FinancialAccountUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType FinancialAccountUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      financialAccountUpdatedWebhookEventJSON      `json:"-"`
	FinancialAccount
}

func (*FinancialAccountUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type FinancialAccountUpdatedWebhookEventEventType added in v0.98.0 

type FinancialAccountUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	FinancialAccountUpdatedWebhookEventEventTypeFinancialAccountUpdated FinancialAccountUpdatedWebhookEventEventType = "financial_account.updated"
)

func (FinancialAccountUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r FinancialAccountUpdatedWebhookEventEventType) IsKnown() bool

type FinancialEvent added in v0.96.0 

type FinancialEvent = shared.FinancialEvent

Financial Event

This is an alias to an internal type.

type FinancialEventResult added in v0.96.0 

type FinancialEventResult = shared.FinancialEventResult

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

This is an alias to an internal type.

type FinancialEventType added in v0.96.0 

type FinancialEventType = shared.FinancialEventType

This is an alias to an internal type.

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.
	//   - `INTERNAL` - Transaction for internal adjustment.
	//   - `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-character 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 []shared.FinancialEvent `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.
  • `INTERNAL` - Transaction for internal adjustment.
  • `TRANSFER` - Internal transfer of funds between financial accounts in your program.
const (
	FinancialTransactionCategoryACH      FinancialTransactionCategory = "ACH"
	FinancialTransactionCategoryCard     FinancialTransactionCategory = "CARD"
	FinancialTransactionCategoryInternal FinancialTransactionCategory = "INTERNAL"
	FinancialTransactionCategoryTransfer FinancialTransactionCategory = "TRANSFER"
)

func (FinancialTransactionCategory) IsKnown added in v0.27.0 

func (r FinancialTransactionCategory) 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"
	FinancialTransactionListParamsCategoryInternal FinancialTransactionListParamsCategory = "INTERNAL"
	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 FraudService added in v0.80.0 

type FraudService struct {
	Options      []option.RequestOption
	Transactions *FraudTransactionService
}

FraudService 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 NewFraudService method instead.

func NewFraudService added in v0.80.0 

func NewFraudService(opts ...option.RequestOption) (r *FraudService)

NewFraudService 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 FraudTransactionGetResponse added in v0.80.0 

type FraudTransactionGetResponse struct {
	// The fraud status of the transaction, string (enum) supporting the following
	// values:
	//
	//   - `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this
	//     hasn’t been confirmed.
	//   - `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may
	//     immediately be moved into this state, or be graduated into this state from the
	//     `SUSPECTED_FRAUD` state.
	//   - `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A
	//     transaction may immediately be moved into this state, or be graduated into
	//     this state from the `SUSPECTED_FRAUD` state.
	//   - `NO_REPORTED_FRAUD`: Indicates that no fraud report exists for the
	//     transaction. It is the default state for transactions that have not been
	//     analyzed or associated with any known fraudulent activity.
	FraudStatus FraudTransactionGetResponseFraudStatus `json:"fraud_status,required"`
	// The universally unique identifier (UUID) associated with the transaction being
	// reported.
	TransactionToken string `json:"transaction_token,required" format:"uuid"`
	// Provides additional context or details about the fraud report.
	Comment string `json:"comment"`
	// Timestamp representing when the fraud report was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Specifies the type or category of fraud that the transaction is suspected or
	// confirmed to involve, string (enum) supporting the following values:
	//
	//   - `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or
	//     cardholder intentionally misuses financial services for personal gain. This
	//     includes actions such as disputing legitimate transactions to obtain a refund,
	//     abusing return policies, or defaulting on credit obligations without intent to
	//     repay.
	//   - `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains
	//     unauthorized access to an existing account, modifies account settings, and
	//     carries out fraudulent transactions.
	//   - `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains
	//     access to card details without taking over the account, such as through
	//     physical card theft, cloning, or online data breaches.
	//   - `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen
	//     personal information, such as Social Security numbers or addresses, to open
	//     accounts, apply for loans, or conduct financial transactions in someone's
	//     name.
	//   - `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster
	//     manipulates or coerces a legitimate cardholder into unauthorized transactions,
	//     often through social engineering tactics.
	FraudType FraudTransactionGetResponseFraudType `json:"fraud_type"`
	// Timestamp representing the last update to the fraud report.
	UpdatedAt time.Time                       `json:"updated_at" format:"date-time"`
	JSON      fraudTransactionGetResponseJSON `json:"-"`
}

func (*FraudTransactionGetResponse) UnmarshalJSON added in v0.80.0 

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

type FraudTransactionGetResponseFraudStatus added in v0.80.0 

type FraudTransactionGetResponseFraudStatus string

The fraud status of the transaction, string (enum) supporting the following values:

  • `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this hasn’t been confirmed.
  • `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
  • `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
  • `NO_REPORTED_FRAUD`: Indicates that no fraud report exists for the transaction. It is the default state for transactions that have not been analyzed or associated with any known fraudulent activity.
const (
	FraudTransactionGetResponseFraudStatusSuspectedFraud  FraudTransactionGetResponseFraudStatus = "SUSPECTED_FRAUD"
	FraudTransactionGetResponseFraudStatusFraudulent      FraudTransactionGetResponseFraudStatus = "FRAUDULENT"
	FraudTransactionGetResponseFraudStatusNotFraudulent   FraudTransactionGetResponseFraudStatus = "NOT_FRAUDULENT"
	FraudTransactionGetResponseFraudStatusNoReportedFraud FraudTransactionGetResponseFraudStatus = "NO_REPORTED_FRAUD"
)

func (FraudTransactionGetResponseFraudStatus) IsKnown added in v0.80.0 

func (r FraudTransactionGetResponseFraudStatus) IsKnown() bool

type FraudTransactionGetResponseFraudType added in v0.80.0 

type FraudTransactionGetResponseFraudType string

Specifies the type or category of fraud that the transaction is suspected or confirmed to involve, string (enum) supporting the following values:

  • `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or cardholder intentionally misuses financial services for personal gain. This includes actions such as disputing legitimate transactions to obtain a refund, abusing return policies, or defaulting on credit obligations without intent to repay.
  • `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains unauthorized access to an existing account, modifies account settings, and carries out fraudulent transactions.
  • `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains access to card details without taking over the account, such as through physical card theft, cloning, or online data breaches.
  • `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen personal information, such as Social Security numbers or addresses, to open accounts, apply for loans, or conduct financial transactions in someone's name.
  • `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster manipulates or coerces a legitimate cardholder into unauthorized transactions, often through social engineering tactics.
const (
	FraudTransactionGetResponseFraudTypeFirstPartyFraud        FraudTransactionGetResponseFraudType = "FIRST_PARTY_FRAUD"
	FraudTransactionGetResponseFraudTypeAccountTakeover        FraudTransactionGetResponseFraudType = "ACCOUNT_TAKEOVER"
	FraudTransactionGetResponseFraudTypeCardCompromised        FraudTransactionGetResponseFraudType = "CARD_COMPROMISED"
	FraudTransactionGetResponseFraudTypeIdentityTheft          FraudTransactionGetResponseFraudType = "IDENTITY_THEFT"
	FraudTransactionGetResponseFraudTypeCardholderManipulation FraudTransactionGetResponseFraudType = "CARDHOLDER_MANIPULATION"
)

func (FraudTransactionGetResponseFraudType) IsKnown added in v0.80.0 

func (r FraudTransactionGetResponseFraudType) IsKnown() bool

type FraudTransactionReportParams added in v0.80.0 

type FraudTransactionReportParams struct {
	// The fraud status of the transaction, string (enum) supporting the following
	// values:
	//
	//   - `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this
	//     hasn’t been confirmed.
	//   - `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may
	//     immediately be moved into this state, or be graduated into this state from the
	//     `SUSPECTED_FRAUD` state.
	//   - `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A
	//     transaction may immediately be moved into this state, or be graduated into
	//     this state from the `SUSPECTED_FRAUD` state.
	FraudStatus param.Field[FraudTransactionReportParamsFraudStatus] `json:"fraud_status,required"`
	// Optional field providing additional information or context about why the
	// transaction is considered fraudulent.
	Comment param.Field[string] `json:"comment"`
	// Specifies the type or category of fraud that the transaction is suspected or
	// confirmed to involve, string (enum) supporting the following values:
	//
	//   - `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or
	//     cardholder intentionally misuses financial services for personal gain. This
	//     includes actions such as disputing legitimate transactions to obtain a refund,
	//     abusing return policies, or defaulting on credit obligations without intent to
	//     repay.
	//   - `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains
	//     unauthorized access to an existing account, modifies account settings, and
	//     carries out fraudulent transactions.
	//   - `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains
	//     access to card details without taking over the account, such as through
	//     physical card theft, cloning, or online data breaches.
	//   - `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen
	//     personal information, such as Social Security numbers or addresses, to open
	//     accounts, apply for loans, or conduct financial transactions in someone's
	//     name.
	//   - `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster
	//     manipulates or coerces a legitimate cardholder into unauthorized transactions,
	//     often through social engineering tactics.
	FraudType param.Field[FraudTransactionReportParamsFraudType] `json:"fraud_type"`
}

func (FraudTransactionReportParams) MarshalJSON added in v0.80.0 

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

type FraudTransactionReportParamsFraudStatus added in v0.80.0 

type FraudTransactionReportParamsFraudStatus string

The fraud status of the transaction, string (enum) supporting the following values:

  • `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this hasn’t been confirmed.
  • `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
  • `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
const (
	FraudTransactionReportParamsFraudStatusSuspectedFraud FraudTransactionReportParamsFraudStatus = "SUSPECTED_FRAUD"
	FraudTransactionReportParamsFraudStatusFraudulent     FraudTransactionReportParamsFraudStatus = "FRAUDULENT"
	FraudTransactionReportParamsFraudStatusNotFraudulent  FraudTransactionReportParamsFraudStatus = "NOT_FRAUDULENT"
)

func (FraudTransactionReportParamsFraudStatus) IsKnown added in v0.80.0 

func (r FraudTransactionReportParamsFraudStatus) IsKnown() bool

type FraudTransactionReportParamsFraudType added in v0.80.0 

type FraudTransactionReportParamsFraudType string

Specifies the type or category of fraud that the transaction is suspected or confirmed to involve, string (enum) supporting the following values:

  • `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or cardholder intentionally misuses financial services for personal gain. This includes actions such as disputing legitimate transactions to obtain a refund, abusing return policies, or defaulting on credit obligations without intent to repay.
  • `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains unauthorized access to an existing account, modifies account settings, and carries out fraudulent transactions.
  • `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains access to card details without taking over the account, such as through physical card theft, cloning, or online data breaches.
  • `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen personal information, such as Social Security numbers or addresses, to open accounts, apply for loans, or conduct financial transactions in someone's name.
  • `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster manipulates or coerces a legitimate cardholder into unauthorized transactions, often through social engineering tactics.
const (
	FraudTransactionReportParamsFraudTypeFirstPartyFraud        FraudTransactionReportParamsFraudType = "FIRST_PARTY_FRAUD"
	FraudTransactionReportParamsFraudTypeAccountTakeover        FraudTransactionReportParamsFraudType = "ACCOUNT_TAKEOVER"
	FraudTransactionReportParamsFraudTypeCardCompromised        FraudTransactionReportParamsFraudType = "CARD_COMPROMISED"
	FraudTransactionReportParamsFraudTypeIdentityTheft          FraudTransactionReportParamsFraudType = "IDENTITY_THEFT"
	FraudTransactionReportParamsFraudTypeCardholderManipulation FraudTransactionReportParamsFraudType = "CARDHOLDER_MANIPULATION"
)

func (FraudTransactionReportParamsFraudType) IsKnown added in v0.80.0 

func (r FraudTransactionReportParamsFraudType) IsKnown() bool

type FraudTransactionReportResponse added in v0.80.0 

type FraudTransactionReportResponse struct {
	// The fraud status of the transaction, string (enum) supporting the following
	// values:
	//
	//   - `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this
	//     hasn’t been confirmed.
	//   - `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may
	//     immediately be moved into this state, or be graduated into this state from the
	//     `SUSPECTED_FRAUD` state.
	//   - `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A
	//     transaction may immediately be moved into this state, or be graduated into
	//     this state from the `SUSPECTED_FRAUD` state.
	//   - `NO_REPORTED_FRAUD`: Indicates that no fraud report exists for the
	//     transaction. It is the default state for transactions that have not been
	//     analyzed or associated with any known fraudulent activity.
	FraudStatus FraudTransactionReportResponseFraudStatus `json:"fraud_status,required"`
	// The universally unique identifier (UUID) associated with the transaction being
	// reported.
	TransactionToken string `json:"transaction_token,required" format:"uuid"`
	// Provides additional context or details about the fraud report.
	Comment string `json:"comment"`
	// Timestamp representing when the fraud report was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Specifies the type or category of fraud that the transaction is suspected or
	// confirmed to involve, string (enum) supporting the following values:
	//
	//   - `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or
	//     cardholder intentionally misuses financial services for personal gain. This
	//     includes actions such as disputing legitimate transactions to obtain a refund,
	//     abusing return policies, or defaulting on credit obligations without intent to
	//     repay.
	//   - `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains
	//     unauthorized access to an existing account, modifies account settings, and
	//     carries out fraudulent transactions.
	//   - `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains
	//     access to card details without taking over the account, such as through
	//     physical card theft, cloning, or online data breaches.
	//   - `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen
	//     personal information, such as Social Security numbers or addresses, to open
	//     accounts, apply for loans, or conduct financial transactions in someone's
	//     name.
	//   - `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster
	//     manipulates or coerces a legitimate cardholder into unauthorized transactions,
	//     often through social engineering tactics.
	FraudType FraudTransactionReportResponseFraudType `json:"fraud_type"`
	// Timestamp representing the last update to the fraud report.
	UpdatedAt time.Time                          `json:"updated_at" format:"date-time"`
	JSON      fraudTransactionReportResponseJSON `json:"-"`
}

func (*FraudTransactionReportResponse) UnmarshalJSON added in v0.80.0 

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

type FraudTransactionReportResponseFraudStatus added in v0.80.0 

type FraudTransactionReportResponseFraudStatus string

The fraud status of the transaction, string (enum) supporting the following values:

  • `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this hasn’t been confirmed.
  • `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
  • `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the `SUSPECTED_FRAUD` state.
  • `NO_REPORTED_FRAUD`: Indicates that no fraud report exists for the transaction. It is the default state for transactions that have not been analyzed or associated with any known fraudulent activity.
const (
	FraudTransactionReportResponseFraudStatusSuspectedFraud  FraudTransactionReportResponseFraudStatus = "SUSPECTED_FRAUD"
	FraudTransactionReportResponseFraudStatusFraudulent      FraudTransactionReportResponseFraudStatus = "FRAUDULENT"
	FraudTransactionReportResponseFraudStatusNotFraudulent   FraudTransactionReportResponseFraudStatus = "NOT_FRAUDULENT"
	FraudTransactionReportResponseFraudStatusNoReportedFraud FraudTransactionReportResponseFraudStatus = "NO_REPORTED_FRAUD"
)

func (FraudTransactionReportResponseFraudStatus) IsKnown added in v0.80.0 

func (r FraudTransactionReportResponseFraudStatus) IsKnown() bool

type FraudTransactionReportResponseFraudType added in v0.80.0 

type FraudTransactionReportResponseFraudType string

Specifies the type or category of fraud that the transaction is suspected or confirmed to involve, string (enum) supporting the following values:

  • `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or cardholder intentionally misuses financial services for personal gain. This includes actions such as disputing legitimate transactions to obtain a refund, abusing return policies, or defaulting on credit obligations without intent to repay.
  • `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains unauthorized access to an existing account, modifies account settings, and carries out fraudulent transactions.
  • `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains access to card details without taking over the account, such as through physical card theft, cloning, or online data breaches.
  • `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen personal information, such as Social Security numbers or addresses, to open accounts, apply for loans, or conduct financial transactions in someone's name.
  • `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster manipulates or coerces a legitimate cardholder into unauthorized transactions, often through social engineering tactics.
const (
	FraudTransactionReportResponseFraudTypeFirstPartyFraud        FraudTransactionReportResponseFraudType = "FIRST_PARTY_FRAUD"
	FraudTransactionReportResponseFraudTypeAccountTakeover        FraudTransactionReportResponseFraudType = "ACCOUNT_TAKEOVER"
	FraudTransactionReportResponseFraudTypeCardCompromised        FraudTransactionReportResponseFraudType = "CARD_COMPROMISED"
	FraudTransactionReportResponseFraudTypeIdentityTheft          FraudTransactionReportResponseFraudType = "IDENTITY_THEFT"
	FraudTransactionReportResponseFraudTypeCardholderManipulation FraudTransactionReportResponseFraudType = "CARDHOLDER_MANIPULATION"
)

func (FraudTransactionReportResponseFraudType) IsKnown added in v0.80.0 

func (r FraudTransactionReportResponseFraudType) IsKnown() bool

type FraudTransactionService added in v0.80.0 

type FraudTransactionService struct {
	Options []option.RequestOption
}

FraudTransactionService 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 NewFraudTransactionService method instead.

func NewFraudTransactionService added in v0.80.0 

func NewFraudTransactionService(opts ...option.RequestOption) (r *FraudTransactionService)

NewFraudTransactionService 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 (*FraudTransactionService) Get added in v0.80.0 

func (r *FraudTransactionService) Get(ctx context.Context, transactionToken string, opts ...option.RequestOption) (res *FraudTransactionGetResponse, err error)

Retrieve a fraud report for a specific transaction identified by its unique transaction token.

func (*FraudTransactionService) Report added in v0.80.0 

func (r *FraudTransactionService) Report(ctx context.Context, transactionToken string, body FraudTransactionReportParams, opts ...option.RequestOption) (res *FraudTransactionReportResponse, err error)

Report fraud for a specific transaction token by providing details such as fraud type, fraud status, and any additional comments.

type FundingEvent added in v0.98.0 

type FundingEvent struct {
	// Unique token ID
	Token string `json:"token,required" format:"uuid"`
	// Collection resource type
	CollectionResourceType FundingEventCollectionResourceType `json:"collection_resource_type,required"`
	// IDs of collections, further information can be gathered from the appropriate
	// collection API based on collection_resource_type
	CollectionTokens []string `json:"collection_tokens,required" format:"uuid"`
	// Time of the creation
	Created time.Time `json:"created,required" format:"date-time"`
	// Time of the high watermark
	HighWatermark time.Time `json:"high_watermark,required" format:"date-time"`
	// Network settlement summary breakdown by network settlement date
	NetworkSettlementSummary []FundingEventNetworkSettlementSummary `json:"network_settlement_summary,required"`
	// Time of the previous high watermark
	PreviousHighWatermark time.Time `json:"previous_high_watermark,required" format:"date-time"`
	// Time of the update
	Updated time.Time        `json:"updated,required" format:"date-time"`
	JSON    fundingEventJSON `json:"-"`
}

func (*FundingEvent) UnmarshalJSON added in v0.98.0 

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

type FundingEventCollectionResourceType added in v0.98.0 

type FundingEventCollectionResourceType string

Collection resource type 

const (
	FundingEventCollectionResourceTypeBookTransfer FundingEventCollectionResourceType = "BOOK_TRANSFER"
	FundingEventCollectionResourceTypePayment      FundingEventCollectionResourceType = "PAYMENT"
)

func (FundingEventCollectionResourceType) IsKnown added in v0.98.0 

func (r FundingEventCollectionResourceType) IsKnown() bool

type FundingEventCreatedWebhookEvent added in v0.98.0 

type FundingEventCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType FundingEventCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      fundingEventCreatedWebhookEventJSON      `json:"-"`
	FundingEvent
}

func (*FundingEventCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type FundingEventCreatedWebhookEventEventType added in v0.98.0 

type FundingEventCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	FundingEventCreatedWebhookEventEventTypeFundingEventCreated FundingEventCreatedWebhookEventEventType = "funding_event.created"
)

func (FundingEventCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r FundingEventCreatedWebhookEventEventType) IsKnown() bool

type FundingEventGetDetailsResponse added in v0.78.0 

type FundingEventGetDetailsResponse struct {
	// Unique token ID
	Token string `json:"token,required" format:"uuid"`
	// URL of the settlement details
	SettlementDetailsURL string `json:"settlement_details_url,required" format:"uri"`
	// URL of the settlement summary
	SettlementSummaryURL string                             `json:"settlement_summary_url,required" format:"uri"`
	JSON                 fundingEventGetDetailsResponseJSON `json:"-"`
}

func (*FundingEventGetDetailsResponse) UnmarshalJSON added in v0.78.0 

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

type FundingEventListParams added in v0.78.0 

type FundingEventListParams 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" 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"`
}

func (FundingEventListParams) URLQuery added in v0.78.0 

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

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

type FundingEventNetworkSettlementSummary added in v0.98.0 

type FundingEventNetworkSettlementSummary struct {
	NetworkSettlementDate time.Time                                `json:"network_settlement_date,required" format:"date"`
	SettledGrossAmount    int64                                    `json:"settled_gross_amount,required"`
	JSON                  fundingEventNetworkSettlementSummaryJSON `json:"-"`
}

func (*FundingEventNetworkSettlementSummary) UnmarshalJSON added in v0.98.0 

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

type FundingEventService added in v0.78.0 

type FundingEventService struct {
	Options []option.RequestOption
}

FundingEventService 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 NewFundingEventService method instead.

func NewFundingEventService added in v0.78.0 

func NewFundingEventService(opts ...option.RequestOption) (r *FundingEventService)

NewFundingEventService 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 (*FundingEventService) Get added in v0.78.0 

func (r *FundingEventService) Get(ctx context.Context, fundingEventToken string, opts ...option.RequestOption) (res *FundingEvent, err error)

Get funding event for program by id

func (*FundingEventService) GetDetails added in v0.78.0 

func (r *FundingEventService) GetDetails(ctx context.Context, fundingEventToken string, opts ...option.RequestOption) (res *FundingEventGetDetailsResponse, err error)

Get funding event details by id

func (*FundingEventService) List added in v0.78.0 

func (r *FundingEventService) List(ctx context.Context, query FundingEventListParams, opts ...option.RequestOption) (res *pagination.CursorPage[FundingEvent], err error)

Get all funding events for program

func (*FundingEventService) ListAutoPaging added in v0.78.0 

func (r *FundingEventService) ListAutoPaging(ctx context.Context, query FundingEventListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[FundingEvent]

Get all funding events for program

type InternalTransaction added in v0.98.0 

type InternalTransaction struct {
	Token         string                      `json:"token,required" format:"uuid"`
	Category      InternalTransactionCategory `json:"category,required"`
	Created       time.Time                   `json:"created,required" format:"date-time"`
	Currency      string                      `json:"currency,required"`
	Descriptor    string                      `json:"descriptor,required"`
	Events        []InternalTransactionEvent  `json:"events,required"`
	PendingAmount int64                       `json:"pending_amount,required"`
	Result        InternalTransactionResult   `json:"result,required"`
	SettledAmount int64                       `json:"settled_amount,required"`
	Status        InternalTransactionStatus   `json:"status,required"`
	Updated       time.Time                   `json:"updated,required" format:"date-time"`
	JSON          internalTransactionJSON     `json:"-"`
}

func (*InternalTransaction) UnmarshalJSON added in v0.98.0 

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

type InternalTransactionCategory added in v0.98.0 

type InternalTransactionCategory string
const (
	InternalTransactionCategoryInternal InternalTransactionCategory = "INTERNAL"
)

func (InternalTransactionCategory) IsKnown added in v0.98.0 

func (r InternalTransactionCategory) IsKnown() bool

type InternalTransactionCreatedWebhookEvent added in v0.98.0 

type InternalTransactionCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType InternalTransactionCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      internalTransactionCreatedWebhookEventJSON      `json:"-"`
	InternalTransaction
}

func (*InternalTransactionCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type InternalTransactionCreatedWebhookEventEventType added in v0.98.0 

type InternalTransactionCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	InternalTransactionCreatedWebhookEventEventTypeInternalTransactionCreated InternalTransactionCreatedWebhookEventEventType = "internal_transaction.created"
)

func (InternalTransactionCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r InternalTransactionCreatedWebhookEventEventType) IsKnown() bool

type InternalTransactionEvent added in v0.98.0 

type InternalTransactionEvent struct {
	Token   string                          `json:"token,required" format:"uuid"`
	Amount  int64                           `json:"amount,required"`
	Created time.Time                       `json:"created,required" format:"date-time"`
	Result  InternalTransactionEventsResult `json:"result,required"`
	Type    InternalTransactionEventsType   `json:"type,required"`
	JSON    internalTransactionEventJSON    `json:"-"`
}

func (*InternalTransactionEvent) UnmarshalJSON added in v0.98.0 

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

type InternalTransactionEventsResult added in v0.98.0 

type InternalTransactionEventsResult string
const (
	InternalTransactionEventsResultApproved InternalTransactionEventsResult = "APPROVED"
	InternalTransactionEventsResultDeclined InternalTransactionEventsResult = "DECLINED"
)

func (InternalTransactionEventsResult) IsKnown added in v0.98.0 

func (r InternalTransactionEventsResult) IsKnown() bool

type InternalTransactionEventsType added in v0.98.0 

type InternalTransactionEventsType string
const (
	InternalTransactionEventsTypeInternalAdjustment InternalTransactionEventsType = "INTERNAL_ADJUSTMENT"
)

func (InternalTransactionEventsType) IsKnown added in v0.98.0 

func (r InternalTransactionEventsType) IsKnown() bool

type InternalTransactionResult added in v0.98.0 

type InternalTransactionResult string
const (
	InternalTransactionResultApproved InternalTransactionResult = "APPROVED"
	InternalTransactionResultDeclined InternalTransactionResult = "DECLINED"
)

func (InternalTransactionResult) IsKnown added in v0.98.0 

func (r InternalTransactionResult) IsKnown() bool

type InternalTransactionService added in v0.98.0 

type InternalTransactionService struct {
	Options []option.RequestOption
}

InternalTransactionService 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 NewInternalTransactionService method instead.

func NewInternalTransactionService added in v0.98.0 

func NewInternalTransactionService(opts ...option.RequestOption) (r *InternalTransactionService)

NewInternalTransactionService 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 InternalTransactionStatus added in v0.98.0 

type InternalTransactionStatus string
const (
	InternalTransactionStatusPending  InternalTransactionStatus = "PENDING"
	InternalTransactionStatusSettled  InternalTransactionStatus = "SETTLED"
	InternalTransactionStatusDeclined InternalTransactionStatus = "DECLINED"
	InternalTransactionStatusReversed InternalTransactionStatus = "REVERSED"
	InternalTransactionStatusCanceled InternalTransactionStatus = "CANCELED"
	InternalTransactionStatusReturned InternalTransactionStatus = "RETURNED"
)

func (InternalTransactionStatus) IsKnown added in v0.98.0 

func (r InternalTransactionStatus) IsKnown() bool

type InternalTransactionUpdatedWebhookEvent added in v0.98.0 

type InternalTransactionUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType InternalTransactionUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      internalTransactionUpdatedWebhookEventJSON      `json:"-"`
	InternalTransaction
}

func (*InternalTransactionUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type InternalTransactionUpdatedWebhookEventEventType added in v0.98.0 

type InternalTransactionUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	InternalTransactionUpdatedWebhookEventEventTypeInternalTransactionUpdated InternalTransactionUpdatedWebhookEventEventType = "internal_transaction.updated"
)

func (InternalTransactionUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r InternalTransactionUpdatedWebhookEventEventType) 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 KYBBusinessEntity added in v0.68.0 

type KYBBusinessEntity struct {
	// Business”s physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address KYBBusinessEntityAddress `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          kybBusinessEntityJSON `json:"-"`
}

func (*KYBBusinessEntity) UnmarshalJSON added in v0.68.0 

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

type KYBBusinessEntityAddress added in v0.68.0 

type KYBBusinessEntityAddress 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     kybBusinessEntityAddressJSON `json:"-"`
}

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

func (*KYBBusinessEntityAddress) UnmarshalJSON added in v0.68.0 

func (r *KYBBusinessEntityAddress) UnmarshalJSON(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 {
	// You must submit a list of all direct and indirect individuals with 25% or more
	// ownership in the company. A maximum of 4 beneficial owners can be submitted. If
	// no individual owns 25% of the company you do not need to send beneficial owner
	// information. 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.
	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"`
	// Deprecated.
	//
	// Deprecated: deprecated
	BeneficialOwnerEntities param.Field[[]KYBBeneficialOwnerEntityParam] `json:"beneficial_owner_entities"`
	// 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 KYB 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, entered in E.164 format.
	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 (
	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 StatementTotals `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             StatementTotals                  `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 StatementTotals `json:"ytd_totals,required"`
	// Interest tier to which this account belongs to
	Tier string       `json:"tier,nullable"`
	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"`
	// Information about the financial account state
	FinancialAccountState LoanTapeAccountStandingFinancialAccountState `json:"financial_account_state,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 LoanTapeAccountStandingFinancialAccountState added in v0.71.0 

type LoanTapeAccountStandingFinancialAccountState struct {
	// Status of the financial account
	Status LoanTapeAccountStandingFinancialAccountStateStatus `json:"status,required"`
	// Substatus for the financial account
	Substatus LoanTapeAccountStandingFinancialAccountStateSubstatus `json:"substatus,nullable"`
	JSON      loanTapeAccountStandingFinancialAccountStateJSON      `json:"-"`
}

Information about the financial account state

func (*LoanTapeAccountStandingFinancialAccountState) UnmarshalJSON added in v0.71.0 

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

type LoanTapeAccountStandingFinancialAccountStateStatus added in v0.71.0 

type LoanTapeAccountStandingFinancialAccountStateStatus string

Status of the financial account 

const (
	LoanTapeAccountStandingFinancialAccountStateStatusOpen      LoanTapeAccountStandingFinancialAccountStateStatus = "OPEN"
	LoanTapeAccountStandingFinancialAccountStateStatusClosed    LoanTapeAccountStandingFinancialAccountStateStatus = "CLOSED"
	LoanTapeAccountStandingFinancialAccountStateStatusSuspended LoanTapeAccountStandingFinancialAccountStateStatus = "SUSPENDED"
	LoanTapeAccountStandingFinancialAccountStateStatusPending   LoanTapeAccountStandingFinancialAccountStateStatus = "PENDING"
)

func (LoanTapeAccountStandingFinancialAccountStateStatus) IsKnown added in v0.71.0 

func (r LoanTapeAccountStandingFinancialAccountStateStatus) IsKnown() bool

type LoanTapeAccountStandingFinancialAccountStateSubstatus added in v0.72.0 

type LoanTapeAccountStandingFinancialAccountStateSubstatus string

Substatus for the financial account 

const (
	LoanTapeAccountStandingFinancialAccountStateSubstatusChargedOffDelinquent LoanTapeAccountStandingFinancialAccountStateSubstatus = "CHARGED_OFF_DELINQUENT"
	LoanTapeAccountStandingFinancialAccountStateSubstatusChargedOffFraud      LoanTapeAccountStandingFinancialAccountStateSubstatus = "CHARGED_OFF_FRAUD"
	LoanTapeAccountStandingFinancialAccountStateSubstatusEndUserRequest       LoanTapeAccountStandingFinancialAccountStateSubstatus = "END_USER_REQUEST"
	LoanTapeAccountStandingFinancialAccountStateSubstatusBankRequest          LoanTapeAccountStandingFinancialAccountStateSubstatus = "BANK_REQUEST"
	LoanTapeAccountStandingFinancialAccountStateSubstatusDelinquent           LoanTapeAccountStandingFinancialAccountStateSubstatus = "DELINQUENT"
)

func (LoanTapeAccountStandingFinancialAccountStateSubstatus) IsKnown added in v0.72.0 

func (r LoanTapeAccountStandingFinancialAccountStateSubstatus) IsKnown() bool

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 CategoryBalances `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 CategoryBalances `json:"next_statement_due,required"`
	// Amount not paid off on previous due dates
	PastDue CategoryBalances `json:"past_due,required"`
	// Amount due for the past billing cycles.
	PastStatementsDue CategoryBalances     `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 LoanTapeCreatedWebhookEvent added in v0.98.0 

type LoanTapeCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType LoanTapeCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      loanTapeCreatedWebhookEventJSON      `json:"-"`
	LoanTape
}

func (*LoanTapeCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type LoanTapeCreatedWebhookEventEventType added in v0.98.0 

type LoanTapeCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	LoanTapeCreatedWebhookEventEventTypeLoanTapeCreated LoanTapeCreatedWebhookEventEventType = "loan_tape.created"
)

func (LoanTapeCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r LoanTapeCreatedWebhookEventEventType) IsKnown() bool

type LoanTapeInterestDetails added in v0.60.0 

type LoanTapeInterestDetails struct {
	ActualInterestCharged     int64                                            `json:"actual_interest_charged,required,nullable"`
	DailyBalanceAmounts       CategoryDetails                                  `json:"daily_balance_amounts,required"`
	EffectiveApr              CategoryDetails                                  `json:"effective_apr,required"`
	InterestCalculationMethod LoanTapeInterestDetailsInterestCalculationMethod `json:"interest_calculation_method,required"`
	InterestForPeriod         CategoryDetails                                  `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 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 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 {
	FeeDetails CategoryDetails `json:"fee_details,required,nullable"`
	// Amount allocated to fees in cents
	Fees int64 `json:"fees,required"`
	// Amount allocated to interest in cents
	Interest        int64           `json:"interest,required"`
	InterestDetails CategoryDetails `json:"interest_details,required,nullable"`
	// Amount allocated to principal in cents
	Principal        int64                         `json:"principal,required"`
	PrincipalDetails CategoryDetails               `json:"principal_details,required,nullable"`
	JSON             loanTapePaymentAllocationJSON `json:"-"`
}

func (*LoanTapePaymentAllocation) UnmarshalJSON added in v0.55.0 

func (r *LoanTapePaymentAllocation) 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 LoanTapeUpdatedWebhookEvent added in v0.98.0 

type LoanTapeUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType LoanTapeUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      loanTapeUpdatedWebhookEventJSON      `json:"-"`
	LoanTape
}

func (*LoanTapeUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type LoanTapeUpdatedWebhookEventEventType added in v0.98.0 

type LoanTapeUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	LoanTapeUpdatedWebhookEventEventTypeLoanTapeUpdated LoanTapeUpdatedWebhookEventEventType = "loan_tape.updated"
)

func (LoanTapeUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r LoanTapeUpdatedWebhookEventEventType) IsKnown() bool

type ManagementOperationCreatedWebhookEvent added in v0.98.0 

type ManagementOperationCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ManagementOperationCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      managementOperationCreatedWebhookEventJSON      `json:"-"`
	ManagementOperationTransaction
}

func (*ManagementOperationCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ManagementOperationCreatedWebhookEventEventType added in v0.98.0 

type ManagementOperationCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	ManagementOperationCreatedWebhookEventEventTypeManagementOperationCreated ManagementOperationCreatedWebhookEventEventType = "management_operation.created"
)

func (ManagementOperationCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ManagementOperationCreatedWebhookEventEventType) IsKnown() bool

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"
	ManagementOperationListParamsCategoryManagementDisbursement ManagementOperationListParamsCategory = "MANAGEMENT_DISBURSEMENT"
)

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"
	ManagementOperationListParamsStatusReturned ManagementOperationListParamsStatus = "RETURNED"
)

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"`
	// 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"`
	// What to do if the financial account is closed when posting an operation
	OnClosedAccount param.Field[ManagementOperationNewParamsOnClosedAccount] `json:"on_closed_account"`
	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"
	ManagementOperationNewParamsCategoryManagementDisbursement ManagementOperationNewParamsCategory = "MANAGEMENT_DISBURSEMENT"
)

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 (
	ManagementOperationNewParamsEventTypeLossWriteOff               ManagementOperationNewParamsEventType = "LOSS_WRITE_OFF"
	ManagementOperationNewParamsEventTypeCashBack                   ManagementOperationNewParamsEventType = "CASH_BACK"
	ManagementOperationNewParamsEventTypeCashBackReversal           ManagementOperationNewParamsEventType = "CASH_BACK_REVERSAL"
	ManagementOperationNewParamsEventTypeCurrencyConversion         ManagementOperationNewParamsEventType = "CURRENCY_CONVERSION"
	ManagementOperationNewParamsEventTypeCurrencyConversionReversal ManagementOperationNewParamsEventType = "CURRENCY_CONVERSION_REVERSAL"
	ManagementOperationNewParamsEventTypeInterest                   ManagementOperationNewParamsEventType = "INTEREST"
	ManagementOperationNewParamsEventTypeInterestReversal           ManagementOperationNewParamsEventType = "INTEREST_REVERSAL"
	ManagementOperationNewParamsEventTypeLatePayment                ManagementOperationNewParamsEventType = "LATE_PAYMENT"
	ManagementOperationNewParamsEventTypeLatePaymentReversal        ManagementOperationNewParamsEventType = "LATE_PAYMENT_REVERSAL"
	ManagementOperationNewParamsEventTypeBillingError               ManagementOperationNewParamsEventType = "BILLING_ERROR"
	ManagementOperationNewParamsEventTypeBillingErrorReversal       ManagementOperationNewParamsEventType = "BILLING_ERROR_REVERSAL"
	ManagementOperationNewParamsEventTypeProvisionalCredit          ManagementOperationNewParamsEventType = "PROVISIONAL_CREDIT"
	ManagementOperationNewParamsEventTypeProvisionalCreditReversal  ManagementOperationNewParamsEventType = "PROVISIONAL_CREDIT_REVERSAL"
	ManagementOperationNewParamsEventTypeReturnedPayment            ManagementOperationNewParamsEventType = "RETURNED_PAYMENT"
	ManagementOperationNewParamsEventTypeReturnedPaymentReversal    ManagementOperationNewParamsEventType = "RETURNED_PAYMENT_REVERSAL"
	ManagementOperationNewParamsEventTypeDisputeWon                 ManagementOperationNewParamsEventType = "DISPUTE_WON"
	ManagementOperationNewParamsEventTypeDisputeWonReversal         ManagementOperationNewParamsEventType = "DISPUTE_WON_REVERSAL"
	ManagementOperationNewParamsEventTypeDisburse                   ManagementOperationNewParamsEventType = "DISBURSE"
	ManagementOperationNewParamsEventTypeDisburseReversal           ManagementOperationNewParamsEventType = "DISBURSE_REVERSAL"
	ManagementOperationNewParamsEventTypeAnnual                     ManagementOperationNewParamsEventType = "ANNUAL"
	ManagementOperationNewParamsEventTypeAnnualReversal             ManagementOperationNewParamsEventType = "ANNUAL_REVERSAL"
	ManagementOperationNewParamsEventTypeQuarterly                  ManagementOperationNewParamsEventType = "QUARTERLY"
	ManagementOperationNewParamsEventTypeQuarterlyReversal          ManagementOperationNewParamsEventType = "QUARTERLY_REVERSAL"
	ManagementOperationNewParamsEventTypeMonthly                    ManagementOperationNewParamsEventType = "MONTHLY"
	ManagementOperationNewParamsEventTypeMonthlyReversal            ManagementOperationNewParamsEventType = "MONTHLY_REVERSAL"
)

func (ManagementOperationNewParamsEventType) IsKnown added in v0.55.0 

func (r ManagementOperationNewParamsEventType) IsKnown() bool

type ManagementOperationNewParamsOnClosedAccount added in v0.84.0 

type ManagementOperationNewParamsOnClosedAccount string

What to do if the financial account is closed when posting an operation 

const (
	ManagementOperationNewParamsOnClosedAccountFail        ManagementOperationNewParamsOnClosedAccount = "FAIL"
	ManagementOperationNewParamsOnClosedAccountUseSuspense ManagementOperationNewParamsOnClosedAccount = "USE_SUSPENSE"
)

func (ManagementOperationNewParamsOnClosedAccount) IsKnown added in v0.84.0 

func (r ManagementOperationNewParamsOnClosedAccount) 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 {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// The status of the transaction
	Status ManagementOperationTransactionStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated   time.Time                               `json:"updated,required" format:"date-time"`
	Category  ManagementOperationTransactionCategory  `json:"category"`
	Currency  string                                  `json:"currency"`
	Direction ManagementOperationTransactionDirection `json:"direction"`
	Events    []ManagementOperationTransactionEvent   `json:"events"`
	// External resource associated with the management operation
	ExternalResource ExternalResource `json:"external_resource,nullable"`
	// MANAGEMENT_OPERATION - Management Operation Transaction
	Family                ManagementOperationTransactionFamily            `json:"family"`
	FinancialAccountToken string                                          `json:"financial_account_token" format:"uuid"`
	PendingAmount         int64                                           `json:"pending_amount"`
	Result                ManagementOperationTransactionResult            `json:"result"`
	SettledAmount         int64                                           `json:"settled_amount"`
	TransactionSeries     ManagementOperationTransactionTransactionSeries `json:"transaction_series,nullable"`
	UserDefinedID         string                                          `json:"user_defined_id,nullable"`
	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"
	ManagementOperationTransactionCategoryManagementDisbursement ManagementOperationTransactionCategory = "MANAGEMENT_DISBURSEMENT"
)

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,nullable"`
	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"
	ManagementOperationTransactionEventsDetailedResultInsufficientFunds ManagementOperationTransactionEventsDetailedResult = "INSUFFICIENT_FUNDS"
)

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 (
	ManagementOperationTransactionEventsTypeLossWriteOff               ManagementOperationTransactionEventsType = "LOSS_WRITE_OFF"
	ManagementOperationTransactionEventsTypeCashBack                   ManagementOperationTransactionEventsType = "CASH_BACK"
	ManagementOperationTransactionEventsTypeCashBackReversal           ManagementOperationTransactionEventsType = "CASH_BACK_REVERSAL"
	ManagementOperationTransactionEventsTypeCurrencyConversion         ManagementOperationTransactionEventsType = "CURRENCY_CONVERSION"
	ManagementOperationTransactionEventsTypeCurrencyConversionReversal ManagementOperationTransactionEventsType = "CURRENCY_CONVERSION_REVERSAL"
	ManagementOperationTransactionEventsTypeInterest                   ManagementOperationTransactionEventsType = "INTEREST"
	ManagementOperationTransactionEventsTypeInterestReversal           ManagementOperationTransactionEventsType = "INTEREST_REVERSAL"
	ManagementOperationTransactionEventsTypeLatePayment                ManagementOperationTransactionEventsType = "LATE_PAYMENT"
	ManagementOperationTransactionEventsTypeLatePaymentReversal        ManagementOperationTransactionEventsType = "LATE_PAYMENT_REVERSAL"
	ManagementOperationTransactionEventsTypeBillingError               ManagementOperationTransactionEventsType = "BILLING_ERROR"
	ManagementOperationTransactionEventsTypeBillingErrorReversal       ManagementOperationTransactionEventsType = "BILLING_ERROR_REVERSAL"
	ManagementOperationTransactionEventsTypeProvisionalCredit          ManagementOperationTransactionEventsType = "PROVISIONAL_CREDIT"
	ManagementOperationTransactionEventsTypeProvisionalCreditReversal  ManagementOperationTransactionEventsType = "PROVISIONAL_CREDIT_REVERSAL"
	ManagementOperationTransactionEventsTypeReturnedPayment            ManagementOperationTransactionEventsType = "RETURNED_PAYMENT"
	ManagementOperationTransactionEventsTypeReturnedPaymentReversal    ManagementOperationTransactionEventsType = "RETURNED_PAYMENT_REVERSAL"
	ManagementOperationTransactionEventsTypeDisputeWon                 ManagementOperationTransactionEventsType = "DISPUTE_WON"
	ManagementOperationTransactionEventsTypeDisputeWonReversal         ManagementOperationTransactionEventsType = "DISPUTE_WON_REVERSAL"
	ManagementOperationTransactionEventsTypeDisburse                   ManagementOperationTransactionEventsType = "DISBURSE"
	ManagementOperationTransactionEventsTypeDisburseReversal           ManagementOperationTransactionEventsType = "DISBURSE_REVERSAL"
	ManagementOperationTransactionEventsTypeAnnual                     ManagementOperationTransactionEventsType = "ANNUAL"
	ManagementOperationTransactionEventsTypeAnnualReversal             ManagementOperationTransactionEventsType = "ANNUAL_REVERSAL"
	ManagementOperationTransactionEventsTypeQuarterly                  ManagementOperationTransactionEventsType = "QUARTERLY"
	ManagementOperationTransactionEventsTypeQuarterlyReversal          ManagementOperationTransactionEventsType = "QUARTERLY_REVERSAL"
	ManagementOperationTransactionEventsTypeMonthly                    ManagementOperationTransactionEventsType = "MONTHLY"
	ManagementOperationTransactionEventsTypeMonthlyReversal            ManagementOperationTransactionEventsType = "MONTHLY_REVERSAL"
)

func (ManagementOperationTransactionEventsType) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionEventsType) IsKnown() bool

type ManagementOperationTransactionFamily added in v0.86.0 

type ManagementOperationTransactionFamily string

MANAGEMENT_OPERATION - Management Operation Transaction 

const (
	ManagementOperationTransactionFamilyManagementOperation ManagementOperationTransactionFamily = "MANAGEMENT_OPERATION"
)

func (ManagementOperationTransactionFamily) IsKnown added in v0.86.0 

func (r ManagementOperationTransactionFamily) 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

The status of the transaction 

const (
	ManagementOperationTransactionStatusPending  ManagementOperationTransactionStatus = "PENDING"
	ManagementOperationTransactionStatusSettled  ManagementOperationTransactionStatus = "SETTLED"
	ManagementOperationTransactionStatusDeclined ManagementOperationTransactionStatus = "DECLINED"
	ManagementOperationTransactionStatusReversed ManagementOperationTransactionStatus = "REVERSED"
	ManagementOperationTransactionStatusCanceled ManagementOperationTransactionStatus = "CANCELED"
	ManagementOperationTransactionStatusReturned ManagementOperationTransactionStatus = "RETURNED"
)

func (ManagementOperationTransactionStatus) IsKnown added in v0.55.0 

func (r ManagementOperationTransactionStatus) IsKnown() bool

type ManagementOperationTransactionTransactionSeries added in v0.73.0 

type ManagementOperationTransactionTransactionSeries struct {
	RelatedTransactionEventToken string                                              `json:"related_transaction_event_token,required,nullable" format:"uuid"`
	RelatedTransactionToken      string                                              `json:"related_transaction_token,required,nullable" format:"uuid"`
	Type                         string                                              `json:"type,required"`
	JSON                         managementOperationTransactionTransactionSeriesJSON `json:"-"`
}

func (*ManagementOperationTransactionTransactionSeries) UnmarshalJSON added in v0.73.0 

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

type ManagementOperationUpdatedWebhookEvent added in v0.98.0 

type ManagementOperationUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ManagementOperationUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      managementOperationUpdatedWebhookEventJSON      `json:"-"`
	ManagementOperationTransaction
}

func (*ManagementOperationUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ManagementOperationUpdatedWebhookEventEventType added in v0.98.0 

type ManagementOperationUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	ManagementOperationUpdatedWebhookEventEventTypeManagementOperationUpdated ManagementOperationUpdatedWebhookEventEventType = "management_operation.updated"
)

func (ManagementOperationUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ManagementOperationUpdatedWebhookEventEventType) IsKnown() bool

type Merchant added in v0.96.0 

type Merchant = shared.Merchant

This is an alias to an internal type.

type MerchantLockParameters added in v0.82.0 

type MerchantLockParameters struct {
	// A list of merchant locks defining specific merchants or groups of merchants
	// (based on descriptors or IDs) that the lock applies to.
	Merchants []MerchantLockParametersMerchant `json:"merchants,required"`
	JSON      merchantLockParametersJSON       `json:"-"`
}

func (*MerchantLockParameters) UnmarshalJSON added in v0.82.0 

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

type MerchantLockParametersMerchant added in v0.82.0 

type MerchantLockParametersMerchant struct {
	// A comment or explanation about the merchant, used internally for rule management
	// purposes.
	Comment string `json:"comment"`
	// Short description of the merchant, often used to provide more human-readable
	// context about the transaction merchant. This is typically the name or label
	// shown on transaction summaries.
	Descriptor string `json:"descriptor"`
	// Unique alphanumeric identifier for the payment card acceptor (merchant). This
	// attribute specifies the merchant entity that will be locked or referenced for
	// authorization rules.
	MerchantID string                             `json:"merchant_id"`
	JSON       merchantLockParametersMerchantJSON `json:"-"`
}

Represents a specific merchant lock based on their ID or descriptor. Each merchant object allows transaction rules to work at a granular level and requires at least one of merchant_id or descriptor.

func (*MerchantLockParametersMerchant) UnmarshalJSON added in v0.82.0 

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

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 NetworkProgram added in v0.84.0 

type NetworkProgram struct {
	// Lithic-generated unique identifier for the program
	Token string `json:"token,required" format:"uuid"`
	// Network product ID associated with this program.
	DefaultProductCode string `json:"default_product_code,required"`
	// The name of the network program.
	Name string `json:"name,required"`
	// RPIN value assigned by the network.
	RegisteredProgramIdentificationNumber string             `json:"registered_program_identification_number,required"`
	JSON                                  networkProgramJSON `json:"-"`
}

func (*NetworkProgram) UnmarshalJSON added in v0.84.0 

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

type NetworkProgramListParams added in v0.84.0 

type NetworkProgramListParams 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"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
}

func (NetworkProgramListParams) URLQuery added in v0.84.0 

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

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

type NetworkProgramService added in v0.84.0 

type NetworkProgramService struct {
	Options []option.RequestOption
}

NetworkProgramService 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 NewNetworkProgramService method instead.

func NewNetworkProgramService added in v0.84.0 

func NewNetworkProgramService(opts ...option.RequestOption) (r *NetworkProgramService)

NewNetworkProgramService 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 (*NetworkProgramService) Get added in v0.84.0 

func (r *NetworkProgramService) Get(ctx context.Context, networkProgramToken string, opts ...option.RequestOption) (res *NetworkProgram, err error)

Get network program.

func (*NetworkProgramService) List added in v0.84.0 

func (r *NetworkProgramService) List(ctx context.Context, query NetworkProgramListParams, opts ...option.RequestOption) (res *pagination.SinglePage[NetworkProgram], err error)

List network programs.

func (*NetworkProgramService) ListAutoPaging added in v0.84.0 

func (r *NetworkProgramService) ListAutoPaging(ctx context.Context, query NetworkProgramListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[NetworkProgram]

List network programs.

type NetworkTotal added in v0.98.0 

type NetworkTotal struct {
	// Globally unique identifier.
	Token   string              `json:"token,required" format:"uuid"`
	Amounts NetworkTotalAmounts `json:"amounts,required"`
	// RFC 3339 timestamp for when the record was created. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-character alphabetic ISO 4217 code.
	Currency string `json:"currency,required"`
	// The institution that activity occurred on. For Mastercard: ICA (Interbank Card
	// Association). For Maestro: institution ID. For Visa: lowest level SRE
	// (Settlement Reporting Entity).
	InstitutionID string `json:"institution_id,required"`
	// Indicates that all settlement records related to this Network Total are
	// available in the details endpoint.
	IsComplete bool `json:"is_complete,required"`
	// Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
	// or INTERLINK.
	Network NetworkTotalNetwork `json:"network,required"`
	// Date that the network total record applies to. YYYY-MM-DD format.
	ReportDate time.Time `json:"report_date,required" format:"date"`
	// The institution responsible for settlement. For Mastercard: same as
	// `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
	// (FTSRE).
	SettlementInstitutionID string `json:"settlement_institution_id,required"`
	// Settlement service.
	SettlementService string `json:"settlement_service,required"`
	// RFC 3339 timestamp for when the record was last updated. UTC time zone.
	Updated time.Time `json:"updated,required" format:"date-time"`
	// The clearing cycle that the network total record applies to. Mastercard only.
	Cycle int64            `json:"cycle"`
	JSON  networkTotalJSON `json:"-"`
}

func (*NetworkTotal) UnmarshalJSON added in v0.98.0 

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

type NetworkTotalAmounts added in v0.98.0 

type NetworkTotalAmounts struct {
	// Total settlement amount excluding interchange, in currency's smallest unit.
	GrossSettlement int64 `json:"gross_settlement,required"`
	// Interchange amount, in currency's smallest unit.
	InterchangeFees int64 `json:"interchange_fees,required"`
	// `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
	// in currency's smallest unit.
	NetSettlement int64 `json:"net_settlement,required"`
	// Charges specific to Visa/Interlink, in currency's smallest unit.
	VisaCharges int64                   `json:"visa_charges"`
	JSON        networkTotalAmountsJSON `json:"-"`
}

func (*NetworkTotalAmounts) UnmarshalJSON added in v0.98.0 

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

type NetworkTotalCreatedWebhookEvent added in v0.98.0 

type NetworkTotalCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType NetworkTotalCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      networkTotalCreatedWebhookEventJSON      `json:"-"`
	NetworkTotal
}

func (*NetworkTotalCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type NetworkTotalCreatedWebhookEventEventType added in v0.98.0 

type NetworkTotalCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	NetworkTotalCreatedWebhookEventEventTypeNetworkTotalCreated NetworkTotalCreatedWebhookEventEventType = "network_total.created"
)

func (NetworkTotalCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r NetworkTotalCreatedWebhookEventEventType) IsKnown() bool

type NetworkTotalNetwork added in v0.98.0 

type NetworkTotalNetwork string

Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO, or INTERLINK. 

const (
	NetworkTotalNetworkAmex       NetworkTotalNetwork = "AMEX"
	NetworkTotalNetworkVisa       NetworkTotalNetwork = "VISA"
	NetworkTotalNetworkMastercard NetworkTotalNetwork = "MASTERCARD"
	NetworkTotalNetworkMaestro    NetworkTotalNetwork = "MAESTRO"
	NetworkTotalNetworkInterlink  NetworkTotalNetwork = "INTERLINK"
)

func (NetworkTotalNetwork) IsKnown added in v0.98.0 

func (r NetworkTotalNetwork) IsKnown() bool

type NetworkTotalUpdatedWebhookEvent added in v0.98.0 

type NetworkTotalUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType NetworkTotalUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      networkTotalUpdatedWebhookEventJSON      `json:"-"`
	NetworkTotal
}

func (*NetworkTotalUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type NetworkTotalUpdatedWebhookEventEventType added in v0.98.0 

type NetworkTotalUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	NetworkTotalUpdatedWebhookEventEventTypeNetworkTotalUpdated NetworkTotalUpdatedWebhookEventEventType = "network_total.updated"
)

func (NetworkTotalUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r NetworkTotalUpdatedWebhookEventEventType) IsKnown() bool

type NonPCICard added in v0.75.0 

type NonPCICard struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// Globally unique identifier for the account to which the card belongs.
	AccountToken string `json:"account_token,required"`
	// Globally unique identifier for the card program on which the card exists.
	CardProgramToken string `json:"card_program_token,required"`
	// 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 NonPCICardFunding `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 NonPCICardPinStatus `json:"pin_status,required"`
	// Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
	// $1,000 limit). 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 or can be added to mobile wallets. 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 NonPCICardState `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. _ `SINGLE_USE` - Card is closed upon first successful
	// authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
	// merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
	// Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
	// `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
	// VIRTUAL instead.
	Type NonPCICardType `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.
	//
	// Deprecated: deprecated
	AuthRuleTokens []string `json:"auth_rule_tokens"`
	// Globally unique identifier for the bulk order associated with this card. Only
	// applicable to physical cards that are part of a bulk shipment
	BulkOrderToken string `json:"bulk_order_token,nullable" format:"uuid"`
	// 3-character alphabetic ISO 4217 code for the currency of the cardholder.
	CardholderCurrency string `json:"cardholder_currency"`
	// Additional context or information related to the card.
	Comment string `json:"comment"`
	// 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.
	DigitalCardArtToken string `json:"digital_card_art_token"`
	// 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"`
	// Globally unique identifier for the card's network program. Null if the card is
	// not associated with a network program. Currently applicable to Visa cards
	// participating in Account Level Management only
	NetworkProgramToken string `json:"network_program_token,nullable"`
	// 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"`
	// If the card is a replacement for another card, the globally unique identifier
	// for the card that was replaced.
	ReplacementFor string `json:"replacement_for,nullable"`
	// Card state substatus values: _ `LOST` - The physical card is no longer in the
	// cardholder's possession due to being lost or never received by the cardholder. _
	// `COMPROMISED` - Card information has been exposed, potentially leading to
	// unauthorized access. This may involve physical card theft, cloning, or online
	// data breaches. _ `DAMAGED` - The physical card is not functioning properly, such
	// as having chip failures or a demagnetized magnetic stripe. _
	// `END_USER_REQUEST` - The cardholder requested the closure of the card for
	// reasons unrelated to fraud or damage, such as switching to a different product
	// or closing the account. _ `ISSUER_REQUEST` - The issuer closed the card for
	// reasons unrelated to fraud or damage, such as account inactivity, product or
	// policy changes, or technology upgrades. _ `NOT_ACTIVE` - The card hasn’t had any
	// transaction activity for a specified period, applicable to statuses like
	// `PAUSED` or `CLOSED`. _ `SUSPICIOUS_ACTIVITY` - The card has one or more
	// suspicious transactions or activities that require review. This can involve
	// prompting the cardholder to confirm legitimate use or report confirmed fraud. _
	// `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
	// review. _ `EXPIRED` - The card has expired and has been closed without being
	// reissued. _ `UNDELIVERABLE` - The card cannot be delivered to the cardholder and
	// has been returned. \* `OTHER` - The reason for the status does not fall into any
	// of the above categories. A comment can be provided to specify the reason.
	Substatus NonPCICardSubstatus `json:"substatus"`
	JSON      nonPCICardJSON      `json:"-"`
}

Card details without PCI information

func (*NonPCICard) UnmarshalJSON added in v0.75.0 

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

type NonPCICardFunding deprecated added in v0.75.0 

type NonPCICardFunding 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 NonPCICardFundingState `json:"state,required"`
	// Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
	// `DEPOSITORY_SAVINGS` - Bank savings account.
	Type NonPCICardFundingType `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     nonPCICardFundingJSON `json:"-"`
}

Deprecated: Funding account for the card.

func (*NonPCICardFunding) UnmarshalJSON added in v0.75.0 

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

type NonPCICardFundingState added in v0.75.0 

type NonPCICardFundingState 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 (
	NonPCICardFundingStateDeleted NonPCICardFundingState = "DELETED"
	NonPCICardFundingStateEnabled NonPCICardFundingState = "ENABLED"
	NonPCICardFundingStatePending NonPCICardFundingState = "PENDING"
)

func (NonPCICardFundingState) IsKnown added in v0.75.0 

func (r NonPCICardFundingState) IsKnown() bool

type NonPCICardFundingType added in v0.75.0 

type NonPCICardFundingType string

Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _ `DEPOSITORY_SAVINGS` - Bank savings account. 

const (
	NonPCICardFundingTypeDepositoryChecking NonPCICardFundingType = "DEPOSITORY_CHECKING"
	NonPCICardFundingTypeDepositorySavings  NonPCICardFundingType = "DEPOSITORY_SAVINGS"
)

func (NonPCICardFundingType) IsKnown added in v0.75.0 

func (r NonPCICardFundingType) IsKnown() bool

type NonPCICardPinStatus added in v0.75.0 

type NonPCICardPinStatus string

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

const (
	NonPCICardPinStatusOk      NonPCICardPinStatus = "OK"
	NonPCICardPinStatusBlocked NonPCICardPinStatus = "BLOCKED"
	NonPCICardPinStatusNotSet  NonPCICardPinStatus = "NOT_SET"
)

func (NonPCICardPinStatus) IsKnown added in v0.75.0 

func (r NonPCICardPinStatus) IsKnown() bool

type NonPCICardState added in v0.75.0 

type NonPCICardState 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 or can be added to mobile wallets. 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 (
	NonPCICardStateClosed             NonPCICardState = "CLOSED"
	NonPCICardStateOpen               NonPCICardState = "OPEN"
	NonPCICardStatePaused             NonPCICardState = "PAUSED"
	NonPCICardStatePendingActivation  NonPCICardState = "PENDING_ACTIVATION"
	NonPCICardStatePendingFulfillment NonPCICardState = "PENDING_FULFILLMENT"
)

func (NonPCICardState) IsKnown added in v0.75.0 

func (r NonPCICardState) IsKnown() bool

type NonPCICardSubstatus added in v0.84.0 

type NonPCICardSubstatus string

Card state substatus values: _ `LOST` - The physical card is no longer in the cardholder's possession due to being lost or never received by the cardholder. _ `COMPROMISED` - Card information has been exposed, potentially leading to unauthorized access. This may involve physical card theft, cloning, or online data breaches. _ `DAMAGED` - The physical card is not functioning properly, such as having chip failures or a demagnetized magnetic stripe. _ `END_USER_REQUEST` - The cardholder requested the closure of the card for reasons unrelated to fraud or damage, such as switching to a different product or closing the account. _ `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud or damage, such as account inactivity, product or policy changes, or technology upgrades. _ `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified period, applicable to statuses like `PAUSED` or `CLOSED`. _ `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or activities that require review. This can involve prompting the cardholder to confirm legitimate use or report confirmed fraud. _ `INTERNAL_REVIEW` - The card is temporarily paused pending further internal review. _ `EXPIRED` - The card has expired and has been closed without being reissued. _ `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been returned. \* `OTHER` - The reason for the status does not fall into any of the above categories. A comment can be provided to specify the reason. 

const (
	NonPCICardSubstatusLost               NonPCICardSubstatus = "LOST"
	NonPCICardSubstatusCompromised        NonPCICardSubstatus = "COMPROMISED"
	NonPCICardSubstatusDamaged            NonPCICardSubstatus = "DAMAGED"
	NonPCICardSubstatusEndUserRequest     NonPCICardSubstatus = "END_USER_REQUEST"
	NonPCICardSubstatusIssuerRequest      NonPCICardSubstatus = "ISSUER_REQUEST"
	NonPCICardSubstatusNotActive          NonPCICardSubstatus = "NOT_ACTIVE"
	NonPCICardSubstatusSuspiciousActivity NonPCICardSubstatus = "SUSPICIOUS_ACTIVITY"
	NonPCICardSubstatusInternalReview     NonPCICardSubstatus = "INTERNAL_REVIEW"
	NonPCICardSubstatusExpired            NonPCICardSubstatus = "EXPIRED"
	NonPCICardSubstatusUndeliverable      NonPCICardSubstatus = "UNDELIVERABLE"
	NonPCICardSubstatusOther              NonPCICardSubstatus = "OTHER"
)

func (NonPCICardSubstatus) IsKnown added in v0.84.0 

func (r NonPCICardSubstatus) IsKnown() bool

type NonPCICardType added in v0.75.0 

type NonPCICardType 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. _ `SINGLE_USE` - Card is closed upon first successful authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _ `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use VIRTUAL instead. 

const (
	NonPCICardTypeMerchantLocked NonPCICardType = "MERCHANT_LOCKED"
	NonPCICardTypePhysical       NonPCICardType = "PHYSICAL"
	NonPCICardTypeSingleUse      NonPCICardType = "SINGLE_USE"
	NonPCICardTypeVirtual        NonPCICardType = "VIRTUAL"
	NonPCICardTypeUnlocked       NonPCICardType = "UNLOCKED"
	NonPCICardTypeDigitalWallet  NonPCICardType = "DIGITAL_WALLET"
)

func (NonPCICardType) IsKnown added in v0.75.0 

func (r NonPCICardType) 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 ParsedWebhookEvent added in v0.98.0 

type ParsedWebhookEvent struct {
	// The token of the account_holder that was created.
	Token string `json:"token" format:"uuid"`
	// The token of the account_holder that the document belongs to
	AccountHolderToken string `json:"account_holder_token" format:"uuid"`
	AccountNumber      string `json:"account_number,nullable"`
	// This field can have the runtime type of [LoanTapeAccountStanding],
	// [StatementAccountStanding].
	AccountStanding interface{} `json:"account_standing"`
	// The token of the account that was created.
	AccountToken string                        `json:"account_token,nullable" format:"uuid"`
	AccountType  ParsedWebhookEventAccountType `json:"account_type,nullable"`
	// Fee (in cents) assessed by the merchant and paid for by the cardholder. 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,nullable"`
	// Unique identifier assigned to a transaction by the acquirer that can be used in
	// dispute and chargeback filing. This field has been deprecated in favor of the
	// `acquirer_reference_number` that resides in the event-level `network_info`.
	//
	// Deprecated: deprecated
	AcquirerReferenceNumber string `json:"acquirer_reference_number,nullable"`
	// This field can have the runtime type of
	// [DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod],
	// [DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod],
	// [TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod],
	// [TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod].
	ActivationMethod interface{} `json:"activation_method"`
	// This field can have the runtime type of [ThreeDSAuthenticationAdditionalData].
	AdditionalData interface{} `json:"additional_data"`
	// Address
	Address ExternalBankAccountAddress `json:"address,nullable"`
	// Authorization amount of the transaction (in cents), including any acquirer fees.
	// The contents of this field are identical to `authorization_amount`.
	Amount int64 `json:"amount"`
	// This field can have the runtime type of [StatementAmountDue].
	AmountDue interface{} `json:"amount_due"`
	// This field can have the runtime type of [TransactionAmounts],
	// [NetworkTotalAmounts].
	Amounts interface{} `json:"amounts"`
	// This field can have the runtime type of [ThreeDSAuthenticationApp].
	App interface{} `json:"app"`
	// Date dispute entered arbitration.
	ArbitrationDate time.Time `json:"arbitration_date,nullable" format:"date-time"`
	// Authentication code to provide to the user tokenizing a card.
	AuthenticationCode string `json:"authentication_code"`
	// Represents a 3DS authentication
	AuthenticationObject ThreeDSAuthentication `json:"authentication_object"`
	// 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 ParsedWebhookEventAuthenticationRequestType `json:"authentication_request_type,nullable"`
	// Indicates the outcome of the 3DS authentication process.
	AuthenticationResult ParsedWebhookEventAuthenticationResult `json:"authentication_result"`
	// The base transaction amount (in cents) plus the acquirer fee field. This is the
	// amount the issuer should authorize against unless the issuer is paying the
	// acquirer fee on behalf of the cardholder.
	AuthorizationAmount int64 `json:"authorization_amount,nullable"`
	// A fixed-width 6-digit numeric identifier that can be used to identify a
	// transaction with networks.
	AuthorizationCode string `json:"authorization_code,nullable"`
	// Amount of credit available to spend in cents
	AvailableCredit int64 `json:"available_credit"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventAvs], [TransactionAvs].
	Avs interface{} `json:"avs"`
	// Auth Rule Backtest Token
	BacktestToken string `json:"backtest_token" format:"uuid"`
	// This field can have the runtime type of [LoanTapeBalances].
	Balances interface{} `json:"balances"`
	// This field can have the runtime type of [ThreeDSAuthenticationBrowser].
	Browser interface{} `json:"browser"`
	// The token of the bulk order associated with this card shipment, if applicable.
	BulkOrderToken string `json:"bulk_order_token,nullable" format:"uuid"`
	// If applicable, represents the business account token associated with the
	// account_holder.
	BusinessAccountToken string `json:"business_account_token,nullable" format:"uuid"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventCard].
	Card interface{} `json:"card"`
	// Indicates whether the expiration date provided by the cardholder during checkout
	// matches Lithic's record of the card's expiration date.
	CardExpiryCheck ParsedWebhookEventCardExpiryCheck `json:"card_expiry_check"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token"`
	// This field can have the runtime type of [ThreeDSAuthenticationCardholder].
	Cardholder               interface{}              `json:"cardholder"`
	CardholderAuthentication CardholderAuthentication `json:"cardholder_authentication,nullable"`
	// 3-character alphabetic ISO 4217 code for cardholder's billing currency.
	CardholderCurrency string `json:"cardholder_currency"`
	// Identifier assigned by the network for this dispute.
	CaseID string `json:"case_id,nullable"`
	// The portion of the transaction requested as cash back by the cardholder, and
	// does not include any acquirer fees. The amount field includes the purchase
	// amount, the requested cash back amount, and any acquirer fees.
	//
	// If no cash back was requested, the value of this field will be 0, and the field
	// will always be present.
	CashAmount int64 `json:"cash_amount"`
	// Deprecated, use `cash_amount`.
	Cashback int64                      `json:"cashback"`
	Category ParsedWebhookEventCategory `json:"category"`
	// This field can have the runtime type of
	// [ThreeDSAuthenticationChallengeWebhookEventChallenge].
	Challenge interface{} `json:"challenge"`
	// This field can have the runtime type of
	// [ThreeDSAuthenticationChallengeMetadata].
	ChallengeMetadata interface{} `json:"challenge_metadata"`
	// Entity that orchestrates the challenge. This won't be set for authentications
	// for which a decision has not yet been made (e.g. in-flight customer decisioning
	// request).
	ChallengeOrchestratedBy ParsedWebhookEventChallengeOrchestratedBy `json:"challenge_orchestrated_by,nullable"`
	// Channel in which the authentication occurs. Maps to EMV 3DS field
	// `deviceChannel`.
	Channel ParsedWebhookEventChannel `json:"channel"`
	// Collection resource type
	CollectionResourceType ParsedWebhookEventCollectionResourceType `json:"collection_resource_type"`
	// This field can have the runtime type of [[]string].
	CollectionTokens interface{} `json:"collection_tokens"`
	// This field can have the runtime type of [EnhancedDataCommon].
	Common interface{} `json:"common"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id,nullable"`
	// If the transaction was requested in a currency other than the settlement
	// currency, this field will be populated to indicate the rate used to translate
	// the merchant_amount to the amount (i.e., `merchant_amount` x `conversion_rate` =
	// `amount`). Note that the `merchant_amount` is in the local currency and the
	// amount is in the settlement currency.
	ConversionRate float64 `json:"conversion_rate"`
	// 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"`
	// When the account_holder was created
	Created time.Time `json:"created" format:"date-time"`
	// This field can have the runtime type of [FinancialAccountCreditConfiguration].
	CreditConfiguration interface{} `json:"credit_configuration"`
	// 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"`
	// Globally unique identifier for a credit product
	CreditProductToken string `json:"credit_product_token"`
	// 3-character alphabetic ISO 4217 code for the settling currency of the
	// transaction
	Currency string `json:"currency"`
	// Date that the dispute was filed by the customer making the dispute.
	CustomerFiledDate time.Time `json:"customer_filed_date,nullable" format:"date-time"`
	// End customer description of the reason for the dispute.
	CustomerNote string `json:"customer_note,nullable"`
	// This field can have the runtime type of
	// [DigitalWalletTokenizationApprovalRequestWebhookEventCustomerTokenizationDecision],
	// [TokenizationApprovalRequestWebhookEventCustomerTokenizationDecision].
	CustomerTokenizationDecision interface{} `json:"customer_tokenization_decision"`
	// The clearing cycle that the network total record applies to. Mastercard only.
	Cycle int64 `json:"cycle"`
	// This field can have the runtime type of [[]FinancialAccountBalance].
	Data interface{} `json:"data"`
	// Date of transactions that this loan tape covers
	Date      time.Time       `json:"date" format:"date"`
	DayTotals StatementTotals `json:"day_totals"`
	// Number of days in the billing cycle
	DaysInBillingCycle int64 `json:"days_in_billing_cycle"`
	// Entity that made the authentication decision. This won't be set for
	// authentications for which a decision has not yet been made (e.g. in-flight
	// customer decisioning request).
	DecisionMadeBy ParsedWebhookEventDecisionMadeBy `json:"decision_made_by,nullable"`
	Descriptor     string                           `json:"descriptor"`
	// This field can have the runtime type of [[]SettlementSummaryDetails].
	Details interface{} `json:"details"`
	Device  Device      `json:"device"`
	// Contains the metadata for the digital wallet being tokenized.
	DigitalWalletTokenMetadata DigitalWalletTokenMetadata  `json:"digital_wallet_token_metadata"`
	Direction                  ParsedWebhookEventDirection `json:"direction"`
	// Dispute resolution outcome
	Disposition ParsedWebhookEventDisposition `json:"disposition,nullable"`
	// Dispute token evidence is attached to.
	DisputeToken string `json:"dispute_token" format:"uuid"`
	// 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`.)
	//
	// Deprecated: deprecated
	DisputesGrossAmount int64 `json:"disputes_gross_amount"`
	// Date of Birth of the Individual that owns the external bank account
	Dob time.Time `json:"dob,nullable" format:"date"`
	// Type of documentation to be submitted for verification of an account holder
	DocumentType ParsedWebhookEventDocumentType `json:"document_type"`
	// Doing Business As
	DoingBusinessAs string `json:"doing_business_as,nullable"`
	// URL to download evidence. Only shown when `upload_status` is `UPLOADED`.
	DownloadURL string `json:"download_url"`
	// If updated, the newly updated email associated with the account_holder otherwise
	// the existing email is provided.
	Email string `json:"email"`
	// Balance at the end of the day
	EndingBalance int64 `json:"ending_balance"`
	// The token of the entity that the document belongs to
	EntityToken string `json:"entity_token" format:"uuid"`
	// The event token associated with the authorization. This field is only set for
	// programs enrolled into the beta.
	EventToken string `json:"event_token" format:"uuid"`
	// The type of event that occurred.
	EventType ParsedWebhookEventEventType `json:"event_type"`
	// This field can have the runtime type of [[]BookTransferResponseEvent],
	// [[]TransactionEvent], [[]ExternalPaymentEvent],
	// [[]ManagementOperationTransactionEvent], [[]InternalTransactionEvent],
	// [[]PaymentEvent], [[]DisputeV2Event].
	Events interface{} `json:"events"`
	// 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"`
	// The new expiration month of the card.
	ExpMonth string `json:"exp_month"`
	// The new expiration year of the card.
	ExpYear string `json:"exp_year"`
	// Expected release date for the transaction
	ExpectedReleaseDate time.Time `json:"expected_release_date,nullable" format:"date"`
	// External bank account token
	ExternalBankAccountToken string `json:"external_bank_account_token,nullable" format:"uuid"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string `json:"external_id,nullable"`
	// External resource associated with the management operation
	ExternalResource ExternalResource `json:"external_resource,nullable"`
	// TRANSFER - Book Transfer Transaction
	Family ParsedWebhookEventFamily `json:"family"`
	// File name of evidence. Recommended to give the dispute evidence a human-readable
	// identifier.
	Filename              string `json:"filename"`
	FinancialAccountToken string `json:"financial_account_token,nullable" format:"uuid"`
	// If applicable, represents the account_holder's first name.
	FirstName string `json:"first_name"`
	// This field can have the runtime type of [[]EnhancedDataFleet].
	Fleet interface{} `json:"fleet"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventFleetInfo].
	FleetInfo interface{} `json:"fleet_info"`
	// 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" format:"uuid"`
	// Time of the high watermark
	HighWatermark time.Time `json:"high_watermark" format:"date-time"`
	// The institution that activity occurred on. For Mastercard: ICA (Interbank Card
	// Association). For Maestro: institution ID. For Visa: lowest level SRE
	// (Settlement Reporting Entity).
	InstitutionID string `json:"institution_id"`
	// 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`.)
	//
	// Deprecated: deprecated
	InterchangeGrossAmount int64 `json:"interchange_gross_amount"`
	// This field can have the runtime type of [LoanTapeInterestDetails],
	// [StatementInterestDetails].
	InterestDetails interface{} `json:"interest_details"`
	// Indicates that all settlement records related to this Network Total are
	// available in the details endpoint.
	IsComplete bool `json:"is_complete"`
	// Whether financial account is for the benefit of another entity
	IsForBenefitOf bool `json:"is_for_benefit_of"`
	// Whether Lithic decisioned on the token, and if so, what the decision was.
	// APPROVED/VERIFICATION_REQUIRED/DENIED.
	IssuerDecision ParsedWebhookEventIssuerDecision `json:"issuer_decision"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four"`
	// If applicable, represents the account_holder's last name.
	LastName string `json:"last_name"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventLatestChallenge].
	LatestChallenge interface{} `json:"latest_challenge"`
	// If applicable, represents the account_holder's business name.
	LegalBusinessName string `json:"legal_business_name"`
	// This field can have the runtime type of [DisputeV2LiabilityAllocation].
	LiabilityAllocation interface{} `json:"liability_allocation"`
	// This field can have the runtime type of [shared.Merchant],
	// [ThreeDSAuthenticationMerchant].
	Merchant interface{} `json:"merchant"`
	// The amount that the merchant will receive, denominated in `merchant_currency`
	// and in the smallest currency unit. Note the amount includes `acquirer_fee`,
	// similar to `authorization_amount`. It will be different from
	// `authorization_amount` if the merchant is taking payment in a different
	// currency.
	MerchantAmount int64 `json:"merchant_amount,nullable"`
	// Analogous to the 'authorization_amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,nullable"`
	// 3-character alphabetic ISO 4217 code for the local currency of the transaction.
	MerchantCurrency string `json:"merchant_currency"`
	// Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
	// NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
	// populated.
	MessageCategory ParsedWebhookEventMessageCategory `json:"message_category"`
	// Transfer method
	Method ParsedWebhookEventMethod `json:"method"`
	// This field can have the runtime type of [PaymentMethodAttributes].
	MethodAttributes interface{} `json:"method_attributes"`
	// This field can have the runtime type of [LoanTapeMinimumPaymentBalance].
	MinimumPaymentBalance interface{} `json:"minimum_payment_balance"`
	// The nickname for this External Bank Account
	Name string `json:"name,nullable"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness string `json:"nature_of_business"`
	// Card network of the authorization.
	Network ParsedWebhookEventNetwork `json:"network,nullable"`
	// This field can have the runtime type of [[]string].
	NetworkClaimIDs interface{} `json:"network_claim_ids"`
	// Date that the dispute was submitted to the network.
	NetworkFiledDate time.Time `json:"network_filed_date,nullable" format:"date-time"`
	// Network reason code used to file the dispute.
	NetworkReasonCode string `json:"network_reason_code,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,nullable"`
	// This field can have the runtime type of
	// [[]FundingEventNetworkSettlementSummary].
	NetworkSettlementSummary interface{} `json:"network_settlement_summary"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventNetworkSpecificData].
	NetworkSpecificData interface{} `json:"network_specific_data"`
	// 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"`
	Nickname             string    `json:"nickname,nullable"`
	// 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`.)
	//
	// Deprecated: deprecated
	OtherFeesGrossAmount int64 `json:"other_fees_gross_amount"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner string `json:"owner"`
	// Owner Type
	OwnerType OwnerType `json:"owner_type"`
	// This field can have the runtime type of [LoanTapePaymentAllocation].
	PaymentAllocation interface{} `json:"payment_allocation"`
	// Date when the payment is due
	PaymentDueDate time.Time                     `json:"payment_due_date,nullable" format:"date"`
	PaymentType    ParsedWebhookEventPaymentType `json:"payment_type"`
	// This field can have the runtime type of [StatementPayoffDetails].
	PayoffDetails interface{} `json:"payoff_details"`
	// 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"`
	PeriodTotals  StatementTotals `json:"period_totals"`
	// If updated, the newly updated phone_number associated with the account_holder
	// otherwise the existing phone_number is provided.
	PhoneNumber string `json:"phone_number"`
	// This field can have the runtime type of
	// [CardAuthorizationApprovalRequestWebhookEventPos], [TransactionPos].
	Pos interface{} `json:"pos"`
	// Date dispute entered pre-arbitration.
	PrearbitrationDate time.Time `json:"prearbitration_date,nullable" format:"date-time"`
	// The previous expiration month of the card.
	PreviousExpMonth string `json:"previous_exp_month"`
	// The previous expiration year of the card.
	PreviousExpYear string `json:"previous_exp_year"`
	// Time of the previous high watermark
	PreviousHighWatermark time.Time `json:"previous_high_watermark" format:"date-time"`
	// This field can have the runtime type of [LoanTapePreviousStatementBalance].
	PreviousStatementBalance interface{} `json:"previous_statement_balance"`
	// 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,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 ParsedWebhookEventReason `json:"reason"`
	// This field can have the runtime type of [PaymentRelatedAccountTokens].
	RelatedAccountTokens interface{} `json:"related_account_tokens"`
	// The token of the card that was replaced, if the new card is a replacement card.
	ReplacementFor string `json:"replacement_for,nullable" format:"uuid"`
	// This field can have the runtime type of [time.Time], [string].
	ReportDate interface{} `json:"report_date"`
	// Date the representment was received.
	RepresentmentDate time.Time `json:"representment_date,nullable" format:"date-time"`
	// This field can have the runtime type of
	// [[]AccountHolderDocumentUpdatedWebhookEventRequiredDocumentUpload].
	RequiredDocumentUploads interface{} `json:"required_document_uploads"`
	// This field can have the runtime type of [[]RequiredDocument].
	RequiredDocuments interface{} `json:"required_documents"`
	// Date that the dispute was resolved.
	ResolutionDate time.Time `json:"resolution_date,nullable" format:"date-time"`
	// Note by Dispute team on the case resolution.
	ResolutionNote string `json:"resolution_note,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 ParsedWebhookEventResolutionReason `json:"resolution_reason,nullable"`
	Result           ParsedWebhookEventResult           `json:"result"`
	// This field can have the runtime type of [BacktestResultsResults].
	Results interface{} `json:"results"`
	// Routing Number
	RoutingNumber string `json:"routing_number,nullable"`
	// This field can have the runtime type of [[]TokenizationRuleResult].
	RuleResults interface{} `json:"rule_results"`
	// Amount (in cents) of the transaction that has been settled, including any
	// acquirer fees
	SettledAmount int64 `json:"settled_amount"`
	// 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`.)
	//
	// Deprecated: deprecated
	SettledNetAmount int64 `json:"settled_net_amount"`
	// The institution responsible for settlement. For Mastercard: same as
	// `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
	// (FTSRE).
	SettlementInstitutionID string `json:"settlement_institution_id"`
	// Settlement service.
	SettlementService string `json:"settlement_service"`
	// The specific shipping method used to ship the card.
	ShippingMethod ParsedWebhookEventShippingMethod `json:"shipping_method"`
	// This field can have the runtime type of [BacktestResultsSimulationParameters].
	SimulationParameters interface{} `json:"simulation_parameters"`
	// Transaction source
	Source ParsedWebhookEventSource `json:"source"`
	// Balance at the start of the day
	StartingBalance int64 `json:"starting_balance"`
	// Account State
	State ParsedWebhookEventState `json:"state"`
	// Date when the billing period ended
	StatementEndDate time.Time `json:"statement_end_date" format:"date"`
	// Date when the billing period began
	StatementStartDate time.Time                       `json:"statement_start_date" format:"date"`
	StatementType      ParsedWebhookEventStatementType `json:"statement_type"`
	// The status of the account_holder that was created.
	Status ParsedWebhookEventStatus `json:"status,nullable"`
	// This field can have the runtime type of [[]string].
	StatusReason interface{} `json:"status_reason"`
	// This field can have the runtime type of [[]string].
	StatusReasons interface{} `json:"status_reasons"`
	// Substatus for the financial account
	Substatus ParsedWebhookEventSubstatus `json:"substatus,nullable"`
	// Indicates whether a challenge is requested for this transaction
	//
	//   - `NO_PREFERENCE` - No Preference
	//   - `NO_CHALLENGE_REQUESTED` - No Challenge Requested
	//   - `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
	//   - `CHALLENGE_MANDATE` - Challenge requested (Mandate)
	//   - `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional
	//     risk analysis is already performed)
	//   - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
	//   - `OTHER` - Other indicators not captured by above. These are rarely used
	ThreeDSRequestorChallengeIndicator ParsedWebhookEventThreeDSRequestorChallengeIndicator `json:"three_ds_requestor_challenge_indicator"`
	// 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 ParsedWebhookEventThreeRiRequestType `json:"three_ri_request_type,nullable"`
	// Interest tier to which this account belongs to
	Tier string `json:"tier,nullable"`
	// Globally unique identifier for the financial account or card that will receive
	// the funds. Accepted type dependent on the program's use case
	ToFinancialAccountToken string       `json:"to_financial_account_token" format:"uuid"`
	TokenInfo               TokenInfo    `json:"token_info,nullable"`
	Tokenization            Tokenization `json:"tokenization"`
	// The channel through which the tokenization was made.
	TokenizationChannel ParsedWebhookEventTokenizationChannel `json:"tokenization_channel"`
	// This field can have the runtime type of [[]TokenizationDeclineReason].
	TokenizationDeclineReasons interface{} `json:"tokenization_decline_reasons"`
	// This field can have the runtime type of
	// [DigitalWalletTokenizationResultWebhookEventTokenizationResultDetails],
	// [TokenizationResultWebhookEventTokenizationResultDetails].
	TokenizationResultDetails interface{} `json:"tokenization_result_details"`
	// The source of the tokenization.
	TokenizationSource ParsedWebhookEventTokenizationSource `json:"tokenization_source"`
	// This field can have the runtime type of [[]TokenizationTfaReason].
	TokenizationTfaReasons interface{} `json:"tokenization_tfa_reasons"`
	// Unique identifier for the digital wallet token attempt
	TokenizationToken string `json:"tokenization_token"`
	// The tracking number of the shipment.
	TrackingNumber string `json:"tracking_number,nullable"`
	// This field can have the runtime type of [ThreeDSAuthenticationTransaction].
	Transaction interface{} `json:"transaction"`
	// The entity that initiated the transaction.
	TransactionInitiator ParsedWebhookEventTransactionInitiator `json:"transaction_initiator"`
	// This field can have the runtime type of [BookTransferResponseTransactionSeries],
	// [ManagementOperationTransactionTransactionSeries], [DisputeV2TransactionSeries].
	TransactionSeries interface{} `json:"transaction_series"`
	// The token of the transaction that the enhanced data is associated with.
	TransactionToken string `json:"transaction_token" format:"uuid"`
	// 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`.)
	//
	// Deprecated: deprecated
	TransactionsGrossAmount int64 `json:"transactions_gross_amount"`
	// Deprecated: approximate time-to-live for the authorization.
	Ttl time.Time `json:"ttl" format:"date-time"`
	// Account Type
	Type ParsedWebhookEventType `json:"type"`
	// This field can have the runtime type of
	// [ParsedWebhookEventKYBPayloadUpdateRequest],
	// [ParsedWebhookEventKYCPayloadUpdateRequest].
	UpdateRequest interface{} `json:"update_request"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time `json:"updated" format:"date-time"`
	// 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 ParsedWebhookEventUploadStatus `json:"upload_status"`
	// URL to upload evidence. Only shown when `upload_status` is `PENDING`.
	UploadURL string `json:"upload_url"`
	// User Defined ID
	UserDefinedID string `json:"user_defined_id,nullable"`
	// User-defined status for the financial account
	UserDefinedStatus string `json:"user_defined_status,nullable"`
	// The number of attempts at verification
	VerificationAttempts int64 `json:"verification_attempts"`
	// 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,nullable"`
	// Verification Method
	VerificationMethod VerificationMethod `json:"verification_method"`
	// Verification State
	VerificationState ParsedWebhookEventVerificationState `json:"verification_state"`
	// Version number of the loan tape. This starts at 1
	Version               int64                 `json:"version"`
	WalletDecisioningInfo WalletDecisioningInfo `json:"wallet_decisioning_info"`
	// Company website URL.
	WebsiteURL string                 `json:"website_url"`
	YtdTotals  StatementTotals        `json:"ytd_totals"`
	JSON       parsedWebhookEventJSON `json:"-"`
	// contains filtered or unexported fields
}

KYB payload for an updated account holder.

func (ParsedWebhookEvent) AsUnion added in v0.98.0 

func (r ParsedWebhookEvent) AsUnion() ParsedWebhookEventUnion

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

Possible runtime types of the union are AccountHolderCreatedWebhookEvent, ParsedWebhookEventKYBPayload, ParsedWebhookEventKYCPayload, ParsedWebhookEventLegacyPayload, AccountHolderVerificationWebhookEvent, AccountHolderDocumentUpdatedWebhookEvent, CardAuthorizationApprovalRequestWebhookEvent, TokenizationDecisioningRequestWebhookEvent, AuthRulesBacktestReportCreatedWebhookEvent, BalanceUpdatedWebhookEvent, BookTransferTransactionCreatedWebhookEvent, BookTransferTransactionUpdatedWebhookEvent, CardCreatedWebhookEvent, CardConvertedWebhookEvent, CardRenewedWebhookEvent, CardReissuedWebhookEvent, CardShippedWebhookEvent, CardTransactionUpdatedWebhookEvent, CardTransactionEnhancedDataCreatedWebhookEvent, CardTransactionEnhancedDataUpdatedWebhookEvent, DigitalWalletTokenizationApprovalRequestWebhookEvent, DigitalWalletTokenizationResultWebhookEvent, DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, DigitalWalletTokenizationUpdatedWebhookEvent, DisputeUpdatedWebhookEvent, DisputeEvidenceUploadFailedWebhookEvent, ExternalBankAccountCreatedWebhookEvent, ExternalBankAccountUpdatedWebhookEvent, ExternalPaymentCreatedWebhookEvent, ExternalPaymentUpdatedWebhookEvent, FinancialAccountCreatedWebhookEvent, FinancialAccountUpdatedWebhookEvent, FundingEventCreatedWebhookEvent, LoanTapeCreatedWebhookEvent, LoanTapeUpdatedWebhookEvent, ManagementOperationCreatedWebhookEvent, ManagementOperationUpdatedWebhookEvent, InternalTransactionCreatedWebhookEvent, InternalTransactionUpdatedWebhookEvent, NetworkTotalCreatedWebhookEvent, NetworkTotalUpdatedWebhookEvent, PaymentTransactionCreatedWebhookEvent, PaymentTransactionUpdatedWebhookEvent, SettlementReportUpdatedWebhookEvent, StatementsCreatedWebhookEvent, ThreeDSAuthenticationCreatedWebhookEvent, ThreeDSAuthenticationUpdatedWebhookEvent, ThreeDSAuthenticationChallengeWebhookEvent, TokenizationApprovalRequestWebhookEvent, TokenizationResultWebhookEvent, TokenizationTwoFactorAuthenticationCodeWebhookEvent, TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, TokenizationUpdatedWebhookEvent, ThreeDSAuthenticationApprovalRequestWebhookEvent, DisputeTransactionCreatedWebhookEvent, DisputeTransactionUpdatedWebhookEvent.

func (*ParsedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventAccountType added in v0.98.0 

type ParsedWebhookEventAccountType string
const (
	ParsedWebhookEventAccountTypeChecking      ParsedWebhookEventAccountType = "CHECKING"
	ParsedWebhookEventAccountTypeSavings       ParsedWebhookEventAccountType = "SAVINGS"
	ParsedWebhookEventAccountTypeCredit        ParsedWebhookEventAccountType = "CREDIT"
	ParsedWebhookEventAccountTypeDebit         ParsedWebhookEventAccountType = "DEBIT"
	ParsedWebhookEventAccountTypeNotApplicable ParsedWebhookEventAccountType = "NOT_APPLICABLE"
)

func (ParsedWebhookEventAccountType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventAccountType) IsKnown() bool

type ParsedWebhookEventAuthenticationRequestType added in v0.98.0 

type ParsedWebhookEventAuthenticationRequestType 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 (
	ParsedWebhookEventAuthenticationRequestTypeAddCard                        ParsedWebhookEventAuthenticationRequestType = "ADD_CARD"
	ParsedWebhookEventAuthenticationRequestTypeBillingAgreement               ParsedWebhookEventAuthenticationRequestType = "BILLING_AGREEMENT"
	ParsedWebhookEventAuthenticationRequestTypeDelayedShipment                ParsedWebhookEventAuthenticationRequestType = "DELAYED_SHIPMENT"
	ParsedWebhookEventAuthenticationRequestTypeEmvTokenCardholderVerification ParsedWebhookEventAuthenticationRequestType = "EMV_TOKEN_CARDHOLDER_VERIFICATION"
	ParsedWebhookEventAuthenticationRequestTypeInstallmentTransaction         ParsedWebhookEventAuthenticationRequestType = "INSTALLMENT_TRANSACTION"
	ParsedWebhookEventAuthenticationRequestTypeMaintainCard                   ParsedWebhookEventAuthenticationRequestType = "MAINTAIN_CARD"
	ParsedWebhookEventAuthenticationRequestTypePaymentTransaction             ParsedWebhookEventAuthenticationRequestType = "PAYMENT_TRANSACTION"
	ParsedWebhookEventAuthenticationRequestTypeRecurringTransaction           ParsedWebhookEventAuthenticationRequestType = "RECURRING_TRANSACTION"
	ParsedWebhookEventAuthenticationRequestTypeSplitPayment                   ParsedWebhookEventAuthenticationRequestType = "SPLIT_PAYMENT"
	ParsedWebhookEventAuthenticationRequestTypeSplitShipment                  ParsedWebhookEventAuthenticationRequestType = "SPLIT_SHIPMENT"
)

func (ParsedWebhookEventAuthenticationRequestType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventAuthenticationRequestType) IsKnown() bool

type ParsedWebhookEventAuthenticationResult added in v0.98.0 

type ParsedWebhookEventAuthenticationResult string

Indicates the outcome of the 3DS authentication process. 

const (
	ParsedWebhookEventAuthenticationResultDecline          ParsedWebhookEventAuthenticationResult = "DECLINE"
	ParsedWebhookEventAuthenticationResultSuccess          ParsedWebhookEventAuthenticationResult = "SUCCESS"
	ParsedWebhookEventAuthenticationResultPendingChallenge ParsedWebhookEventAuthenticationResult = "PENDING_CHALLENGE"
	ParsedWebhookEventAuthenticationResultPendingDecision  ParsedWebhookEventAuthenticationResult = "PENDING_DECISION"
)

func (ParsedWebhookEventAuthenticationResult) IsKnown added in v0.98.0 

func (r ParsedWebhookEventAuthenticationResult) IsKnown() bool

type ParsedWebhookEventCardExpiryCheck added in v0.98.0 

type ParsedWebhookEventCardExpiryCheck string

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. 

const (
	ParsedWebhookEventCardExpiryCheckMatch      ParsedWebhookEventCardExpiryCheck = "MATCH"
	ParsedWebhookEventCardExpiryCheckMismatch   ParsedWebhookEventCardExpiryCheck = "MISMATCH"
	ParsedWebhookEventCardExpiryCheckNotPresent ParsedWebhookEventCardExpiryCheck = "NOT_PRESENT"
)

func (ParsedWebhookEventCardExpiryCheck) IsKnown added in v0.98.0 

func (r ParsedWebhookEventCardExpiryCheck) IsKnown() bool

type ParsedWebhookEventCategory added in v0.98.0 

type ParsedWebhookEventCategory string
const (
	ParsedWebhookEventCategoryAdjustment             ParsedWebhookEventCategory = "ADJUSTMENT"
	ParsedWebhookEventCategoryBalanceOrFunding       ParsedWebhookEventCategory = "BALANCE_OR_FUNDING"
	ParsedWebhookEventCategoryDerecognition          ParsedWebhookEventCategory = "DERECOGNITION"
	ParsedWebhookEventCategoryDispute                ParsedWebhookEventCategory = "DISPUTE"
	ParsedWebhookEventCategoryFee                    ParsedWebhookEventCategory = "FEE"
	ParsedWebhookEventCategoryInternal               ParsedWebhookEventCategory = "INTERNAL"
	ParsedWebhookEventCategoryReward                 ParsedWebhookEventCategory = "REWARD"
	ParsedWebhookEventCategoryProgramFunding         ParsedWebhookEventCategory = "PROGRAM_FUNDING"
	ParsedWebhookEventCategoryTransfer               ParsedWebhookEventCategory = "TRANSFER"
	ParsedWebhookEventCategoryExternalWire           ParsedWebhookEventCategory = "EXTERNAL_WIRE"
	ParsedWebhookEventCategoryExternalACH            ParsedWebhookEventCategory = "EXTERNAL_ACH"
	ParsedWebhookEventCategoryExternalCheck          ParsedWebhookEventCategory = "EXTERNAL_CHECK"
	ParsedWebhookEventCategoryExternalFednow         ParsedWebhookEventCategory = "EXTERNAL_FEDNOW"
	ParsedWebhookEventCategoryExternalRtp            ParsedWebhookEventCategory = "EXTERNAL_RTP"
	ParsedWebhookEventCategoryExternalTransfer       ParsedWebhookEventCategory = "EXTERNAL_TRANSFER"
	ParsedWebhookEventCategoryManagementFee          ParsedWebhookEventCategory = "MANAGEMENT_FEE"
	ParsedWebhookEventCategoryManagementDispute      ParsedWebhookEventCategory = "MANAGEMENT_DISPUTE"
	ParsedWebhookEventCategoryManagementReward       ParsedWebhookEventCategory = "MANAGEMENT_REWARD"
	ParsedWebhookEventCategoryManagementAdjustment   ParsedWebhookEventCategory = "MANAGEMENT_ADJUSTMENT"
	ParsedWebhookEventCategoryManagementDisbursement ParsedWebhookEventCategory = "MANAGEMENT_DISBURSEMENT"
	ParsedWebhookEventCategoryACH                    ParsedWebhookEventCategory = "ACH"
	ParsedWebhookEventCategoryCard                   ParsedWebhookEventCategory = "CARD"
)

func (ParsedWebhookEventCategory) IsKnown added in v0.98.0 

func (r ParsedWebhookEventCategory) IsKnown() bool

type ParsedWebhookEventChallengeOrchestratedBy added in v0.98.0 

type ParsedWebhookEventChallengeOrchestratedBy string

Entity that orchestrates the challenge. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request). 

const (
	ParsedWebhookEventChallengeOrchestratedByLithic      ParsedWebhookEventChallengeOrchestratedBy = "LITHIC"
	ParsedWebhookEventChallengeOrchestratedByCustomer    ParsedWebhookEventChallengeOrchestratedBy = "CUSTOMER"
	ParsedWebhookEventChallengeOrchestratedByNoChallenge ParsedWebhookEventChallengeOrchestratedBy = "NO_CHALLENGE"
)

func (ParsedWebhookEventChallengeOrchestratedBy) IsKnown added in v0.98.0 

func (r ParsedWebhookEventChallengeOrchestratedBy) IsKnown() bool

type ParsedWebhookEventChannel added in v0.98.0 

type ParsedWebhookEventChannel string

Channel in which the authentication occurs. Maps to EMV 3DS field `deviceChannel`. 

const (
	ParsedWebhookEventChannelAppBased                  ParsedWebhookEventChannel = "APP_BASED"
	ParsedWebhookEventChannelBrowser                   ParsedWebhookEventChannel = "BROWSER"
	ParsedWebhookEventChannelThreeDSRequestorInitiated ParsedWebhookEventChannel = "THREE_DS_REQUESTOR_INITIATED"
)

func (ParsedWebhookEventChannel) IsKnown added in v0.98.0 

func (r ParsedWebhookEventChannel) IsKnown() bool

type ParsedWebhookEventCollectionResourceType added in v0.98.0 

type ParsedWebhookEventCollectionResourceType string

Collection resource type 

const (
	ParsedWebhookEventCollectionResourceTypeBookTransfer ParsedWebhookEventCollectionResourceType = "BOOK_TRANSFER"
	ParsedWebhookEventCollectionResourceTypePayment      ParsedWebhookEventCollectionResourceType = "PAYMENT"
)

func (ParsedWebhookEventCollectionResourceType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventCollectionResourceType) IsKnown() bool

type ParsedWebhookEventDecisionMadeBy added in v0.98.0 

type ParsedWebhookEventDecisionMadeBy string

Entity that made the authentication decision. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request). 

const (
	ParsedWebhookEventDecisionMadeByLithicRules      ParsedWebhookEventDecisionMadeBy = "LITHIC_RULES"
	ParsedWebhookEventDecisionMadeByLithicDefault    ParsedWebhookEventDecisionMadeBy = "LITHIC_DEFAULT"
	ParsedWebhookEventDecisionMadeByCustomerRules    ParsedWebhookEventDecisionMadeBy = "CUSTOMER_RULES"
	ParsedWebhookEventDecisionMadeByCustomerEndpoint ParsedWebhookEventDecisionMadeBy = "CUSTOMER_ENDPOINT"
	ParsedWebhookEventDecisionMadeByNetwork          ParsedWebhookEventDecisionMadeBy = "NETWORK"
	ParsedWebhookEventDecisionMadeByUnknown          ParsedWebhookEventDecisionMadeBy = "UNKNOWN"
)

func (ParsedWebhookEventDecisionMadeBy) IsKnown added in v0.98.0 

func (r ParsedWebhookEventDecisionMadeBy) IsKnown() bool

type ParsedWebhookEventDirection added in v0.98.0 

type ParsedWebhookEventDirection string
const (
	ParsedWebhookEventDirectionCredit ParsedWebhookEventDirection = "CREDIT"
	ParsedWebhookEventDirectionDebit  ParsedWebhookEventDirection = "DEBIT"
)

func (ParsedWebhookEventDirection) IsKnown added in v0.98.0 

func (r ParsedWebhookEventDirection) IsKnown() bool

type ParsedWebhookEventDisposition added in v0.98.0 

type ParsedWebhookEventDisposition string

Dispute resolution outcome 

const (
	ParsedWebhookEventDispositionWon          ParsedWebhookEventDisposition = "WON"
	ParsedWebhookEventDispositionLost         ParsedWebhookEventDisposition = "LOST"
	ParsedWebhookEventDispositionPartiallyWon ParsedWebhookEventDisposition = "PARTIALLY_WON"
	ParsedWebhookEventDispositionWithdrawn    ParsedWebhookEventDisposition = "WITHDRAWN"
	ParsedWebhookEventDispositionDenied       ParsedWebhookEventDisposition = "DENIED"
)

func (ParsedWebhookEventDisposition) IsKnown added in v0.98.0 

func (r ParsedWebhookEventDisposition) IsKnown() bool

type ParsedWebhookEventDocumentType added in v0.98.0 

type ParsedWebhookEventDocumentType string

Type of documentation to be submitted for verification of an account holder 

const (
	ParsedWebhookEventDocumentTypeDriversLicense            ParsedWebhookEventDocumentType = "DRIVERS_LICENSE"
	ParsedWebhookEventDocumentTypePassport                  ParsedWebhookEventDocumentType = "PASSPORT"
	ParsedWebhookEventDocumentTypePassportCard              ParsedWebhookEventDocumentType = "PASSPORT_CARD"
	ParsedWebhookEventDocumentTypeEinLetter                 ParsedWebhookEventDocumentType = "EIN_LETTER"
	ParsedWebhookEventDocumentTypeTaxReturn                 ParsedWebhookEventDocumentType = "TAX_RETURN"
	ParsedWebhookEventDocumentTypeOperatingAgreement        ParsedWebhookEventDocumentType = "OPERATING_AGREEMENT"
	ParsedWebhookEventDocumentTypeCertificateOfFormation    ParsedWebhookEventDocumentType = "CERTIFICATE_OF_FORMATION"
	ParsedWebhookEventDocumentTypeCertificateOfGoodStanding ParsedWebhookEventDocumentType = "CERTIFICATE_OF_GOOD_STANDING"
	ParsedWebhookEventDocumentTypeArticlesOfIncorporation   ParsedWebhookEventDocumentType = "ARTICLES_OF_INCORPORATION"
	ParsedWebhookEventDocumentTypeArticlesOfOrganization    ParsedWebhookEventDocumentType = "ARTICLES_OF_ORGANIZATION"
	ParsedWebhookEventDocumentTypeBylaws                    ParsedWebhookEventDocumentType = "BYLAWS"
	ParsedWebhookEventDocumentTypeGovernmentBusinessLicense ParsedWebhookEventDocumentType = "GOVERNMENT_BUSINESS_LICENSE"
	ParsedWebhookEventDocumentTypePartnershipAgreement      ParsedWebhookEventDocumentType = "PARTNERSHIP_AGREEMENT"
	ParsedWebhookEventDocumentTypeSs4Form                   ParsedWebhookEventDocumentType = "SS4_FORM"
	ParsedWebhookEventDocumentTypeBankStatement             ParsedWebhookEventDocumentType = "BANK_STATEMENT"
	ParsedWebhookEventDocumentTypeUtilityBillStatement      ParsedWebhookEventDocumentType = "UTILITY_BILL_STATEMENT"
	ParsedWebhookEventDocumentTypeSsnCard                   ParsedWebhookEventDocumentType = "SSN_CARD"
	ParsedWebhookEventDocumentTypeItinLetter                ParsedWebhookEventDocumentType = "ITIN_LETTER"
	ParsedWebhookEventDocumentTypeFincenBoiReport           ParsedWebhookEventDocumentType = "FINCEN_BOI_REPORT"
)

func (ParsedWebhookEventDocumentType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventDocumentType) IsKnown() bool

type ParsedWebhookEventEventType added in v0.98.0 

type ParsedWebhookEventEventType string

The type of event that occurred. 

const (
	ParsedWebhookEventEventTypeAccountHolderCreated                                     ParsedWebhookEventEventType = "account_holder.created"
	ParsedWebhookEventEventTypeAccountHolderUpdated                                     ParsedWebhookEventEventType = "account_holder.updated"
	ParsedWebhookEventEventTypeAccountHolderVerification                                ParsedWebhookEventEventType = "account_holder.verification"
	ParsedWebhookEventEventTypeAccountHolderDocumentUpdated                             ParsedWebhookEventEventType = "account_holder_document.updated"
	ParsedWebhookEventEventTypeCardAuthorizationApprovalRequest                         ParsedWebhookEventEventType = "card_authorization.approval_request"
	ParsedWebhookEventEventTypeDigitalWalletTokenizationApprovalRequest                 ParsedWebhookEventEventType = "digital_wallet.tokenization_approval_request"
	ParsedWebhookEventEventTypeAuthRulesBacktestReportCreated                           ParsedWebhookEventEventType = "auth_rules.backtest_report.created"
	ParsedWebhookEventEventTypeBalanceUpdated                                           ParsedWebhookEventEventType = "balance.updated"
	ParsedWebhookEventEventTypeBookTransferTransactionCreated                           ParsedWebhookEventEventType = "book_transfer_transaction.created"
	ParsedWebhookEventEventTypeBookTransferTransactionUpdated                           ParsedWebhookEventEventType = "book_transfer_transaction.updated"
	ParsedWebhookEventEventTypeCardCreated                                              ParsedWebhookEventEventType = "card.created"
	ParsedWebhookEventEventTypeCardConverted                                            ParsedWebhookEventEventType = "card.converted"
	ParsedWebhookEventEventTypeCardRenewed                                              ParsedWebhookEventEventType = "card.renewed"
	ParsedWebhookEventEventTypeCardReissued                                             ParsedWebhookEventEventType = "card.reissued"
	ParsedWebhookEventEventTypeCardShipped                                              ParsedWebhookEventEventType = "card.shipped"
	ParsedWebhookEventEventTypeCardTransactionUpdated                                   ParsedWebhookEventEventType = "card_transaction.updated"
	ParsedWebhookEventEventTypeCardTransactionEnhancedDataCreated                       ParsedWebhookEventEventType = "card_transaction.enhanced_data.created"
	ParsedWebhookEventEventTypeCardTransactionEnhancedDataUpdated                       ParsedWebhookEventEventType = "card_transaction.enhanced_data.updated"
	ParsedWebhookEventEventTypeDigitalWalletTokenizationResult                          ParsedWebhookEventEventType = "digital_wallet.tokenization_result"
	ParsedWebhookEventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode     ParsedWebhookEventEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	ParsedWebhookEventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCodeSent ParsedWebhookEventEventType = "digital_wallet.tokenization_two_factor_authentication_code_sent"
	ParsedWebhookEventEventTypeDigitalWalletTokenizationUpdated                         ParsedWebhookEventEventType = "digital_wallet.tokenization_updated"
	ParsedWebhookEventEventTypeDisputeUpdated                                           ParsedWebhookEventEventType = "dispute.updated"
	ParsedWebhookEventEventTypeDisputeEvidenceUploadFailed                              ParsedWebhookEventEventType = "dispute_evidence.upload_failed"
	ParsedWebhookEventEventTypeExternalBankAccountCreated                               ParsedWebhookEventEventType = "external_bank_account.created"
	ParsedWebhookEventEventTypeExternalBankAccountUpdated                               ParsedWebhookEventEventType = "external_bank_account.updated"
	ParsedWebhookEventEventTypeExternalPaymentCreated                                   ParsedWebhookEventEventType = "external_payment.created"
	ParsedWebhookEventEventTypeExternalPaymentUpdated                                   ParsedWebhookEventEventType = "external_payment.updated"
	ParsedWebhookEventEventTypeFinancialAccountCreated                                  ParsedWebhookEventEventType = "financial_account.created"
	ParsedWebhookEventEventTypeFinancialAccountUpdated                                  ParsedWebhookEventEventType = "financial_account.updated"
	ParsedWebhookEventEventTypeFundingEventCreated                                      ParsedWebhookEventEventType = "funding_event.created"
	ParsedWebhookEventEventTypeLoanTapeCreated                                          ParsedWebhookEventEventType = "loan_tape.created"
	ParsedWebhookEventEventTypeLoanTapeUpdated                                          ParsedWebhookEventEventType = "loan_tape.updated"
	ParsedWebhookEventEventTypeManagementOperationCreated                               ParsedWebhookEventEventType = "management_operation.created"
	ParsedWebhookEventEventTypeManagementOperationUpdated                               ParsedWebhookEventEventType = "management_operation.updated"
	ParsedWebhookEventEventTypeInternalTransactionCreated                               ParsedWebhookEventEventType = "internal_transaction.created"
	ParsedWebhookEventEventTypeInternalTransactionUpdated                               ParsedWebhookEventEventType = "internal_transaction.updated"
	ParsedWebhookEventEventTypeNetworkTotalCreated                                      ParsedWebhookEventEventType = "network_total.created"
	ParsedWebhookEventEventTypeNetworkTotalUpdated                                      ParsedWebhookEventEventType = "network_total.updated"
	ParsedWebhookEventEventTypePaymentTransactionCreated                                ParsedWebhookEventEventType = "payment_transaction.created"
	ParsedWebhookEventEventTypePaymentTransactionUpdated                                ParsedWebhookEventEventType = "payment_transaction.updated"
	ParsedWebhookEventEventTypeSettlementReportUpdated                                  ParsedWebhookEventEventType = "settlement_report.updated"
	ParsedWebhookEventEventTypeStatementsCreated                                        ParsedWebhookEventEventType = "statements.created"
	ParsedWebhookEventEventTypeThreeDSAuthenticationCreated                             ParsedWebhookEventEventType = "three_ds_authentication.created"
	ParsedWebhookEventEventTypeThreeDSAuthenticationUpdated                             ParsedWebhookEventEventType = "three_ds_authentication.updated"
	ParsedWebhookEventEventTypeThreeDSAuthenticationChallenge                           ParsedWebhookEventEventType = "three_ds_authentication.challenge"
	ParsedWebhookEventEventTypeTokenizationApprovalRequest                              ParsedWebhookEventEventType = "tokenization.approval_request"
	ParsedWebhookEventEventTypeTokenizationResult                                       ParsedWebhookEventEventType = "tokenization.result"
	ParsedWebhookEventEventTypeTokenizationTwoFactorAuthenticationCode                  ParsedWebhookEventEventType = "tokenization.two_factor_authentication_code"
	ParsedWebhookEventEventTypeTokenizationTwoFactorAuthenticationCodeSent              ParsedWebhookEventEventType = "tokenization.two_factor_authentication_code_sent"
	ParsedWebhookEventEventTypeTokenizationUpdated                                      ParsedWebhookEventEventType = "tokenization.updated"
	ParsedWebhookEventEventTypeThreeDSAuthenticationApprovalRequest                     ParsedWebhookEventEventType = "three_ds_authentication.approval_request"
	ParsedWebhookEventEventTypeDisputeTransactionCreated                                ParsedWebhookEventEventType = "dispute_transaction.created"
	ParsedWebhookEventEventTypeDisputeTransactionUpdated                                ParsedWebhookEventEventType = "dispute_transaction.updated"
)

func (ParsedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventEventType) IsKnown() bool

type ParsedWebhookEventFamily added in v0.98.0 

type ParsedWebhookEventFamily string

TRANSFER - Book Transfer Transaction 

const (
	ParsedWebhookEventFamilyTransfer            ParsedWebhookEventFamily = "TRANSFER"
	ParsedWebhookEventFamilyExternalPayment     ParsedWebhookEventFamily = "EXTERNAL_PAYMENT"
	ParsedWebhookEventFamilyManagementOperation ParsedWebhookEventFamily = "MANAGEMENT_OPERATION"
	ParsedWebhookEventFamilyPayment             ParsedWebhookEventFamily = "PAYMENT"
)

func (ParsedWebhookEventFamily) IsKnown added in v0.98.0 

func (r ParsedWebhookEventFamily) IsKnown() bool

type ParsedWebhookEventIssuerDecision added in v0.98.0 

type ParsedWebhookEventIssuerDecision string

Whether Lithic decisioned on the token, and if so, what the decision was. APPROVED/VERIFICATION_REQUIRED/DENIED. 

const (
	ParsedWebhookEventIssuerDecisionApproved             ParsedWebhookEventIssuerDecision = "APPROVED"
	ParsedWebhookEventIssuerDecisionDenied               ParsedWebhookEventIssuerDecision = "DENIED"
	ParsedWebhookEventIssuerDecisionVerificationRequired ParsedWebhookEventIssuerDecision = "VERIFICATION_REQUIRED"
)

func (ParsedWebhookEventIssuerDecision) IsKnown added in v0.98.0 

func (r ParsedWebhookEventIssuerDecision) IsKnown() bool

type ParsedWebhookEventKYBPayload added in v0.98.0 

type ParsedWebhookEventKYBPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// Original request to update the account holder.
	UpdateRequest ParsedWebhookEventKYBPayloadUpdateRequest `json:"update_request,required"`
	// The type of event that occurred.
	EventType ParsedWebhookEventKYBPayloadEventType `json:"event_type"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string `json:"external_id"`
	// Short description of the company's line of business (i.e., what does the company
	// do?).
	NatureOfBusiness string `json:"nature_of_business"`
	// Company website URL.
	WebsiteURL string                           `json:"website_url"`
	JSON       parsedWebhookEventKYBPayloadJSON `json:"-"`
}

KYB payload for an updated account holder.

func (*ParsedWebhookEventKYBPayload) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYBPayloadEventType added in v0.98.0 

type ParsedWebhookEventKYBPayloadEventType string

The type of event that occurred. 

const (
	ParsedWebhookEventKYBPayloadEventTypeAccountHolderUpdated ParsedWebhookEventKYBPayloadEventType = "account_holder.updated"
)

func (ParsedWebhookEventKYBPayloadEventType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventKYBPayloadEventType) IsKnown() bool

type ParsedWebhookEventKYBPayloadUpdateRequest added in v0.98.0 

type ParsedWebhookEventKYBPayloadUpdateRequest struct {
	// Deprecated.
	//
	// Deprecated: deprecated
	BeneficialOwnerEntities []KYBBusinessEntity `json:"beneficial_owner_entities"`
	// You must submit a list of all direct and indirect individuals with 25% or more
	// ownership in the company. A maximum of 4 beneficial owners can be submitted. If
	// no individual owns 25% of the company you do not need to send beneficial owner
	// information. 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.
	BeneficialOwnerIndividuals []ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual `json:"beneficial_owner_individuals"`
	// Information for business for which the account is being opened and KYB is being
	// run.
	BusinessEntity KYBBusinessEntity `json:"business_entity"`
	// 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 ParsedWebhookEventKYBPayloadUpdateRequestControlPerson `json:"control_person"`
	JSON          parsedWebhookEventKYBPayloadUpdateRequestJSON          `json:"-"`
}

Original request to update the account holder.

func (*ParsedWebhookEventKYBPayloadUpdateRequest) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual added in v0.98.0 

type ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual 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 ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress `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        parsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualJSON `json:"-"`
}

func (*ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividual) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress added in v0.98.0 

type ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress 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     parsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddressJSON `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 (*ParsedWebhookEventKYBPayloadUpdateRequestBeneficialOwnerIndividualsAddress) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYBPayloadUpdateRequestControlPerson added in v0.98.0 

type ParsedWebhookEventKYBPayloadUpdateRequestControlPerson 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 ParsedWebhookEventKYBPayloadUpdateRequestControlPersonAddress `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        parsedWebhookEventKYBPayloadUpdateRequestControlPersonJSON `json:"-"`
}

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 (*ParsedWebhookEventKYBPayloadUpdateRequestControlPerson) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYBPayloadUpdateRequestControlPersonAddress added in v0.98.0 

type ParsedWebhookEventKYBPayloadUpdateRequestControlPersonAddress 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     parsedWebhookEventKYBPayloadUpdateRequestControlPersonAddressJSON `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 (*ParsedWebhookEventKYBPayloadUpdateRequestControlPersonAddress) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYCPayload added in v0.98.0 

type ParsedWebhookEventKYCPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// Original request to update the account holder.
	UpdateRequest ParsedWebhookEventKYCPayloadUpdateRequest `json:"update_request,required"`
	// The type of event that occurred.
	EventType ParsedWebhookEventKYCPayloadEventType `json:"event_type"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID string                           `json:"external_id"`
	JSON       parsedWebhookEventKYCPayloadJSON `json:"-"`
}

KYC payload for an updated account holder.

func (*ParsedWebhookEventKYCPayload) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYCPayloadEventType added in v0.98.0 

type ParsedWebhookEventKYCPayloadEventType string

The type of event that occurred. 

const (
	ParsedWebhookEventKYCPayloadEventTypeAccountHolderUpdated ParsedWebhookEventKYCPayloadEventType = "account_holder.updated"
)

func (ParsedWebhookEventKYCPayloadEventType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventKYCPayloadEventType) IsKnown() bool

type ParsedWebhookEventKYCPayloadUpdateRequest added in v0.98.0 

type ParsedWebhookEventKYCPayloadUpdateRequest struct {
	// Information on the individual for whom the account is being opened and KYC is
	// being run.
	Individual ParsedWebhookEventKYCPayloadUpdateRequestIndividual `json:"individual"`
	JSON       parsedWebhookEventKYCPayloadUpdateRequestJSON       `json:"-"`
}

Original request to update the account holder.

func (*ParsedWebhookEventKYCPayloadUpdateRequest) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYCPayloadUpdateRequestIndividual added in v0.98.0 

type ParsedWebhookEventKYCPayloadUpdateRequestIndividual 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 ParsedWebhookEventKYCPayloadUpdateRequestIndividualAddress `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        parsedWebhookEventKYCPayloadUpdateRequestIndividualJSON `json:"-"`
}

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

func (*ParsedWebhookEventKYCPayloadUpdateRequestIndividual) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventKYCPayloadUpdateRequestIndividualAddress added in v0.98.0 

type ParsedWebhookEventKYCPayloadUpdateRequestIndividualAddress 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     parsedWebhookEventKYCPayloadUpdateRequestIndividualAddressJSON `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 (*ParsedWebhookEventKYCPayloadUpdateRequestIndividualAddress) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventLegacyPayload added in v0.98.0 

type ParsedWebhookEventLegacyPayload struct {
	// The token of the account_holder that was created.
	Token string `json:"token,required" format:"uuid"`
	// If applicable, represents the business account token associated with the
	// account_holder.
	BusinessAccountToken string `json:"business_account_token,nullable" format:"uuid"`
	// When the account_holder updated event was created
	Created time.Time `json:"created" format:"date-time"`
	// If updated, the newly updated email associated with the account_holder otherwise
	// the existing email is provided.
	Email string `json:"email"`
	// The type of event that occurred.
	EventType ParsedWebhookEventLegacyPayloadEventType `json:"event_type"`
	// If applicable, represents the external_id associated with the account_holder.
	ExternalID string `json:"external_id,nullable"`
	// If applicable, represents the account_holder's first name.
	FirstName string `json:"first_name"`
	// If applicable, represents the account_holder's last name.
	LastName string `json:"last_name"`
	// If applicable, represents the account_holder's business name.
	LegalBusinessName string `json:"legal_business_name"`
	// If updated, the newly updated phone_number associated with the account_holder
	// otherwise the existing phone_number is provided.
	PhoneNumber string                              `json:"phone_number"`
	JSON        parsedWebhookEventLegacyPayloadJSON `json:"-"`
}

Legacy payload for an updated account holder.

func (*ParsedWebhookEventLegacyPayload) UnmarshalJSON added in v0.98.0 

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

type ParsedWebhookEventLegacyPayloadEventType added in v0.98.0 

type ParsedWebhookEventLegacyPayloadEventType string

The type of event that occurred. 

const (
	ParsedWebhookEventLegacyPayloadEventTypeAccountHolderUpdated ParsedWebhookEventLegacyPayloadEventType = "account_holder.updated"
)

func (ParsedWebhookEventLegacyPayloadEventType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventLegacyPayloadEventType) IsKnown() bool

type ParsedWebhookEventMessageCategory added in v0.98.0 

type ParsedWebhookEventMessageCategory string

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated. 

const (
	ParsedWebhookEventMessageCategoryNonPaymentAuthentication ParsedWebhookEventMessageCategory = "NON_PAYMENT_AUTHENTICATION"
	ParsedWebhookEventMessageCategoryPaymentAuthentication    ParsedWebhookEventMessageCategory = "PAYMENT_AUTHENTICATION"
)

func (ParsedWebhookEventMessageCategory) IsKnown added in v0.98.0 

func (r ParsedWebhookEventMessageCategory) IsKnown() bool

type ParsedWebhookEventMethod added in v0.98.0 

type ParsedWebhookEventMethod string

Transfer method 

const (
	ParsedWebhookEventMethodACHNextDay ParsedWebhookEventMethod = "ACH_NEXT_DAY"
	ParsedWebhookEventMethodACHSameDay ParsedWebhookEventMethod = "ACH_SAME_DAY"
	ParsedWebhookEventMethodWire       ParsedWebhookEventMethod = "WIRE"
)

func (ParsedWebhookEventMethod) IsKnown added in v0.98.0 

func (r ParsedWebhookEventMethod) IsKnown() bool

type ParsedWebhookEventNetwork added in v0.98.0 

type ParsedWebhookEventNetwork string

Card network of the authorization. 

const (
	ParsedWebhookEventNetworkAmex       ParsedWebhookEventNetwork = "AMEX"
	ParsedWebhookEventNetworkInterlink  ParsedWebhookEventNetwork = "INTERLINK"
	ParsedWebhookEventNetworkMaestro    ParsedWebhookEventNetwork = "MAESTRO"
	ParsedWebhookEventNetworkMastercard ParsedWebhookEventNetwork = "MASTERCARD"
	ParsedWebhookEventNetworkUnknown    ParsedWebhookEventNetwork = "UNKNOWN"
	ParsedWebhookEventNetworkVisa       ParsedWebhookEventNetwork = "VISA"
)

func (ParsedWebhookEventNetwork) IsKnown added in v0.98.0 

func (r ParsedWebhookEventNetwork) IsKnown() bool

type ParsedWebhookEventPaymentType added in v0.98.0 

type ParsedWebhookEventPaymentType string
const (
	ParsedWebhookEventPaymentTypeDeposit    ParsedWebhookEventPaymentType = "DEPOSIT"
	ParsedWebhookEventPaymentTypeWithdrawal ParsedWebhookEventPaymentType = "WITHDRAWAL"
)

func (ParsedWebhookEventPaymentType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventPaymentType) IsKnown() bool

type ParsedWebhookEventReason added in v0.98.0 

type ParsedWebhookEventReason 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 (
	ParsedWebhookEventReasonAtmCashMisdispense               ParsedWebhookEventReason = "ATM_CASH_MISDISPENSE"
	ParsedWebhookEventReasonCancelled                        ParsedWebhookEventReason = "CANCELLED"
	ParsedWebhookEventReasonDuplicated                       ParsedWebhookEventReason = "DUPLICATED"
	ParsedWebhookEventReasonFraudCardNotPresent              ParsedWebhookEventReason = "FRAUD_CARD_NOT_PRESENT"
	ParsedWebhookEventReasonFraudCardPresent                 ParsedWebhookEventReason = "FRAUD_CARD_PRESENT"
	ParsedWebhookEventReasonFraudOther                       ParsedWebhookEventReason = "FRAUD_OTHER"
	ParsedWebhookEventReasonGoodsServicesNotAsDescribed      ParsedWebhookEventReason = "GOODS_SERVICES_NOT_AS_DESCRIBED"
	ParsedWebhookEventReasonGoodsServicesNotReceived         ParsedWebhookEventReason = "GOODS_SERVICES_NOT_RECEIVED"
	ParsedWebhookEventReasonIncorrectAmount                  ParsedWebhookEventReason = "INCORRECT_AMOUNT"
	ParsedWebhookEventReasonMissingAuth                      ParsedWebhookEventReason = "MISSING_AUTH"
	ParsedWebhookEventReasonOther                            ParsedWebhookEventReason = "OTHER"
	ParsedWebhookEventReasonProcessingError                  ParsedWebhookEventReason = "PROCESSING_ERROR"
	ParsedWebhookEventReasonRecurringTransactionNotCancelled ParsedWebhookEventReason = "RECURRING_TRANSACTION_NOT_CANCELLED"
	ParsedWebhookEventReasonRefundNotProcessed               ParsedWebhookEventReason = "REFUND_NOT_PROCESSED"
)

func (ParsedWebhookEventReason) IsKnown added in v0.98.0 

func (r ParsedWebhookEventReason) IsKnown() bool

type ParsedWebhookEventResolutionReason added in v0.98.0 

type ParsedWebhookEventResolutionReason 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 (
	ParsedWebhookEventResolutionReasonCaseLost                      ParsedWebhookEventResolutionReason = "CASE_LOST"
	ParsedWebhookEventResolutionReasonNetworkRejected               ParsedWebhookEventResolutionReason = "NETWORK_REJECTED"
	ParsedWebhookEventResolutionReasonNoDisputeRights3DS            ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_3DS"
	ParsedWebhookEventResolutionReasonNoDisputeRightsBelowThreshold ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_BELOW_THRESHOLD"
	ParsedWebhookEventResolutionReasonNoDisputeRightsContactless    ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_CONTACTLESS"
	ParsedWebhookEventResolutionReasonNoDisputeRightsHybrid         ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_HYBRID"
	ParsedWebhookEventResolutionReasonNoDisputeRightsMaxChargebacks ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS"
	ParsedWebhookEventResolutionReasonNoDisputeRightsOther          ParsedWebhookEventResolutionReason = "NO_DISPUTE_RIGHTS_OTHER"
	ParsedWebhookEventResolutionReasonPastFilingDate                ParsedWebhookEventResolutionReason = "PAST_FILING_DATE"
	ParsedWebhookEventResolutionReasonPrearbitrationRejected        ParsedWebhookEventResolutionReason = "PREARBITRATION_REJECTED"
	ParsedWebhookEventResolutionReasonProcessorRejectedOther        ParsedWebhookEventResolutionReason = "PROCESSOR_REJECTED_OTHER"
	ParsedWebhookEventResolutionReasonRefunded                      ParsedWebhookEventResolutionReason = "REFUNDED"
	ParsedWebhookEventResolutionReasonRefundedAfterChargeback       ParsedWebhookEventResolutionReason = "REFUNDED_AFTER_CHARGEBACK"
	ParsedWebhookEventResolutionReasonWithdrawn                     ParsedWebhookEventResolutionReason = "WITHDRAWN"
	ParsedWebhookEventResolutionReasonWonArbitration                ParsedWebhookEventResolutionReason = "WON_ARBITRATION"
	ParsedWebhookEventResolutionReasonWonFirstChargeback            ParsedWebhookEventResolutionReason = "WON_FIRST_CHARGEBACK"
	ParsedWebhookEventResolutionReasonWonPrearbitration             ParsedWebhookEventResolutionReason = "WON_PREARBITRATION"
)

func (ParsedWebhookEventResolutionReason) IsKnown added in v0.98.0 

func (r ParsedWebhookEventResolutionReason) IsKnown() bool

type ParsedWebhookEventResult added in v0.98.0 

type ParsedWebhookEventResult string
const (
	ParsedWebhookEventResultApproved                    ParsedWebhookEventResult = "APPROVED"
	ParsedWebhookEventResultDeclined                    ParsedWebhookEventResult = "DECLINED"
	ParsedWebhookEventResultAccountPaused               ParsedWebhookEventResult = "ACCOUNT_PAUSED"
	ParsedWebhookEventResultAccountStateTransactionFail ParsedWebhookEventResult = "ACCOUNT_STATE_TRANSACTION_FAIL"
	ParsedWebhookEventResultBankConnectionError         ParsedWebhookEventResult = "BANK_CONNECTION_ERROR"
	ParsedWebhookEventResultBankNotVerified             ParsedWebhookEventResult = "BANK_NOT_VERIFIED"
	ParsedWebhookEventResultCardClosed                  ParsedWebhookEventResult = "CARD_CLOSED"
	ParsedWebhookEventResultCardPaused                  ParsedWebhookEventResult = "CARD_PAUSED"
	ParsedWebhookEventResultFraudAdvice                 ParsedWebhookEventResult = "FRAUD_ADVICE"
	ParsedWebhookEventResultIgnoredTtlExpiry            ParsedWebhookEventResult = "IGNORED_TTL_EXPIRY"
	ParsedWebhookEventResultSuspectedFraud              ParsedWebhookEventResult = "SUSPECTED_FRAUD"
	ParsedWebhookEventResultInactiveAccount             ParsedWebhookEventResult = "INACTIVE_ACCOUNT"
	ParsedWebhookEventResultIncorrectPin                ParsedWebhookEventResult = "INCORRECT_PIN"
	ParsedWebhookEventResultInvalidCardDetails          ParsedWebhookEventResult = "INVALID_CARD_DETAILS"
	ParsedWebhookEventResultInsufficientFunds           ParsedWebhookEventResult = "INSUFFICIENT_FUNDS"
	ParsedWebhookEventResultInsufficientFundsPreload    ParsedWebhookEventResult = "INSUFFICIENT_FUNDS_PRELOAD"
	ParsedWebhookEventResultInvalidTransaction          ParsedWebhookEventResult = "INVALID_TRANSACTION"
	ParsedWebhookEventResultMerchantBlacklist           ParsedWebhookEventResult = "MERCHANT_BLACKLIST"
	ParsedWebhookEventResultOriginalNotFound            ParsedWebhookEventResult = "ORIGINAL_NOT_FOUND"
	ParsedWebhookEventResultPreviouslyCompleted         ParsedWebhookEventResult = "PREVIOUSLY_COMPLETED"
	ParsedWebhookEventResultSingleUseRecharged          ParsedWebhookEventResult = "SINGLE_USE_RECHARGED"
	ParsedWebhookEventResultSwitchInoperativeAdvice     ParsedWebhookEventResult = "SWITCH_INOPERATIVE_ADVICE"
	ParsedWebhookEventResultUnauthorizedMerchant        ParsedWebhookEventResult = "UNAUTHORIZED_MERCHANT"
	ParsedWebhookEventResultUnknownHostTimeout          ParsedWebhookEventResult = "UNKNOWN_HOST_TIMEOUT"
	ParsedWebhookEventResultUserTransactionLimit        ParsedWebhookEventResult = "USER_TRANSACTION_LIMIT"
)

func (ParsedWebhookEventResult) IsKnown added in v0.98.0 

func (r ParsedWebhookEventResult) IsKnown() bool

type ParsedWebhookEventShippingMethod added in v0.98.0 

type ParsedWebhookEventShippingMethod string

The specific shipping method used to ship the card. 

const (
	ParsedWebhookEventShippingMethodExUsExpeditedWithTracking             ParsedWebhookEventShippingMethod = "Ex-US expedited with tracking"
	ParsedWebhookEventShippingMethodExUsStandardWithTracking              ParsedWebhookEventShippingMethod = "Ex-US standard with tracking"
	ParsedWebhookEventShippingMethodExUsStandardWithoutTracking           ParsedWebhookEventShippingMethod = "Ex-US standard without tracking"
	ParsedWebhookEventShippingMethodFedEx2Days                            ParsedWebhookEventShippingMethod = "FedEx 2 days"
	ParsedWebhookEventShippingMethodFedExExpress                          ParsedWebhookEventShippingMethod = "FedEx express"
	ParsedWebhookEventShippingMethodFedExOvernight                        ParsedWebhookEventShippingMethod = "FedEx overnight"
	ParsedWebhookEventShippingMethodUspsPriority                          ParsedWebhookEventShippingMethod = "USPS priority"
	ParsedWebhookEventShippingMethodUspsWithTracking                      ParsedWebhookEventShippingMethod = "USPS with tracking"
	ParsedWebhookEventShippingMethodUspsWithoutTrackingEnvelope           ParsedWebhookEventShippingMethod = "USPS without tracking envelope"
	ParsedWebhookEventShippingMethodUspsWithoutTrackingEnvelopeNonMachine ParsedWebhookEventShippingMethod = "USPS without tracking envelope non-machine"
	ParsedWebhookEventShippingMethodUspsWithoutTrackingFlat               ParsedWebhookEventShippingMethod = "USPS without tracking flat"
)

func (ParsedWebhookEventShippingMethod) IsKnown added in v0.98.0 

func (r ParsedWebhookEventShippingMethod) IsKnown() bool

type ParsedWebhookEventSource added in v0.98.0 

type ParsedWebhookEventSource string

Transaction source 

const (
	ParsedWebhookEventSourceLithic   ParsedWebhookEventSource = "LITHIC"
	ParsedWebhookEventSourceExternal ParsedWebhookEventSource = "EXTERNAL"
	ParsedWebhookEventSourceCustomer ParsedWebhookEventSource = "CUSTOMER"
)

func (ParsedWebhookEventSource) IsKnown added in v0.98.0 

func (r ParsedWebhookEventSource) IsKnown() bool

type ParsedWebhookEventState added in v0.98.0 

type ParsedWebhookEventState string

Account State 

const (
	ParsedWebhookEventStateEnabled ParsedWebhookEventState = "ENABLED"
	ParsedWebhookEventStateClosed  ParsedWebhookEventState = "CLOSED"
	ParsedWebhookEventStatePaused  ParsedWebhookEventState = "PAUSED"
)

func (ParsedWebhookEventState) IsKnown added in v0.98.0 

func (r ParsedWebhookEventState) IsKnown() bool

type ParsedWebhookEventStatementType added in v0.98.0 

type ParsedWebhookEventStatementType string
const (
	ParsedWebhookEventStatementTypeInitial   ParsedWebhookEventStatementType = "INITIAL"
	ParsedWebhookEventStatementTypePeriodEnd ParsedWebhookEventStatementType = "PERIOD_END"
	ParsedWebhookEventStatementTypeFinal     ParsedWebhookEventStatementType = "FINAL"
)

func (ParsedWebhookEventStatementType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventStatementType) IsKnown() bool

type ParsedWebhookEventStatus added in v0.98.0 

type ParsedWebhookEventStatus string

The status of the account_holder that was created. 

const (
	ParsedWebhookEventStatusAccepted                     ParsedWebhookEventStatus = "ACCEPTED"
	ParsedWebhookEventStatusPendingReview                ParsedWebhookEventStatus = "PENDING_REVIEW"
	ParsedWebhookEventStatusRejected                     ParsedWebhookEventStatus = "REJECTED"
	ParsedWebhookEventStatusAuthorization                ParsedWebhookEventStatus = "AUTHORIZATION"
	ParsedWebhookEventStatusCreditAuthorization          ParsedWebhookEventStatus = "CREDIT_AUTHORIZATION"
	ParsedWebhookEventStatusFinancialAuthorization       ParsedWebhookEventStatus = "FINANCIAL_AUTHORIZATION"
	ParsedWebhookEventStatusFinancialCreditAuthorization ParsedWebhookEventStatus = "FINANCIAL_CREDIT_AUTHORIZATION"
	ParsedWebhookEventStatusBalanceInquiry               ParsedWebhookEventStatus = "BALANCE_INQUIRY"
	ParsedWebhookEventStatusPending                      ParsedWebhookEventStatus = "PENDING"
	ParsedWebhookEventStatusSettled                      ParsedWebhookEventStatus = "SETTLED"
	ParsedWebhookEventStatusDeclined                     ParsedWebhookEventStatus = "DECLINED"
	ParsedWebhookEventStatusReversed                     ParsedWebhookEventStatus = "REVERSED"
	ParsedWebhookEventStatusCanceled                     ParsedWebhookEventStatus = "CANCELED"
	ParsedWebhookEventStatusReturned                     ParsedWebhookEventStatus = "RETURNED"
	ParsedWebhookEventStatusExpired                      ParsedWebhookEventStatus = "EXPIRED"
	ParsedWebhookEventStatusVoided                       ParsedWebhookEventStatus = "VOIDED"
	ParsedWebhookEventStatusArbitration                  ParsedWebhookEventStatus = "ARBITRATION"
	ParsedWebhookEventStatusCaseClosed                   ParsedWebhookEventStatus = "CASE_CLOSED"
	ParsedWebhookEventStatusCaseWon                      ParsedWebhookEventStatus = "CASE_WON"
	ParsedWebhookEventStatusNew                          ParsedWebhookEventStatus = "NEW"
	ParsedWebhookEventStatusPendingCustomer              ParsedWebhookEventStatus = "PENDING_CUSTOMER"
	ParsedWebhookEventStatusPrearbitration               ParsedWebhookEventStatus = "PREARBITRATION"
	ParsedWebhookEventStatusRepresentment                ParsedWebhookEventStatus = "REPRESENTMENT"
	ParsedWebhookEventStatusSubmitted                    ParsedWebhookEventStatus = "SUBMITTED"
	ParsedWebhookEventStatusOpen                         ParsedWebhookEventStatus = "OPEN"
	ParsedWebhookEventStatusClosed                       ParsedWebhookEventStatus = "CLOSED"
	ParsedWebhookEventStatusSuspended                    ParsedWebhookEventStatus = "SUSPENDED"
)

func (ParsedWebhookEventStatus) IsKnown added in v0.98.0 

func (r ParsedWebhookEventStatus) IsKnown() bool

type ParsedWebhookEventSubstatus added in v0.98.0 

type ParsedWebhookEventSubstatus string

Substatus for the financial account 

const (
	ParsedWebhookEventSubstatusChargedOffDelinquent ParsedWebhookEventSubstatus = "CHARGED_OFF_DELINQUENT"
	ParsedWebhookEventSubstatusChargedOffFraud      ParsedWebhookEventSubstatus = "CHARGED_OFF_FRAUD"
	ParsedWebhookEventSubstatusEndUserRequest       ParsedWebhookEventSubstatus = "END_USER_REQUEST"
	ParsedWebhookEventSubstatusBankRequest          ParsedWebhookEventSubstatus = "BANK_REQUEST"
	ParsedWebhookEventSubstatusDelinquent           ParsedWebhookEventSubstatus = "DELINQUENT"
)

func (ParsedWebhookEventSubstatus) IsKnown added in v0.98.0 

func (r ParsedWebhookEventSubstatus) IsKnown() bool

type ParsedWebhookEventThreeDSRequestorChallengeIndicator added in v0.98.0 

type ParsedWebhookEventThreeDSRequestorChallengeIndicator string

Indicates whether a challenge is requested for this transaction

  • `NO_PREFERENCE` - No Preference
  • `NO_CHALLENGE_REQUESTED` - No Challenge Requested
  • `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
  • `CHALLENGE_MANDATE` - Challenge requested (Mandate)
  • `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional risk analysis is already performed)
  • `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
  • `OTHER` - Other indicators not captured by above. These are rarely used
const (
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorNoPreference                   ParsedWebhookEventThreeDSRequestorChallengeIndicator = "NO_PREFERENCE"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorNoChallengeRequested           ParsedWebhookEventThreeDSRequestorChallengeIndicator = "NO_CHALLENGE_REQUESTED"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorChallengePreference            ParsedWebhookEventThreeDSRequestorChallengeIndicator = "CHALLENGE_PREFERENCE"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorChallengeMandate               ParsedWebhookEventThreeDSRequestorChallengeIndicator = "CHALLENGE_MANDATE"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorNoChallengeRiskAlreadyAssessed ParsedWebhookEventThreeDSRequestorChallengeIndicator = "NO_CHALLENGE_RISK_ALREADY_ASSESSED"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorDataShareOnly                  ParsedWebhookEventThreeDSRequestorChallengeIndicator = "DATA_SHARE_ONLY"
	ParsedWebhookEventThreeDSRequestorChallengeIndicatorOther                          ParsedWebhookEventThreeDSRequestorChallengeIndicator = "OTHER"
)

func (ParsedWebhookEventThreeDSRequestorChallengeIndicator) IsKnown added in v0.98.0 

func (r ParsedWebhookEventThreeDSRequestorChallengeIndicator) IsKnown() bool

type ParsedWebhookEventThreeRiRequestType added in v0.98.0 

type ParsedWebhookEventThreeRiRequestType 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 (
	ParsedWebhookEventThreeRiRequestTypeAccountVerification         ParsedWebhookEventThreeRiRequestType = "ACCOUNT_VERIFICATION"
	ParsedWebhookEventThreeRiRequestTypeAddCard                     ParsedWebhookEventThreeRiRequestType = "ADD_CARD"
	ParsedWebhookEventThreeRiRequestTypeBillingAgreement            ParsedWebhookEventThreeRiRequestType = "BILLING_AGREEMENT"
	ParsedWebhookEventThreeRiRequestTypeCardSecurityCodeStatusCheck ParsedWebhookEventThreeRiRequestType = "CARD_SECURITY_CODE_STATUS_CHECK"
	ParsedWebhookEventThreeRiRequestTypeDelayedShipment             ParsedWebhookEventThreeRiRequestType = "DELAYED_SHIPMENT"
	ParsedWebhookEventThreeRiRequestTypeDeviceBindingStatusCheck    ParsedWebhookEventThreeRiRequestType = "DEVICE_BINDING_STATUS_CHECK"
	ParsedWebhookEventThreeRiRequestTypeInstallmentTransaction      ParsedWebhookEventThreeRiRequestType = "INSTALLMENT_TRANSACTION"
	ParsedWebhookEventThreeRiRequestTypeMailOrder                   ParsedWebhookEventThreeRiRequestType = "MAIL_ORDER"
	ParsedWebhookEventThreeRiRequestTypeMaintainCardInfo            ParsedWebhookEventThreeRiRequestType = "MAINTAIN_CARD_INFO"
	ParsedWebhookEventThreeRiRequestTypeOtherPayment                ParsedWebhookEventThreeRiRequestType = "OTHER_PAYMENT"
	ParsedWebhookEventThreeRiRequestTypeRecurringTransaction        ParsedWebhookEventThreeRiRequestType = "RECURRING_TRANSACTION"
	ParsedWebhookEventThreeRiRequestTypeSplitPayment                ParsedWebhookEventThreeRiRequestType = "SPLIT_PAYMENT"
	ParsedWebhookEventThreeRiRequestTypeSplitShipment               ParsedWebhookEventThreeRiRequestType = "SPLIT_SHIPMENT"
	ParsedWebhookEventThreeRiRequestTypeTelephoneOrder              ParsedWebhookEventThreeRiRequestType = "TELEPHONE_ORDER"
	ParsedWebhookEventThreeRiRequestTypeTopUp                       ParsedWebhookEventThreeRiRequestType = "TOP_UP"
	ParsedWebhookEventThreeRiRequestTypeTrustListStatusCheck        ParsedWebhookEventThreeRiRequestType = "TRUST_LIST_STATUS_CHECK"
)

func (ParsedWebhookEventThreeRiRequestType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventThreeRiRequestType) IsKnown() bool

type ParsedWebhookEventTokenizationChannel added in v0.98.0 

type ParsedWebhookEventTokenizationChannel string

The channel through which the tokenization was made. 

const (
	ParsedWebhookEventTokenizationChannelDigitalWallet ParsedWebhookEventTokenizationChannel = "DIGITAL_WALLET"
	ParsedWebhookEventTokenizationChannelMerchant      ParsedWebhookEventTokenizationChannel = "MERCHANT"
)

func (ParsedWebhookEventTokenizationChannel) IsKnown added in v0.98.0 

func (r ParsedWebhookEventTokenizationChannel) IsKnown() bool

type ParsedWebhookEventTokenizationSource added in v0.98.0 

type ParsedWebhookEventTokenizationSource string

The source of the tokenization. 

const (
	ParsedWebhookEventTokenizationSourceAccountOnFile   ParsedWebhookEventTokenizationSource = "ACCOUNT_ON_FILE"
	ParsedWebhookEventTokenizationSourceContactlessTap  ParsedWebhookEventTokenizationSource = "CONTACTLESS_TAP"
	ParsedWebhookEventTokenizationSourceManualProvision ParsedWebhookEventTokenizationSource = "MANUAL_PROVISION"
	ParsedWebhookEventTokenizationSourcePushProvision   ParsedWebhookEventTokenizationSource = "PUSH_PROVISION"
	ParsedWebhookEventTokenizationSourceToken           ParsedWebhookEventTokenizationSource = "TOKEN"
	ParsedWebhookEventTokenizationSourceUnknown         ParsedWebhookEventTokenizationSource = "UNKNOWN"
)

func (ParsedWebhookEventTokenizationSource) IsKnown added in v0.98.0 

func (r ParsedWebhookEventTokenizationSource) IsKnown() bool

type ParsedWebhookEventTransactionInitiator added in v0.98.0 

type ParsedWebhookEventTransactionInitiator string

The entity that initiated the transaction. 

const (
	ParsedWebhookEventTransactionInitiatorCardholder ParsedWebhookEventTransactionInitiator = "CARDHOLDER"
	ParsedWebhookEventTransactionInitiatorMerchant   ParsedWebhookEventTransactionInitiator = "MERCHANT"
	ParsedWebhookEventTransactionInitiatorUnknown    ParsedWebhookEventTransactionInitiator = "UNKNOWN"
)

func (ParsedWebhookEventTransactionInitiator) IsKnown added in v0.98.0 

func (r ParsedWebhookEventTransactionInitiator) IsKnown() bool

type ParsedWebhookEventType added in v0.98.0 

type ParsedWebhookEventType string

Account Type 

const (
	ParsedWebhookEventTypeChecking                   ParsedWebhookEventType = "CHECKING"
	ParsedWebhookEventTypeSavings                    ParsedWebhookEventType = "SAVINGS"
	ParsedWebhookEventTypeIssuing                    ParsedWebhookEventType = "ISSUING"
	ParsedWebhookEventTypeReserve                    ParsedWebhookEventType = "RESERVE"
	ParsedWebhookEventTypeOperating                  ParsedWebhookEventType = "OPERATING"
	ParsedWebhookEventTypeChargedOffFees             ParsedWebhookEventType = "CHARGED_OFF_FEES"
	ParsedWebhookEventTypeChargedOffInterest         ParsedWebhookEventType = "CHARGED_OFF_INTEREST"
	ParsedWebhookEventTypeChargedOffPrincipal        ParsedWebhookEventType = "CHARGED_OFF_PRINCIPAL"
	ParsedWebhookEventTypeSecurity                   ParsedWebhookEventType = "SECURITY"
	ParsedWebhookEventTypeProgramReceivables         ParsedWebhookEventType = "PROGRAM_RECEIVABLES"
	ParsedWebhookEventTypeCollection                 ParsedWebhookEventType = "COLLECTION"
	ParsedWebhookEventTypeProgramBankAccountsPayable ParsedWebhookEventType = "PROGRAM_BANK_ACCOUNTS_PAYABLE"
	ParsedWebhookEventTypeOriginationCredit          ParsedWebhookEventType = "ORIGINATION_CREDIT"
	ParsedWebhookEventTypeOriginationDebit           ParsedWebhookEventType = "ORIGINATION_DEBIT"
	ParsedWebhookEventTypeReceiptCredit              ParsedWebhookEventType = "RECEIPT_CREDIT"
	ParsedWebhookEventTypeReceiptDebit               ParsedWebhookEventType = "RECEIPT_DEBIT"
	ParsedWebhookEventTypeWireInboundPayment         ParsedWebhookEventType = "WIRE_INBOUND_PAYMENT"
	ParsedWebhookEventTypeWireInboundAdmin           ParsedWebhookEventType = "WIRE_INBOUND_ADMIN"
	ParsedWebhookEventTypeWireOutboundPayment        ParsedWebhookEventType = "WIRE_OUTBOUND_PAYMENT"
	ParsedWebhookEventTypeWireOutboundAdmin          ParsedWebhookEventType = "WIRE_OUTBOUND_ADMIN"
	ParsedWebhookEventTypeWireDrawdownRequest        ParsedWebhookEventType = "WIRE_DRAWDOWN_REQUEST"
)

func (ParsedWebhookEventType) IsKnown added in v0.98.0 

func (r ParsedWebhookEventType) IsKnown() bool

type ParsedWebhookEventUnion added in v0.98.0 

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

KYB payload for an updated account holder.

Union satisfied by AccountHolderCreatedWebhookEvent, ParsedWebhookEventKYBPayload, ParsedWebhookEventKYCPayload, ParsedWebhookEventLegacyPayload, AccountHolderVerificationWebhookEvent, AccountHolderDocumentUpdatedWebhookEvent, CardAuthorizationApprovalRequestWebhookEvent, TokenizationDecisioningRequestWebhookEvent, AuthRulesBacktestReportCreatedWebhookEvent, BalanceUpdatedWebhookEvent, BookTransferTransactionCreatedWebhookEvent, BookTransferTransactionUpdatedWebhookEvent, CardCreatedWebhookEvent, CardConvertedWebhookEvent, CardRenewedWebhookEvent, CardReissuedWebhookEvent, CardShippedWebhookEvent, CardTransactionUpdatedWebhookEvent, CardTransactionEnhancedDataCreatedWebhookEvent, CardTransactionEnhancedDataUpdatedWebhookEvent, DigitalWalletTokenizationApprovalRequestWebhookEvent, DigitalWalletTokenizationResultWebhookEvent, DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, DigitalWalletTokenizationUpdatedWebhookEvent, DisputeUpdatedWebhookEvent, DisputeEvidenceUploadFailedWebhookEvent, ExternalBankAccountCreatedWebhookEvent, ExternalBankAccountUpdatedWebhookEvent, ExternalPaymentCreatedWebhookEvent, ExternalPaymentUpdatedWebhookEvent, FinancialAccountCreatedWebhookEvent, FinancialAccountUpdatedWebhookEvent, FundingEventCreatedWebhookEvent, LoanTapeCreatedWebhookEvent, LoanTapeUpdatedWebhookEvent, ManagementOperationCreatedWebhookEvent, ManagementOperationUpdatedWebhookEvent, InternalTransactionCreatedWebhookEvent, InternalTransactionUpdatedWebhookEvent, NetworkTotalCreatedWebhookEvent, NetworkTotalUpdatedWebhookEvent, PaymentTransactionCreatedWebhookEvent, PaymentTransactionUpdatedWebhookEvent, SettlementReportUpdatedWebhookEvent, StatementsCreatedWebhookEvent, ThreeDSAuthenticationCreatedWebhookEvent, ThreeDSAuthenticationUpdatedWebhookEvent, ThreeDSAuthenticationChallengeWebhookEvent, TokenizationApprovalRequestWebhookEvent, TokenizationResultWebhookEvent, TokenizationTwoFactorAuthenticationCodeWebhookEvent, TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, TokenizationUpdatedWebhookEvent, ThreeDSAuthenticationApprovalRequestWebhookEvent, DisputeTransactionCreatedWebhookEvent or DisputeTransactionUpdatedWebhookEvent.

type ParsedWebhookEventUploadStatus added in v0.98.0 

type ParsedWebhookEventUploadStatus 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 (
	ParsedWebhookEventUploadStatusDeleted  ParsedWebhookEventUploadStatus = "DELETED"
	ParsedWebhookEventUploadStatusError    ParsedWebhookEventUploadStatus = "ERROR"
	ParsedWebhookEventUploadStatusPending  ParsedWebhookEventUploadStatus = "PENDING"
	ParsedWebhookEventUploadStatusRejected ParsedWebhookEventUploadStatus = "REJECTED"
	ParsedWebhookEventUploadStatusUploaded ParsedWebhookEventUploadStatus = "UPLOADED"
)

func (ParsedWebhookEventUploadStatus) IsKnown added in v0.98.0 

func (r ParsedWebhookEventUploadStatus) IsKnown() bool

type ParsedWebhookEventVerificationState added in v0.98.0 

type ParsedWebhookEventVerificationState string

Verification State 

const (
	ParsedWebhookEventVerificationStatePending            ParsedWebhookEventVerificationState = "PENDING"
	ParsedWebhookEventVerificationStateEnabled            ParsedWebhookEventVerificationState = "ENABLED"
	ParsedWebhookEventVerificationStateFailedVerification ParsedWebhookEventVerificationState = "FAILED_VERIFICATION"
	ParsedWebhookEventVerificationStateInsufficientFunds  ParsedWebhookEventVerificationState = "INSUFFICIENT_FUNDS"
)

func (ParsedWebhookEventVerificationState) IsKnown added in v0.98.0 

func (r ParsedWebhookEventVerificationState) IsKnown() bool

type Payment added in v0.6.5 

type Payment struct {
	// Unique identifier for the transaction
	Token string `json:"token,required" format:"uuid"`
	// Transaction category
	Category PaymentCategory `json:"category,required"`
	// ISO 8601 timestamp of when the transaction was created
	Created time.Time `json:"created,required" format:"date-time"`
	// Transaction descriptor
	Descriptor string `json:"descriptor,required"`
	// Transfer direction
	Direction PaymentDirection `json:"direction,required"`
	// List of transaction events
	Events []PaymentEvent `json:"events,required"`
	// PAYMENT - Payment Transaction
	Family PaymentFamily `json:"family,required"`
	// Financial account token
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Transfer method
	Method PaymentMethod `json:"method,required"`
	// Method-specific attributes
	MethodAttributes PaymentMethodAttributes `json:"method_attributes,required"`
	// Pending amount in cents
	PendingAmount int64 `json:"pending_amount,required"`
	// Account tokens related to a payment transaction
	RelatedAccountTokens PaymentRelatedAccountTokens `json:"related_account_tokens,required,nullable"`
	// Transaction result
	Result PaymentResult `json:"result,required"`
	// Settled amount in cents
	SettledAmount int64 `json:"settled_amount,required"`
	// Transaction source
	Source PaymentSource `json:"source,required"`
	// The status of the transaction
	Status PaymentStatus `json:"status,required"`
	// ISO 8601 timestamp of when the transaction was last updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// Currency of the transaction in ISO 4217 format
	Currency string `json:"currency"`
	// Expected release date for the transaction
	ExpectedReleaseDate time.Time `json:"expected_release_date,nullable" format:"date"`
	// External bank account token
	ExternalBankAccountToken string      `json:"external_bank_account_token,nullable" format:"uuid"`
	Type                     PaymentType `json:"type"`
	// User-defined identifier
	UserDefinedID string      `json:"user_defined_id,nullable"`
	JSON          paymentJSON `json:"-"`
}

Payment transaction

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

Transaction category 

const (
	PaymentCategoryACH                    PaymentCategory = "ACH"
	PaymentCategoryBalanceOrFunding       PaymentCategory = "BALANCE_OR_FUNDING"
	PaymentCategoryFee                    PaymentCategory = "FEE"
	PaymentCategoryReward                 PaymentCategory = "REWARD"
	PaymentCategoryAdjustment             PaymentCategory = "ADJUSTMENT"
	PaymentCategoryDerecognition          PaymentCategory = "DERECOGNITION"
	PaymentCategoryDispute                PaymentCategory = "DISPUTE"
	PaymentCategoryCard                   PaymentCategory = "CARD"
	PaymentCategoryExternalACH            PaymentCategory = "EXTERNAL_ACH"
	PaymentCategoryExternalCheck          PaymentCategory = "EXTERNAL_CHECK"
	PaymentCategoryExternalFednow         PaymentCategory = "EXTERNAL_FEDNOW"
	PaymentCategoryExternalRtp            PaymentCategory = "EXTERNAL_RTP"
	PaymentCategoryExternalTransfer       PaymentCategory = "EXTERNAL_TRANSFER"
	PaymentCategoryExternalWire           PaymentCategory = "EXTERNAL_WIRE"
	PaymentCategoryManagementAdjustment   PaymentCategory = "MANAGEMENT_ADJUSTMENT"
	PaymentCategoryManagementDispute      PaymentCategory = "MANAGEMENT_DISPUTE"
	PaymentCategoryManagementFee          PaymentCategory = "MANAGEMENT_FEE"
	PaymentCategoryManagementReward       PaymentCategory = "MANAGEMENT_REWARD"
	PaymentCategoryManagementDisbursement PaymentCategory = "MANAGEMENT_DISBURSEMENT"
	PaymentCategoryProgramFunding         PaymentCategory = "PROGRAM_FUNDING"
)

func (PaymentCategory) IsKnown added in v0.34.0 

func (r PaymentCategory) IsKnown() bool

type PaymentDirection added in v0.6.5 

type PaymentDirection string

Transfer direction 

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 Federal Reserve.
	//   - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
	//   - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
	//     available balance.
	//   - `ACH_ORIGINATION_REJECTED` - ACH origination was rejected and not sent to the
	//     Federal Reserve.
	//   - `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
	//   - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
	//   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
	//     balance.
	//   - `ACH_RETURN_INITIATED` - ACH initiated return for an ACH receipt.
	//   - `ACH_RETURN_PROCESSED` - ACH receipt returned by the Receiving Depository
	//     Financial Institution.
	//   - `ACH_RETURN_SETTLED` - ACH return settled by the Receiving Depository
	//     Financial Institution.
	//   - `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository
	//     Financial Institution.
	Type PaymentEventsType `json:"type,required"`
	// More detailed reasons for the event
	DetailedResults []PaymentEventsDetailedResult `json:"detailed_results"`
	// Payment event external ID, for example, ACH trace number.
	ExternalID string           `json:"external_id,nullable"`
	JSON       paymentEventJSON `json:"-"`
}

Payment Event

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"
	PaymentEventsDetailedResultDeclined                        PaymentEventsDetailedResult = "DECLINED"
	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 Federal Reserve.
  • `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
  • `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.
  • `ACH_ORIGINATION_REJECTED` - ACH origination was rejected and not sent to the Federal Reserve.
  • `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
  • `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
  • `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.
  • `ACH_RETURN_INITIATED` - ACH initiated return for an ACH receipt.
  • `ACH_RETURN_PROCESSED` - ACH receipt returned by the Receiving Depository Financial Institution.
  • `ACH_RETURN_SETTLED` - ACH return settled by the Receiving Depository Financial Institution.
  • `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository Financial Institution.
const (
	PaymentEventsTypeACHOriginationCancelled PaymentEventsType = "ACH_ORIGINATION_CANCELLED"
	PaymentEventsTypeACHOriginationInitiated PaymentEventsType = "ACH_ORIGINATION_INITIATED"
	PaymentEventsTypeACHOriginationProcessed PaymentEventsType = "ACH_ORIGINATION_PROCESSED"
	PaymentEventsTypeACHOriginationRejected  PaymentEventsType = "ACH_ORIGINATION_REJECTED"
	PaymentEventsTypeACHOriginationReleased  PaymentEventsType = "ACH_ORIGINATION_RELEASED"
	PaymentEventsTypeACHOriginationReviewed  PaymentEventsType = "ACH_ORIGINATION_REVIEWED"
	PaymentEventsTypeACHOriginationSettled   PaymentEventsType = "ACH_ORIGINATION_SETTLED"
	PaymentEventsTypeACHReceiptProcessed     PaymentEventsType = "ACH_RECEIPT_PROCESSED"
	PaymentEventsTypeACHReceiptReleased      PaymentEventsType = "ACH_RECEIPT_RELEASED"
	PaymentEventsTypeACHReceiptSettled       PaymentEventsType = "ACH_RECEIPT_SETTLED"
	PaymentEventsTypeACHReturnInitiated      PaymentEventsType = "ACH_RETURN_INITIATED"
	PaymentEventsTypeACHReturnProcessed      PaymentEventsType = "ACH_RETURN_PROCESSED"
	PaymentEventsTypeACHReturnRejected       PaymentEventsType = "ACH_RETURN_REJECTED"
	PaymentEventsTypeACHReturnSettled        PaymentEventsType = "ACH_RETURN_SETTLED"
)

func (PaymentEventsType) IsKnown added in v0.34.0 

func (r PaymentEventsType) IsKnown() bool

type PaymentFamily added in v0.95.0 

type PaymentFamily string

PAYMENT - Payment Transaction 

const (
	PaymentFamilyPayment PaymentFamily = "PAYMENT"
)

func (PaymentFamily) IsKnown added in v0.95.0 

func (r PaymentFamily) 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

Transfer method 

const (
	PaymentMethodACHNextDay PaymentMethod = "ACH_NEXT_DAY"
	PaymentMethodACHSameDay PaymentMethod = "ACH_SAME_DAY"
	PaymentMethodWire       PaymentMethod = "WIRE"
)

func (PaymentMethod) IsKnown added in v0.27.0 

func (r PaymentMethod) IsKnown() bool

type PaymentMethodAttributes added in v0.6.5 

type PaymentMethodAttributes struct {
	// Number of days the ACH transaction is on hold
	ACHHoldPeriod int64 `json:"ach_hold_period,nullable"`
	// Addenda information
	Addenda string `json:"addenda,nullable"`
	// Company ID for the ACH transaction
	CompanyID string           `json:"company_id,nullable"`
	Creditor  WirePartyDetails `json:"creditor"`
	Debtor    WirePartyDetails `json:"debtor"`
	// Point to point reference identifier, as assigned by the instructing party, used
	// for tracking the message through the Fedwire system
	MessageID string `json:"message_id,nullable"`
	// Receipt routing number
	ReceiptRoutingNumber string `json:"receipt_routing_number,nullable"`
	// Payment details or invoice reference
	RemittanceInformation string `json:"remittance_information,nullable"`
	// Number of retries attempted
	Retries int64 `json:"retries,nullable"`
	// Return reason code if the transaction was returned
	ReturnReasonCode string `json:"return_reason_code,nullable"`
	// SEC code for ACH transaction
	SecCode PaymentMethodAttributesSecCode `json:"sec_code"`
	// This field can have the runtime type of [[]string].
	TraceNumbers interface{} `json:"trace_numbers"`
	// Type of wire message
	WireMessageType string `json:"wire_message_type,nullable"`
	// Type of wire transfer
	WireNetwork PaymentMethodAttributesWireNetwork `json:"wire_network"`
	JSON        paymentMethodAttributesJSON        `json:"-"`
	// contains filtered or unexported fields
}

Method-specific attributes

func (PaymentMethodAttributes) AsUnion added in v0.95.0 

func (r PaymentMethodAttributes) AsUnion() PaymentMethodAttributesUnion

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

Possible runtime types of the union are PaymentMethodAttributesACHMethodAttributes, PaymentMethodAttributesWireMethodAttributes.

func (*PaymentMethodAttributes) UnmarshalJSON added in v0.6.5 

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

type PaymentMethodAttributesACHMethodAttributes added in v0.95.0 

type PaymentMethodAttributesACHMethodAttributes struct {
	// SEC code for ACH transaction
	SecCode PaymentMethodAttributesACHMethodAttributesSecCode `json:"sec_code,required"`
	// Number of days the ACH transaction is on hold
	ACHHoldPeriod int64 `json:"ach_hold_period,nullable"`
	// Addenda information
	Addenda string `json:"addenda,nullable"`
	// Company ID for the ACH transaction
	CompanyID string `json:"company_id,nullable"`
	// Receipt routing number
	ReceiptRoutingNumber string `json:"receipt_routing_number,nullable"`
	// Number of retries attempted
	Retries int64 `json:"retries,nullable"`
	// Return reason code if the transaction was returned
	ReturnReasonCode string `json:"return_reason_code,nullable"`
	// Trace numbers for the ACH transaction
	TraceNumbers []string                                       `json:"trace_numbers"`
	JSON         paymentMethodAttributesACHMethodAttributesJSON `json:"-"`
}

func (*PaymentMethodAttributesACHMethodAttributes) UnmarshalJSON added in v0.95.0 

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

type PaymentMethodAttributesACHMethodAttributesSecCode added in v0.95.0 

type PaymentMethodAttributesACHMethodAttributesSecCode string

SEC code for ACH transaction 

const (
	PaymentMethodAttributesACHMethodAttributesSecCodeCcd PaymentMethodAttributesACHMethodAttributesSecCode = "CCD"
	PaymentMethodAttributesACHMethodAttributesSecCodePpd PaymentMethodAttributesACHMethodAttributesSecCode = "PPD"
	PaymentMethodAttributesACHMethodAttributesSecCodeWeb PaymentMethodAttributesACHMethodAttributesSecCode = "WEB"
	PaymentMethodAttributesACHMethodAttributesSecCodeTel PaymentMethodAttributesACHMethodAttributesSecCode = "TEL"
	PaymentMethodAttributesACHMethodAttributesSecCodeCie PaymentMethodAttributesACHMethodAttributesSecCode = "CIE"
	PaymentMethodAttributesACHMethodAttributesSecCodeCtx PaymentMethodAttributesACHMethodAttributesSecCode = "CTX"
)

func (PaymentMethodAttributesACHMethodAttributesSecCode) IsKnown added in v0.95.0 

func (r PaymentMethodAttributesACHMethodAttributesSecCode) IsKnown() bool

type PaymentMethodAttributesSecCode added in v0.6.5 

type PaymentMethodAttributesSecCode string

SEC code for ACH transaction 

const (
	PaymentMethodAttributesSecCodeCcd PaymentMethodAttributesSecCode = "CCD"
	PaymentMethodAttributesSecCodePpd PaymentMethodAttributesSecCode = "PPD"
	PaymentMethodAttributesSecCodeWeb PaymentMethodAttributesSecCode = "WEB"
	PaymentMethodAttributesSecCodeTel PaymentMethodAttributesSecCode = "TEL"
	PaymentMethodAttributesSecCodeCie PaymentMethodAttributesSecCode = "CIE"
	PaymentMethodAttributesSecCodeCtx PaymentMethodAttributesSecCode = "CTX"
)

func (PaymentMethodAttributesSecCode) IsKnown added in v0.27.0 

func (r PaymentMethodAttributesSecCode) IsKnown() bool

type PaymentMethodAttributesUnion added in v0.95.0 

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

Method-specific attributes

Union satisfied by PaymentMethodAttributesACHMethodAttributes or PaymentMethodAttributesWireMethodAttributes.

type PaymentMethodAttributesWireMethodAttributes added in v0.95.0 

type PaymentMethodAttributesWireMethodAttributes struct {
	// Type of wire message
	WireMessageType string `json:"wire_message_type,required,nullable"`
	// Type of wire transfer
	WireNetwork PaymentMethodAttributesWireMethodAttributesWireNetwork `json:"wire_network,required"`
	Creditor    WirePartyDetails                                       `json:"creditor"`
	Debtor      WirePartyDetails                                       `json:"debtor"`
	// Point to point reference identifier, as assigned by the instructing party, used
	// for tracking the message through the Fedwire system
	MessageID string `json:"message_id,nullable"`
	// Payment details or invoice reference
	RemittanceInformation string                                          `json:"remittance_information,nullable"`
	JSON                  paymentMethodAttributesWireMethodAttributesJSON `json:"-"`
}

func (*PaymentMethodAttributesWireMethodAttributes) UnmarshalJSON added in v0.95.0 

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

type PaymentMethodAttributesWireMethodAttributesWireNetwork added in v0.95.0 

type PaymentMethodAttributesWireMethodAttributesWireNetwork string

Type of wire transfer 

const (
	PaymentMethodAttributesWireMethodAttributesWireNetworkFedwire PaymentMethodAttributesWireMethodAttributesWireNetwork = "FEDWIRE"
	PaymentMethodAttributesWireMethodAttributesWireNetworkSwift   PaymentMethodAttributesWireMethodAttributesWireNetwork = "SWIFT"
)

func (PaymentMethodAttributesWireMethodAttributesWireNetwork) IsKnown added in v0.95.0 

func (r PaymentMethodAttributesWireMethodAttributesWireNetwork) IsKnown() bool

type PaymentMethodAttributesWireNetwork added in v0.95.0 

type PaymentMethodAttributesWireNetwork string

Type of wire transfer 

const (
	PaymentMethodAttributesWireNetworkFedwire PaymentMethodAttributesWireNetwork = "FEDWIRE"
	PaymentMethodAttributesWireNetworkSwift   PaymentMethodAttributesWireNetwork = "SWIFT"
)

func (PaymentMethodAttributesWireNetwork) IsKnown added in v0.95.0 

func (r PaymentMethodAttributesWireNetwork) 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"`
	// Number of days to hold the ACH payment
	ACHHoldPeriod param.Field[int64]  `json:"ach_hold__period"`
	Addenda       param.Field[string] `json:"addenda"`
}

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
}

Payment transaction

func (*PaymentNewResponse) UnmarshalJSON added in v0.6.5 

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

type PaymentRelatedAccountTokens added in v0.87.0 

type PaymentRelatedAccountTokens struct {
	// Globally unique identifier for the account
	AccountToken string `json:"account_token,required,nullable" format:"uuid"`
	// Globally unique identifier for the business account
	BusinessAccountToken string                          `json:"business_account_token,required,nullable" format:"uuid"`
	JSON                 paymentRelatedAccountTokensJSON `json:"-"`
}

Account tokens related to a payment transaction

func (*PaymentRelatedAccountTokens) UnmarshalJSON added in v0.87.0 

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

type PaymentResult added in v0.34.0 

type PaymentResult string

Transaction result 

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
}

Payment transaction

func (*PaymentRetryResponse) UnmarshalJSON added in v0.9.0 

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

type PaymentReturnParams added in v0.96.0 

type PaymentReturnParams struct {
	// Globally unique identifier for the financial account
	FinancialAccountToken param.Field[string] `json:"financial_account_token,required" format:"uuid"`
	// ACH return reason code indicating the reason for returning the payment.
	// Supported codes include R01-R53 and R80-R85. For a complete list of return codes
	// and their meanings, see
	// [ACH Return Reasons](https://docs.lithic.com/docs/ach-overview#ach-return-reasons)
	ReturnReasonCode param.Field[string] `json:"return_reason_code,required"`
	// Optional additional information about the return. Limited to 44 characters
	Addenda param.Field[string] `json:"addenda"`
	// Date of death in YYYY-MM-DD format. Required when using return codes **R14**
	// (representative payee deceased) or **R15** (beneficiary or account holder
	// deceased)
	DateOfDeath param.Field[time.Time] `json:"date_of_death" format:"date"`
	// Optional memo for the return. Limited to 10 characters
	Memo param.Field[string] `json:"memo"`
}

func (PaymentReturnParams) MarshalJSON added in v0.96.0 

func (r PaymentReturnParams) MarshalJSON() (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) Return added in v0.96.0 

func (r *PaymentService) Return(ctx context.Context, paymentToken string, body PaymentReturnParams, opts ...option.RequestOption) (res *Payment, err error)

Return an ACH payment with a specified return reason code. Returns must be initiated within the time window specified by NACHA rules for each return code (typically 2 banking days for most codes, 60 calendar days for unauthorized debits). For a complete list of return codes and their meanings, see the [ACH Return Reasons documentation](https://docs.lithic.com/docs/ach-overview#ach-return-reasons).

Note:

  • This endpoint does not modify the state of the financial account associated with the payment. If you would like to change the account state, use the [Update financial account status](https://docs.lithic.com/reference/updatefinancialaccountstatus) endpoint.
  • By default this endpoint is not enabled for your account. Please contact your implementations manager to enable this feature.

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"`
	// Date of Death for ACH Return
	DateOfDeath param.Field[time.Time] `json:"date_of_death" format:"date"`
	// Decline reason
	DeclineReason param.Field[PaymentSimulateActionParamsDeclineReason] `json:"decline_reason"`
	// Return Addenda
	ReturnAddenda param.Field[string] `json:"return_addenda"`
	// 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"
	PaymentSimulateActionParamsEventTypeACHReceiptReleased      PaymentSimulateActionParamsEventType = "ACH_RECEIPT_RELEASED"
	PaymentSimulateActionParamsEventTypeACHReturnInitiated      PaymentSimulateActionParamsEventType = "ACH_RETURN_INITIATED"
	PaymentSimulateActionParamsEventTypeACHReturnProcessed      PaymentSimulateActionParamsEventType = "ACH_RETURN_PROCESSED"
	PaymentSimulateActionParamsEventTypeACHReturnSettled        PaymentSimulateActionParamsEventType = "ACH_RETURN_SETTLED"
)

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 {
	// Customer-generated payment token used to uniquely identify the simulated payment
	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

Transaction source 

const (
	PaymentSourceLithic   PaymentSource = "LITHIC"
	PaymentSourceExternal PaymentSource = "EXTERNAL"
	PaymentSourceCustomer PaymentSource = "CUSTOMER"
)

func (PaymentSource) IsKnown added in v0.27.0 

func (r PaymentSource) IsKnown() bool

type PaymentStatus added in v0.34.0 

type PaymentStatus string

The status of the transaction 

const (
	PaymentStatusPending  PaymentStatus = "PENDING"
	PaymentStatusSettled  PaymentStatus = "SETTLED"
	PaymentStatusDeclined PaymentStatus = "DECLINED"
	PaymentStatusReversed PaymentStatus = "REVERSED"
	PaymentStatusCanceled PaymentStatus = "CANCELED"
	PaymentStatusReturned PaymentStatus = "RETURNED"
)

func (PaymentStatus) IsKnown added in v0.34.0 

func (r PaymentStatus) IsKnown() bool

type PaymentTransactionCreatedWebhookEvent added in v0.98.0 

type PaymentTransactionCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType PaymentTransactionCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      paymentTransactionCreatedWebhookEventJSON      `json:"-"`
	Payment
}

Payment transaction

func (*PaymentTransactionCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type PaymentTransactionCreatedWebhookEventEventType added in v0.98.0 

type PaymentTransactionCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	PaymentTransactionCreatedWebhookEventEventTypePaymentTransactionCreated PaymentTransactionCreatedWebhookEventEventType = "payment_transaction.created"
)

func (PaymentTransactionCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r PaymentTransactionCreatedWebhookEventEventType) IsKnown() bool

type PaymentTransactionUpdatedWebhookEvent added in v0.98.0 

type PaymentTransactionUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType PaymentTransactionUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      paymentTransactionUpdatedWebhookEventJSON      `json:"-"`
	Payment
}

Payment transaction

func (*PaymentTransactionUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type PaymentTransactionUpdatedWebhookEventEventType added in v0.98.0 

type PaymentTransactionUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	PaymentTransactionUpdatedWebhookEventEventTypePaymentTransactionUpdated PaymentTransactionUpdatedWebhookEventEventType = "payment_transaction.updated"
)

func (PaymentTransactionUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r PaymentTransactionUpdatedWebhookEventEventType) IsKnown() bool

type PaymentType added in v0.89.0 

type PaymentType string
const (
	PaymentTypeOriginationCredit   PaymentType = "ORIGINATION_CREDIT"
	PaymentTypeOriginationDebit    PaymentType = "ORIGINATION_DEBIT"
	PaymentTypeReceiptCredit       PaymentType = "RECEIPT_CREDIT"
	PaymentTypeReceiptDebit        PaymentType = "RECEIPT_DEBIT"
	PaymentTypeWireInboundPayment  PaymentType = "WIRE_INBOUND_PAYMENT"
	PaymentTypeWireInboundAdmin    PaymentType = "WIRE_INBOUND_ADMIN"
	PaymentTypeWireOutboundPayment PaymentType = "WIRE_OUTBOUND_PAYMENT"
	PaymentTypeWireOutboundAdmin   PaymentType = "WIRE_OUTBOUND_ADMIN"
	PaymentTypeWireDrawdownRequest PaymentType = "WIRE_DRAWDOWN_REQUEST"
)

func (PaymentType) IsKnown added in v0.89.0 

func (r PaymentType) IsKnown() bool

type ProvisionResponse added in v0.95.0 

type ProvisionResponse struct {
	ActivationData     string                `json:"activationData"`
	EncryptedData      string                `json:"encryptedData"`
	EphemeralPublicKey string                `json:"ephemeralPublicKey"`
	JSON               provisionResponseJSON `json:"-"`
}

Object containing the fields required to add a card to Apple Pay. Applies only to Apple Pay wallet.

func (ProvisionResponse) ImplementsCardProvisionResponseProvisioningPayloadUnion added in v0.95.0 

func (r ProvisionResponse) ImplementsCardProvisionResponseProvisioningPayloadUnion()

func (*ProvisionResponse) UnmarshalJSON added in v0.95.0 

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

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"`
	// Number of records per page.
	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 ReportSettlementNetworkTotalListParams added in v0.68.0 

type ReportSettlementNetworkTotalListParams struct {
	// Datetime 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"`
	// Datetime 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" format:"uuid"`
	// Institution ID to filter on.
	InstitutionID param.Field[string] `query:"institution_id"`
	// Network to filter on.
	Network param.Field[ReportSettlementNetworkTotalListParamsNetwork] `query:"network"`
	// Number of records per page.
	PageSize param.Field[int64] `query:"page_size"`
	// Singular report date to filter on (YYYY-MM-DD). Cannot be populated in
	// conjunction with report_date_begin or report_date_end.
	ReportDate param.Field[time.Time] `query:"report_date" format:"date"`
	// Earliest report date to filter on, inclusive (YYYY-MM-DD).
	ReportDateBegin param.Field[time.Time] `query:"report_date_begin" format:"date"`
	// Latest report date to filter on, inclusive (YYYY-MM-DD).
	ReportDateEnd param.Field[time.Time] `query:"report_date_end" format:"date"`
	// Settlement institution ID to filter on.
	SettlementInstitutionID param.Field[string] `query:"settlement_institution_id"`
	// 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" format:"uuid"`
}

func (ReportSettlementNetworkTotalListParams) URLQuery added in v0.68.0 

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

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

type ReportSettlementNetworkTotalListParamsNetwork added in v0.68.0 

type ReportSettlementNetworkTotalListParamsNetwork string

Network to filter on. 

const (
	ReportSettlementNetworkTotalListParamsNetworkVisa       ReportSettlementNetworkTotalListParamsNetwork = "VISA"
	ReportSettlementNetworkTotalListParamsNetworkMastercard ReportSettlementNetworkTotalListParamsNetwork = "MASTERCARD"
	ReportSettlementNetworkTotalListParamsNetworkMaestro    ReportSettlementNetworkTotalListParamsNetwork = "MAESTRO"
	ReportSettlementNetworkTotalListParamsNetworkInterlink  ReportSettlementNetworkTotalListParamsNetwork = "INTERLINK"
)

func (ReportSettlementNetworkTotalListParamsNetwork) IsKnown added in v0.68.0 

func (r ReportSettlementNetworkTotalListParamsNetwork) IsKnown() bool

type ReportSettlementNetworkTotalService added in v0.68.0 

type ReportSettlementNetworkTotalService struct {
	Options []option.RequestOption
}

ReportSettlementNetworkTotalService 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 NewReportSettlementNetworkTotalService method instead.

func NewReportSettlementNetworkTotalService added in v0.68.0 

func NewReportSettlementNetworkTotalService(opts ...option.RequestOption) (r *ReportSettlementNetworkTotalService)

NewReportSettlementNetworkTotalService 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 (*ReportSettlementNetworkTotalService) Get added in v0.68.0 

func (r *ReportSettlementNetworkTotalService) Get(ctx context.Context, token string, opts ...option.RequestOption) (res *NetworkTotal, err error)

Retrieve a specific network total record by token. Not available in sandbox.

func (*ReportSettlementNetworkTotalService) List added in v0.68.0 

func (r *ReportSettlementNetworkTotalService) List(ctx context.Context, query ReportSettlementNetworkTotalListParams, opts ...option.RequestOption) (res *pagination.CursorPage[NetworkTotal], err error)

List network total records with optional filters. Not available in sandbox.

func (*ReportSettlementNetworkTotalService) ListAutoPaging added in v0.68.0 

func (r *ReportSettlementNetworkTotalService) ListAutoPaging(ctx context.Context, query ReportSettlementNetworkTotalListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[NetworkTotal]

List network total records with optional filters. Not available in sandbox.

type ReportSettlementService added in v0.9.0 

type ReportSettlementService struct {
	Options       []option.RequestOption
	NetworkTotals *ReportSettlementNetworkTotalService
}

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. Not available in sandbox.

type RequiredDocument added in v0.51.0 

type RequiredDocument struct {
	// Globally unique identifier for an entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Provides 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 RuleStats added in v0.80.0 

type RuleStats struct {
	// The total number of historical transactions approved by this rule during the
	// relevant period, or the number of transactions that would have been approved if
	// the rule was evaluated in shadow mode.
	Approved int64 `json:"approved"`
	// The total number of historical transactions challenged by this rule during the
	// relevant period, or the number of transactions that would have been challenged
	// if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
	// Rules.
	Challenged int64 `json:"challenged"`
	// The total number of historical transactions declined by this rule during the
	// relevant period, or the number of transactions that would have been declined if
	// the rule was evaluated in shadow mode.
	Declined int64 `json:"declined"`
	// Example events and their outcomes.
	Examples []RuleStatsExample `json:"examples"`
	// The version of the rule, this is incremented whenever the rule's parameters
	// change.
	Version int64         `json:"version"`
	JSON    ruleStatsJSON `json:"-"`
}

func (*RuleStats) UnmarshalJSON added in v0.80.0 

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

type RuleStatsExample added in v0.80.0 

type RuleStatsExample struct {
	// Whether the rule would have approved the request.
	Approved bool `json:"approved"`
	// The decision made by the rule for this event.
	Decision RuleStatsExamplesDecision `json:"decision"`
	// The event token.
	EventToken string `json:"event_token" format:"uuid"`
	// The timestamp of the event.
	Timestamp time.Time            `json:"timestamp" format:"date-time"`
	JSON      ruleStatsExampleJSON `json:"-"`
}

func (*RuleStatsExample) UnmarshalJSON added in v0.80.0 

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

type RuleStatsExamplesDecision added in v0.80.0 

type RuleStatsExamplesDecision string

The decision made by the rule for this event. 

const (
	RuleStatsExamplesDecisionApproved   RuleStatsExamplesDecision = "APPROVED"
	RuleStatsExamplesDecisionDeclined   RuleStatsExamplesDecision = "DECLINED"
	RuleStatsExamplesDecisionChallenged RuleStatsExamplesDecision = "CHALLENGED"
)

func (RuleStatsExamplesDecision) IsKnown added in v0.80.0 

func (r RuleStatsExamplesDecision) IsKnown() bool

type SettlementDetail added in v0.9.0 

type SettlementDetail struct {
	// Globally unique identifier denoting the Settlement Detail.
	Token string `json:"token,required" format:"uuid"`
	// Globally unique identifier denoting the account that the associated transaction
	// occurred on.
	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-character 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. One exception
	// applies - for Mastercard dual message settlement, this is the settlement
	// advisement date, which is distinct from the date of money movement.
	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"`
	// Network's description of a fee, only present on records with type `FEE`.
	FeeDescription string               `json:"fee_description"`
	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"
	SettlementDetailTypeCollaboration  SettlementDetailType = "COLLABORATION"
	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"`
	// 3-character alphabetic ISO 4217 code. (This field is deprecated and will be
	// removed in a future version of the API.)
	//
	// Deprecated: deprecated
	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`.)
	//
	// Deprecated: deprecated
	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`.)
	//
	// Deprecated: deprecated
	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`.)
	//
	// Deprecated: deprecated
	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`.)
	//
	// Deprecated: deprecated
	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`.)
	//
	// Deprecated: deprecated
	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 SettlementReportUpdatedWebhookEvent added in v0.98.0 

type SettlementReportUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType SettlementReportUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      settlementReportUpdatedWebhookEventJSON      `json:"-"`
	SettlementReport
}

func (*SettlementReportUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type SettlementReportUpdatedWebhookEventEventType added in v0.98.0 

type SettlementReportUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	SettlementReportUpdatedWebhookEventEventTypeSettlementReportUpdated SettlementReportUpdatedWebhookEventEventType = "settlement_report.updated"
)

func (SettlementReportUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r SettlementReportUpdatedWebhookEventEventType) IsKnown() bool

type SettlementSummaryDetails added in v0.9.0 

type SettlementSummaryDetails struct {
	// 3-character alphabetic ISO 4217 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 when the payment is due
	PaymentDueDate time.Time       `json:"payment_due_date,required,nullable" format:"date"`
	PeriodTotals   StatementTotals `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       StatementTotals          `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"`
	// Details on number and size of payments to pay off balance
	PayoffDetails StatementPayoffDetails `json:"payoff_details,nullable"`
	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"`
	// Information about the financial account state
	FinancialAccountState StatementAccountStandingFinancialAccountState `json:"financial_account_state,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 StatementAccountStandingFinancialAccountState added in v0.71.0 

type StatementAccountStandingFinancialAccountState struct {
	// Status of the financial account
	Status StatementAccountStandingFinancialAccountStateStatus `json:"status,required"`
	// Substatus for the financial account
	Substatus StatementAccountStandingFinancialAccountStateSubstatus `json:"substatus,nullable"`
	JSON      statementAccountStandingFinancialAccountStateJSON      `json:"-"`
}

Information about the financial account state

func (*StatementAccountStandingFinancialAccountState) UnmarshalJSON added in v0.71.0 

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

type StatementAccountStandingFinancialAccountStateStatus added in v0.71.0 

type StatementAccountStandingFinancialAccountStateStatus string

Status of the financial account 

const (
	StatementAccountStandingFinancialAccountStateStatusOpen      StatementAccountStandingFinancialAccountStateStatus = "OPEN"
	StatementAccountStandingFinancialAccountStateStatusClosed    StatementAccountStandingFinancialAccountStateStatus = "CLOSED"
	StatementAccountStandingFinancialAccountStateStatusSuspended StatementAccountStandingFinancialAccountStateStatus = "SUSPENDED"
	StatementAccountStandingFinancialAccountStateStatusPending   StatementAccountStandingFinancialAccountStateStatus = "PENDING"
)

func (StatementAccountStandingFinancialAccountStateStatus) IsKnown added in v0.71.0 

func (r StatementAccountStandingFinancialAccountStateStatus) IsKnown() bool

type StatementAccountStandingFinancialAccountStateSubstatus added in v0.72.0 

type StatementAccountStandingFinancialAccountStateSubstatus string

Substatus for the financial account 

const (
	StatementAccountStandingFinancialAccountStateSubstatusChargedOffDelinquent StatementAccountStandingFinancialAccountStateSubstatus = "CHARGED_OFF_DELINQUENT"
	StatementAccountStandingFinancialAccountStateSubstatusChargedOffFraud      StatementAccountStandingFinancialAccountStateSubstatus = "CHARGED_OFF_FRAUD"
	StatementAccountStandingFinancialAccountStateSubstatusEndUserRequest       StatementAccountStandingFinancialAccountStateSubstatus = "END_USER_REQUEST"
	StatementAccountStandingFinancialAccountStateSubstatusBankRequest          StatementAccountStandingFinancialAccountStateSubstatus = "BANK_REQUEST"
	StatementAccountStandingFinancialAccountStateSubstatusDelinquent           StatementAccountStandingFinancialAccountStateSubstatus = "DELINQUENT"
)

func (StatementAccountStandingFinancialAccountStateSubstatus) IsKnown added in v0.72.0 

func (r StatementAccountStandingFinancialAccountStateSubstatus) IsKnown() bool

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       CategoryDetails                                   `json:"daily_balance_amounts,required"`
	EffectiveApr              CategoryDetails                                   `json:"effective_apr,required"`
	InterestCalculationMethod StatementInterestDetailsInterestCalculationMethod `json:"interest_calculation_method,required"`
	InterestForPeriod         CategoryDetails                                   `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 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 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-character 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"
	StatementLineItemsDataCategoryFee                    StatementLineItemsDataCategory = "FEE"
	StatementLineItemsDataCategoryReward                 StatementLineItemsDataCategory = "REWARD"
	StatementLineItemsDataCategoryAdjustment             StatementLineItemsDataCategory = "ADJUSTMENT"
	StatementLineItemsDataCategoryDerecognition          StatementLineItemsDataCategory = "DERECOGNITION"
	StatementLineItemsDataCategoryDispute                StatementLineItemsDataCategory = "DISPUTE"
	StatementLineItemsDataCategoryCard                   StatementLineItemsDataCategory = "CARD"
	StatementLineItemsDataCategoryExternalACH            StatementLineItemsDataCategory = "EXTERNAL_ACH"
	StatementLineItemsDataCategoryExternalCheck          StatementLineItemsDataCategory = "EXTERNAL_CHECK"
	StatementLineItemsDataCategoryExternalFednow         StatementLineItemsDataCategory = "EXTERNAL_FEDNOW"
	StatementLineItemsDataCategoryExternalRtp            StatementLineItemsDataCategory = "EXTERNAL_RTP"
	StatementLineItemsDataCategoryExternalTransfer       StatementLineItemsDataCategory = "EXTERNAL_TRANSFER"
	StatementLineItemsDataCategoryExternalWire           StatementLineItemsDataCategory = "EXTERNAL_WIRE"
	StatementLineItemsDataCategoryManagementAdjustment   StatementLineItemsDataCategory = "MANAGEMENT_ADJUSTMENT"
	StatementLineItemsDataCategoryManagementDispute      StatementLineItemsDataCategory = "MANAGEMENT_DISPUTE"
	StatementLineItemsDataCategoryManagementFee          StatementLineItemsDataCategory = "MANAGEMENT_FEE"
	StatementLineItemsDataCategoryManagementReward       StatementLineItemsDataCategory = "MANAGEMENT_REWARD"
	StatementLineItemsDataCategoryManagementDisbursement StatementLineItemsDataCategory = "MANAGEMENT_DISBURSEMENT"
	StatementLineItemsDataCategoryProgramFunding         StatementLineItemsDataCategory = "PROGRAM_FUNDING"
)

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"
	StatementLineItemsDataEventTypeACHOriginationRejected       StatementLineItemsDataEventType = "ACH_ORIGINATION_REJECTED"
	StatementLineItemsDataEventTypeACHOriginationReviewed       StatementLineItemsDataEventType = "ACH_ORIGINATION_REVIEWED"
	StatementLineItemsDataEventTypeACHOriginationSettled        StatementLineItemsDataEventType = "ACH_ORIGINATION_SETTLED"
	StatementLineItemsDataEventTypeACHReceiptProcessed          StatementLineItemsDataEventType = "ACH_RECEIPT_PROCESSED"
	StatementLineItemsDataEventTypeACHReceiptReleased           StatementLineItemsDataEventType = "ACH_RECEIPT_RELEASED"
	StatementLineItemsDataEventTypeACHReceiptSettled            StatementLineItemsDataEventType = "ACH_RECEIPT_SETTLED"
	StatementLineItemsDataEventTypeACHReturnInitiated           StatementLineItemsDataEventType = "ACH_RETURN_INITIATED"
	StatementLineItemsDataEventTypeACHReturnProcessed           StatementLineItemsDataEventType = "ACH_RETURN_PROCESSED"
	StatementLineItemsDataEventTypeACHReturnRejected            StatementLineItemsDataEventType = "ACH_RETURN_REJECTED"
	StatementLineItemsDataEventTypeACHReturnSettled             StatementLineItemsDataEventType = "ACH_RETURN_SETTLED"
	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"
	StatementLineItemsDataEventTypeCollection                   StatementLineItemsDataEventType = "COLLECTION"
	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"
	StatementLineItemsDataEventTypeExternalFednowCanceled       StatementLineItemsDataEventType = "EXTERNAL_FEDNOW_CANCELED"
	StatementLineItemsDataEventTypeExternalFednowInitiated      StatementLineItemsDataEventType = "EXTERNAL_FEDNOW_INITIATED"
	StatementLineItemsDataEventTypeExternalFednowReleased       StatementLineItemsDataEventType = "EXTERNAL_FEDNOW_RELEASED"
	StatementLineItemsDataEventTypeExternalFednowReversed       StatementLineItemsDataEventType = "EXTERNAL_FEDNOW_REVERSED"
	StatementLineItemsDataEventTypeExternalFednowSettled        StatementLineItemsDataEventType = "EXTERNAL_FEDNOW_SETTLED"
	StatementLineItemsDataEventTypeExternalRtpCanceled          StatementLineItemsDataEventType = "EXTERNAL_RTP_CANCELED"
	StatementLineItemsDataEventTypeExternalRtpInitiated         StatementLineItemsDataEventType = "EXTERNAL_RTP_INITIATED"
	StatementLineItemsDataEventTypeExternalRtpReleased          StatementLineItemsDataEventType = "EXTERNAL_RTP_RELEASED"
	StatementLineItemsDataEventTypeExternalRtpReversed          StatementLineItemsDataEventType = "EXTERNAL_RTP_REVERSED"
	StatementLineItemsDataEventTypeExternalRtpSettled           StatementLineItemsDataEventType = "EXTERNAL_RTP_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"
	StatementLineItemsDataEventTypeInternalAdjustment           StatementLineItemsDataEventType = "INTERNAL_ADJUSTMENT"
	StatementLineItemsDataEventTypeLatePayment                  StatementLineItemsDataEventType = "LATE_PAYMENT"
	StatementLineItemsDataEventTypeLatePaymentReversal          StatementLineItemsDataEventType = "LATE_PAYMENT_REVERSAL"
	StatementLineItemsDataEventTypeLossWriteOff                 StatementLineItemsDataEventType = "LOSS_WRITE_OFF"
	StatementLineItemsDataEventTypeProvisionalCredit            StatementLineItemsDataEventType = "PROVISIONAL_CREDIT"
	StatementLineItemsDataEventTypeProvisionalCreditReversal    StatementLineItemsDataEventType = "PROVISIONAL_CREDIT_REVERSAL"
	StatementLineItemsDataEventTypeService                      StatementLineItemsDataEventType = "SERVICE"
	StatementLineItemsDataEventTypeReturn                       StatementLineItemsDataEventType = "RETURN"
	StatementLineItemsDataEventTypeReturnReversal               StatementLineItemsDataEventType = "RETURN_REVERSAL"
	StatementLineItemsDataEventTypeTransfer                     StatementLineItemsDataEventType = "TRANSFER"
	StatementLineItemsDataEventTypeTransferInsufficientFunds    StatementLineItemsDataEventType = "TRANSFER_INSUFFICIENT_FUNDS"
	StatementLineItemsDataEventTypeReturnedPayment              StatementLineItemsDataEventType = "RETURNED_PAYMENT"
	StatementLineItemsDataEventTypeReturnedPaymentReversal      StatementLineItemsDataEventType = "RETURNED_PAYMENT_REVERSAL"
	StatementLineItemsDataEventTypeLithicNetworkPayment         StatementLineItemsDataEventType = "LITHIC_NETWORK_PAYMENT"
	StatementLineItemsDataEventTypeAnnual                       StatementLineItemsDataEventType = "ANNUAL"
	StatementLineItemsDataEventTypeAnnualReversal               StatementLineItemsDataEventType = "ANNUAL_REVERSAL"
	StatementLineItemsDataEventTypeQuarterly                    StatementLineItemsDataEventType = "QUARTERLY"
	StatementLineItemsDataEventTypeQuarterlyReversal            StatementLineItemsDataEventType = "QUARTERLY_REVERSAL"
	StatementLineItemsDataEventTypeMonthly                      StatementLineItemsDataEventType = "MONTHLY"
	StatementLineItemsDataEventTypeMonthlyReversal              StatementLineItemsDataEventType = "MONTHLY_REVERSAL"
)

func (StatementLineItemsDataEventType) IsKnown added in v0.40.0 

func (r StatementLineItemsDataEventType) IsKnown() bool

type StatementPayoffDetails added in v0.97.0 

type StatementPayoffDetails struct {
	// The number of months it would take to pay off the balance in full by only paying
	// the minimum payment. "NA" will signal negative or zero amortization
	MinimumPaymentMonths string `json:"minimum_payment_months,required"`
	// The sum of all interest and principal paid, in cents, when only paying minimum
	// monthly payment. "NA" will signal negative or zero amortization
	MinimumPaymentTotal string `json:"minimum_payment_total,required"`
	// Number of months to full pay off
	PayoffPeriodLengthMonths int64 `json:"payoff_period_length_months,required,nullable"`
	// The amount needed to be paid, in cents, each month in order to pay off current
	// balance in the payoff period
	PayoffPeriodMonthlyPaymentAmount int64 `json:"payoff_period_monthly_payment_amount,required,nullable"`
	// The sum of all interest and principal paid, in cents, when paying off in the
	// payoff period
	PayoffPeriodPaymentTotal int64                      `json:"payoff_period_payment_total,required,nullable"`
	JSON                     statementPayoffDetailsJSON `json:"-"`
}

Details on number and size of payments to pay off balance

func (*StatementPayoffDetails) UnmarshalJSON added in v0.97.0 

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

type StatementStatementType added in v0.57.0 

type StatementStatementType string
const (
	StatementStatementTypeInitial   StatementStatementType = "INITIAL"
	StatementStatementTypePeriodEnd StatementStatementType = "PERIOD_END"
	StatementStatementTypeFinal     StatementStatementType = "FINAL"
)

func (StatementStatementType) IsKnown added in v0.57.0 

func (r StatementStatementType) IsKnown() bool

type StatementTotals added in v0.96.0 

type StatementTotals 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
	Debits int64 `json:"debits,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"`
	// Breakdown of credits
	CreditDetails interface{} `json:"credit_details"`
	// Breakdown of debits
	DebitDetails interface{} `json:"debit_details"`
	// Breakdown of payments
	PaymentDetails interface{}         `json:"payment_details"`
	JSON           statementTotalsJSON `json:"-"`
}

func (*StatementTotals) UnmarshalJSON added in v0.96.0 

func (r *StatementTotals) 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 StatementsCreatedWebhookEvent added in v0.98.0 

type StatementsCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType StatementsCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      statementsCreatedWebhookEventJSON      `json:"-"`
	Statement
}

func (*StatementsCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type StatementsCreatedWebhookEventEventType added in v0.98.0 

type StatementsCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	StatementsCreatedWebhookEventEventTypeStatementsCreated StatementsCreatedWebhookEventEventType = "statements.created"
)

func (StatementsCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r StatementsCreatedWebhookEventEventType) IsKnown() bool

type ThreeDSAuthentication added in v0.98.0 

type ThreeDSAuthentication struct {
	// Globally unique identifier for the 3DS authentication. Permitted values:
	// 36-digit version 4 UUID (including hyphens).
	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 ThreeDSAuthenticationAccountType `json:"account_type,required,nullable"`
	// Indicates the outcome of the 3DS authentication process.
	AuthenticationResult ThreeDSAuthenticationAuthenticationResult `json:"authentication_result,required"`
	// Indicates whether the expiration date provided by the cardholder during checkout
	// matches Lithic's record of the card's expiration date.
	CardExpiryCheck ThreeDSAuthenticationCardExpiryCheck `json:"card_expiry_check,required"`
	// Globally unique identifier for the card on which the 3DS authentication has
	// occurred. Permitted values: 36-digit version 4 UUID (including hyphens).
	CardToken string `json:"card_token,required" format:"uuid"`
	// Object containing data about the cardholder provided during the transaction.
	Cardholder ThreeDSAuthenticationCardholder `json:"cardholder,required"`
	// Channel in which the authentication occurs. Maps to EMV 3DS field
	// `deviceChannel`.
	Channel ThreeDSAuthenticationChannel `json:"channel,required"`
	// Date and time when the authentication was created in Lithic's system. Permitted
	// values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.
	Created time.Time `json:"created,required" format:"date-time"`
	// Object containing data about the merchant involved in the e-commerce
	// transaction.
	Merchant ThreeDSAuthenticationMerchant `json:"merchant,required"`
	// Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
	// NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
	// populated.
	MessageCategory ThreeDSAuthenticationMessageCategory `json:"message_category,required"`
	// Indicates whether a challenge is requested for this transaction
	//
	//   - `NO_PREFERENCE` - No Preference
	//   - `NO_CHALLENGE_REQUESTED` - No Challenge Requested
	//   - `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
	//   - `CHALLENGE_MANDATE` - Challenge requested (Mandate)
	//   - `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional
	//     risk analysis is already performed)
	//   - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
	//   - `OTHER` - Other indicators not captured by above. These are rarely used
	ThreeDSRequestorChallengeIndicator ThreeDSAuthenticationThreeDSRequestorChallengeIndicator `json:"three_ds_requestor_challenge_indicator,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 ThreeDSAuthenticationAdditionalData `json:"additional_data,nullable"`
	// Object containing data about the app used in the e-commerce transaction. Present
	// if the channel is 'APP_BASED'.
	App ThreeDSAuthenticationApp `json:"app,nullable"`
	// 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 ThreeDSAuthenticationAuthenticationRequestType `json:"authentication_request_type,nullable"`
	// Object containing data about the browser used in the e-commerce transaction.
	// Present if the channel is 'BROWSER'.
	Browser ThreeDSAuthenticationBrowser `json:"browser,nullable"`
	// Metadata about the challenge method and delivery. Only present when a challenge
	// is triggered.
	ChallengeMetadata ThreeDSAuthenticationChallengeMetadata `json:"challenge_metadata,nullable"`
	// Entity that orchestrates the challenge. This won't be set for authentications
	// for which a decision has not yet been made (e.g. in-flight customer decisioning
	// request).
	ChallengeOrchestratedBy ThreeDSAuthenticationChallengeOrchestratedBy `json:"challenge_orchestrated_by,nullable"`
	// Entity that made the authentication decision. This won't be set for
	// authentications for which a decision has not yet been made (e.g. in-flight
	// customer decisioning request).
	DecisionMadeBy ThreeDSAuthenticationDecisionMadeBy `json:"decision_made_by,nullable"`
	// 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 ThreeDSAuthenticationThreeRiRequestType `json:"three_ri_request_type,nullable"`
	// Object containing data about the e-commerce transaction for which the merchant
	// is requesting authentication.
	Transaction ThreeDSAuthenticationTransaction `json:"transaction,nullable"`
	JSON        threeDSAuthenticationJSON        `json:"-"`
}

Represents a 3DS authentication

func (*ThreeDSAuthentication) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationAccountType added in v0.98.0 

type ThreeDSAuthenticationAccountType string

Type of account/card that is being used for the transaction. Maps to EMV 3DS field `acctType`. 

const (
	ThreeDSAuthenticationAccountTypeCredit        ThreeDSAuthenticationAccountType = "CREDIT"
	ThreeDSAuthenticationAccountTypeDebit         ThreeDSAuthenticationAccountType = "DEBIT"
	ThreeDSAuthenticationAccountTypeNotApplicable ThreeDSAuthenticationAccountType = "NOT_APPLICABLE"
)

func (ThreeDSAuthenticationAccountType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationAccountType) IsKnown() bool

type ThreeDSAuthenticationAdditionalData added in v0.98.0 

type ThreeDSAuthenticationAdditionalData struct {
	// Mastercard only: Indicates whether the network would have considered the
	// authentication request to be low risk or not.
	NetworkDecision ThreeDSAuthenticationAdditionalDataNetworkDecision `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. Permitted values:
	// Integer between 0-950, in increments of 50.
	NetworkRiskScore int64                                   `json:"network_risk_score,nullable"`
	JSON             threeDSAuthenticationAdditionalDataJSON `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 (*ThreeDSAuthenticationAdditionalData) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationAdditionalDataNetworkDecision added in v0.98.0 

type ThreeDSAuthenticationAdditionalDataNetworkDecision string

Mastercard only: Indicates whether the network would have considered the authentication request to be low risk or not. 

const (
	ThreeDSAuthenticationAdditionalDataNetworkDecisionLowRisk    ThreeDSAuthenticationAdditionalDataNetworkDecision = "LOW_RISK"
	ThreeDSAuthenticationAdditionalDataNetworkDecisionNotLowRisk ThreeDSAuthenticationAdditionalDataNetworkDecision = "NOT_LOW_RISK"
)

func (ThreeDSAuthenticationAdditionalDataNetworkDecision) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationAdditionalDataNetworkDecision) IsKnown() bool

type ThreeDSAuthenticationApp added in v0.98.0 

type ThreeDSAuthenticationApp struct {
	// Device model: e.g. "Apple iPhone 16".
	Device string `json:"device,nullable"`
	// Raw device information - base64-encoded JSON object. Maps to EMV 3DS field
	// `deviceInfo`.
	DeviceInfo string `json:"device_info,nullable"`
	// IP address of the device.
	Ip string `json:"ip"`
	// Latitude coordinate of current device location.
	Latitude float64 `json:"latitude,nullable"`
	// Device locale: e.g. "en-US".
	Locale string `json:"locale,nullable"`
	// Longitude coordinate of current device location.
	Longitude float64 `json:"longitude,nullable"`
	// Operating System: e.g. "Android 12", "iOS 17.1".
	Os string `json:"os,nullable"`
	// Device platform: Android, iOS, Windows, etc.
	Platform string `json:"platform,nullable"`
	// Screen height in pixels.
	ScreenHeight int64 `json:"screen_height,nullable"`
	// Screen width in pixels.
	ScreenWidth int64 `json:"screen_width,nullable"`
	// Time zone offset in minutes between UTC and device local time.
	TimeZone string                       `json:"time_zone,nullable"`
	JSON     threeDSAuthenticationAppJSON `json:"-"`
}

Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

func (*ThreeDSAuthenticationApp) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationApprovalRequestWebhookEvent added in v0.99.0 

type ThreeDSAuthenticationApprovalRequestWebhookEvent struct {
	EventType ThreeDSAuthenticationApprovalRequestWebhookEventEventType `json:"event_type,required"`
	JSON      threeDSAuthenticationApprovalRequestWebhookEventJSON      `json:"-"`
	ThreeDSAuthentication
}

Represents a 3DS authentication

func (*ThreeDSAuthenticationApprovalRequestWebhookEvent) UnmarshalJSON added in v0.99.0 

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

type ThreeDSAuthenticationApprovalRequestWebhookEventEventType added in v0.99.0 

type ThreeDSAuthenticationApprovalRequestWebhookEventEventType string
const (
	ThreeDSAuthenticationApprovalRequestWebhookEventEventTypeThreeDSAuthenticationApprovalRequest ThreeDSAuthenticationApprovalRequestWebhookEventEventType = "three_ds_authentication.approval_request"
)

func (ThreeDSAuthenticationApprovalRequestWebhookEventEventType) IsKnown added in v0.99.0 

func (r ThreeDSAuthenticationApprovalRequestWebhookEventEventType) IsKnown() bool

type ThreeDSAuthenticationAuthenticationRequestType added in v0.98.0 

type ThreeDSAuthenticationAuthenticationRequestType 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 (
	ThreeDSAuthenticationAuthenticationRequestTypeAddCard                        ThreeDSAuthenticationAuthenticationRequestType = "ADD_CARD"
	ThreeDSAuthenticationAuthenticationRequestTypeBillingAgreement               ThreeDSAuthenticationAuthenticationRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationAuthenticationRequestTypeDelayedShipment                ThreeDSAuthenticationAuthenticationRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationAuthenticationRequestTypeEmvTokenCardholderVerification ThreeDSAuthenticationAuthenticationRequestType = "EMV_TOKEN_CARDHOLDER_VERIFICATION"
	ThreeDSAuthenticationAuthenticationRequestTypeInstallmentTransaction         ThreeDSAuthenticationAuthenticationRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationAuthenticationRequestTypeMaintainCard                   ThreeDSAuthenticationAuthenticationRequestType = "MAINTAIN_CARD"
	ThreeDSAuthenticationAuthenticationRequestTypePaymentTransaction             ThreeDSAuthenticationAuthenticationRequestType = "PAYMENT_TRANSACTION"
	ThreeDSAuthenticationAuthenticationRequestTypeRecurringTransaction           ThreeDSAuthenticationAuthenticationRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationAuthenticationRequestTypeSplitPayment                   ThreeDSAuthenticationAuthenticationRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationAuthenticationRequestTypeSplitShipment                  ThreeDSAuthenticationAuthenticationRequestType = "SPLIT_SHIPMENT"
)

func (ThreeDSAuthenticationAuthenticationRequestType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationAuthenticationRequestType) IsKnown() bool

type ThreeDSAuthenticationAuthenticationResult added in v0.98.0 

type ThreeDSAuthenticationAuthenticationResult string

Indicates the outcome of the 3DS authentication process. 

const (
	ThreeDSAuthenticationAuthenticationResultDecline          ThreeDSAuthenticationAuthenticationResult = "DECLINE"
	ThreeDSAuthenticationAuthenticationResultSuccess          ThreeDSAuthenticationAuthenticationResult = "SUCCESS"
	ThreeDSAuthenticationAuthenticationResultPendingChallenge ThreeDSAuthenticationAuthenticationResult = "PENDING_CHALLENGE"
	ThreeDSAuthenticationAuthenticationResultPendingDecision  ThreeDSAuthenticationAuthenticationResult = "PENDING_DECISION"
)

func (ThreeDSAuthenticationAuthenticationResult) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationAuthenticationResult) IsKnown() bool

type ThreeDSAuthenticationBrowser added in v0.98.0 

type ThreeDSAuthenticationBrowser struct {
	// Content of the HTTP accept headers as sent from the cardholder's browser to the
	// 3DS requestor (e.g., merchant or digital wallet).
	AcceptHeader string `json:"accept_header,nullable"`
	// 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 offset in minutes between UTC and browser local time. 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      threeDSAuthenticationBrowserJSON `json:"-"`
}

Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

func (*ThreeDSAuthenticationBrowser) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationCardExpiryCheck added in v0.98.0 

type ThreeDSAuthenticationCardExpiryCheck string

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. 

const (
	ThreeDSAuthenticationCardExpiryCheckMatch      ThreeDSAuthenticationCardExpiryCheck = "MATCH"
	ThreeDSAuthenticationCardExpiryCheckMismatch   ThreeDSAuthenticationCardExpiryCheck = "MISMATCH"
	ThreeDSAuthenticationCardExpiryCheckNotPresent ThreeDSAuthenticationCardExpiryCheck = "NOT_PRESENT"
)

func (ThreeDSAuthenticationCardExpiryCheck) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationCardExpiryCheck) IsKnown() bool

type ThreeDSAuthenticationCardholder added in v0.98.0 

type ThreeDSAuthenticationCardholder 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"`
	// Lithic's evaluation result comparing the transaction's address data with the
	// cardholder KYC data if it exists. In the event Lithic does not have any
	// Cardholder KYC data, or the transaction does not contain any address data,
	// NOT_PRESENT will be returned
	AddressOnFileMatch ThreeDSAuthenticationCardholderAddressOnFileMatch `json:"address_on_file_match"`
	// Object containing data on the billing address provided during the transaction.
	BillingAddress ThreeDSAuthenticationCardholderBillingAddress `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 in E.164 format 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 in E.164 format provided by the cardholder. Maps to EMV
	// 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`.
	PhoneNumberMobile string `json:"phone_number_mobile,nullable"`
	// Work phone number in E.164 format 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 ThreeDSAuthenticationCardholderShippingAddress `json:"shipping_address"`
	JSON            threeDSAuthenticationCardholderJSON            `json:"-"`
}

Object containing data about the cardholder provided during the transaction.

func (*ThreeDSAuthenticationCardholder) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationCardholderAddressOnFileMatch added in v0.98.0 

type ThreeDSAuthenticationCardholderAddressOnFileMatch string

Lithic's evaluation result comparing the transaction's address data with the cardholder KYC data if it exists. In the event Lithic does not have any Cardholder KYC data, or the transaction does not contain any address data, NOT_PRESENT will be returned 

const (
	ThreeDSAuthenticationCardholderAddressOnFileMatchMatch            ThreeDSAuthenticationCardholderAddressOnFileMatch = "MATCH"
	ThreeDSAuthenticationCardholderAddressOnFileMatchMatchAddressOnly ThreeDSAuthenticationCardholderAddressOnFileMatch = "MATCH_ADDRESS_ONLY"
	ThreeDSAuthenticationCardholderAddressOnFileMatchMatchZipOnly     ThreeDSAuthenticationCardholderAddressOnFileMatch = "MATCH_ZIP_ONLY"
	ThreeDSAuthenticationCardholderAddressOnFileMatchMismatch         ThreeDSAuthenticationCardholderAddressOnFileMatch = "MISMATCH"
	ThreeDSAuthenticationCardholderAddressOnFileMatchNotPresent       ThreeDSAuthenticationCardholderAddressOnFileMatch = "NOT_PRESENT"
)

func (ThreeDSAuthenticationCardholderAddressOnFileMatch) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationCardholderAddressOnFileMatch) IsKnown() bool

type ThreeDSAuthenticationCardholderBillingAddress added in v0.98.0 

type ThreeDSAuthenticationCardholderBillingAddress 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       threeDSAuthenticationCardholderBillingAddressJSON `json:"-"`
}

Object containing data on the billing address provided during the transaction.

func (*ThreeDSAuthenticationCardholderBillingAddress) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationCardholderShippingAddress added in v0.98.0 

type ThreeDSAuthenticationCardholderShippingAddress 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       threeDSAuthenticationCardholderShippingAddressJSON `json:"-"`
}

Object containing data on the shipping address provided during the transaction.

func (*ThreeDSAuthenticationCardholderShippingAddress) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationChallengeMetadata added in v0.98.0 

type ThreeDSAuthenticationChallengeMetadata struct {
	// The type of challenge method used for authentication.
	MethodType ThreeDSAuthenticationChallengeMetadataMethodType `json:"method_type,required"`
	// Indicates the status of the challenge
	//
	//   - SUCCESS - Cardholder completed the challenge successfully
	//   - PENDING - Challenge was issued to the cardholder and was not completed yet
	//   - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
	//     provided phone number. Relevant only for SMS_OTP method
	//   - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
	//     given challenge TTL
	//   - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
	//     "cancel" on the challenge UI
	//   - CANCELED_OOB - Cardholder canceled the challenge out of band
	//   - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
	//     incorrect OTP more than the allowed number of times or requesting a new OTP
	//     more than the allowed number of times
	//   - ABORTED - Merchant aborted authentication after a challenge was requested
	//   - ERROR - The challenge failed for a reason different than those documented
	Status ThreeDSAuthenticationChallengeMetadataStatus `json:"status,required"`
	// The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
	PhoneNumber string                                     `json:"phone_number,nullable"`
	JSON        threeDSAuthenticationChallengeMetadataJSON `json:"-"`
}

Metadata about the challenge method and delivery. Only present when a challenge is triggered.

func (*ThreeDSAuthenticationChallengeMetadata) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationChallengeMetadataMethodType added in v0.98.0 

type ThreeDSAuthenticationChallengeMetadataMethodType string

The type of challenge method used for authentication. 

const (
	ThreeDSAuthenticationChallengeMetadataMethodTypeSMSOtp    ThreeDSAuthenticationChallengeMetadataMethodType = "SMS_OTP"
	ThreeDSAuthenticationChallengeMetadataMethodTypeOutOfBand ThreeDSAuthenticationChallengeMetadataMethodType = "OUT_OF_BAND"
)

func (ThreeDSAuthenticationChallengeMetadataMethodType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChallengeMetadataMethodType) IsKnown() bool

type ThreeDSAuthenticationChallengeMetadataStatus added in v0.98.0 

type ThreeDSAuthenticationChallengeMetadataStatus string

Indicates the status of the challenge

  • SUCCESS - Cardholder completed the challenge successfully
  • PENDING - Challenge was issued to the cardholder and was not completed yet
  • SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the provided phone number. Relevant only for SMS_OTP method
  • CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the given challenge TTL
  • CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting "cancel" on the challenge UI
  • CANCELED_OOB - Cardholder canceled the challenge out of band
  • ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an incorrect OTP more than the allowed number of times or requesting a new OTP more than the allowed number of times
  • ABORTED - Merchant aborted authentication after a challenge was requested
  • ERROR - The challenge failed for a reason different than those documented
const (
	ThreeDSAuthenticationChallengeMetadataStatusSuccess                ThreeDSAuthenticationChallengeMetadataStatus = "SUCCESS"
	ThreeDSAuthenticationChallengeMetadataStatusPending                ThreeDSAuthenticationChallengeMetadataStatus = "PENDING"
	ThreeDSAuthenticationChallengeMetadataStatusSMSDeliveryFailed      ThreeDSAuthenticationChallengeMetadataStatus = "SMS_DELIVERY_FAILED"
	ThreeDSAuthenticationChallengeMetadataStatusCardholderTimeout      ThreeDSAuthenticationChallengeMetadataStatus = "CARDHOLDER_TIMEOUT"
	ThreeDSAuthenticationChallengeMetadataStatusCanceledViaChallengeUi ThreeDSAuthenticationChallengeMetadataStatus = "CANCELED_VIA_CHALLENGE_UI"
	ThreeDSAuthenticationChallengeMetadataStatusCanceledOob            ThreeDSAuthenticationChallengeMetadataStatus = "CANCELED_OOB"
	ThreeDSAuthenticationChallengeMetadataStatusAttemptsExceeded       ThreeDSAuthenticationChallengeMetadataStatus = "ATTEMPTS_EXCEEDED"
	ThreeDSAuthenticationChallengeMetadataStatusAborted                ThreeDSAuthenticationChallengeMetadataStatus = "ABORTED"
	ThreeDSAuthenticationChallengeMetadataStatusError                  ThreeDSAuthenticationChallengeMetadataStatus = "ERROR"
)

func (ThreeDSAuthenticationChallengeMetadataStatus) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChallengeMetadataStatus) IsKnown() bool

type ThreeDSAuthenticationChallengeOrchestratedBy added in v0.98.0 

type ThreeDSAuthenticationChallengeOrchestratedBy string

Entity that orchestrates the challenge. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request). 

const (
	ThreeDSAuthenticationChallengeOrchestratedByLithic      ThreeDSAuthenticationChallengeOrchestratedBy = "LITHIC"
	ThreeDSAuthenticationChallengeOrchestratedByCustomer    ThreeDSAuthenticationChallengeOrchestratedBy = "CUSTOMER"
	ThreeDSAuthenticationChallengeOrchestratedByNoChallenge ThreeDSAuthenticationChallengeOrchestratedBy = "NO_CHALLENGE"
)

func (ThreeDSAuthenticationChallengeOrchestratedBy) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChallengeOrchestratedBy) IsKnown() bool

type ThreeDSAuthenticationChallengeWebhookEvent added in v0.98.0 

type ThreeDSAuthenticationChallengeWebhookEvent struct {
	// Represents a 3DS authentication
	AuthenticationObject ThreeDSAuthentication `json:"authentication_object,required"`
	// Represents a challenge object for 3DS authentication
	Challenge ThreeDSAuthenticationChallengeWebhookEventChallenge `json:"challenge,required"`
	EventType ThreeDSAuthenticationChallengeWebhookEventEventType `json:"event_type,required"`
	JSON      threeDSAuthenticationChallengeWebhookEventJSON      `json:"-"`
}

func (*ThreeDSAuthenticationChallengeWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationChallengeWebhookEventChallenge added in v0.98.0 

type ThreeDSAuthenticationChallengeWebhookEventChallenge struct {
	// The type of challenge method issued to the cardholder
	ChallengeMethodType ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType `json:"challenge_method_type,required"`
	// ISO-8601 time at which the challenge expires
	ExpiryTime time.Time `json:"expiry_time,required" format:"date-time"`
	// ISO-8601 time at which the challenge has started
	StartTime time.Time `json:"start_time,required" format:"date-time"`
	// Fully qualified app URL of the merchant app. This should be used to redirect the
	// cardholder back to the merchant app after completing an app-based challenge.
	// This URL will only be populated if the 3DS Requestor App is provided to the 3DS
	// SDK.
	AppRequestorURL string                                                  `json:"app_requestor_url,nullable" format:"uri"`
	JSON            threeDSAuthenticationChallengeWebhookEventChallengeJSON `json:"-"`
}

Represents a challenge object for 3DS authentication

func (*ThreeDSAuthenticationChallengeWebhookEventChallenge) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType added in v0.98.0 

type ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType string

The type of challenge method issued to the cardholder 

const (
	ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodTypeOutOfBand ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType = "OUT_OF_BAND"
)

func (ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChallengeWebhookEventChallengeChallengeMethodType) IsKnown() bool

type ThreeDSAuthenticationChallengeWebhookEventEventType added in v0.98.0 

type ThreeDSAuthenticationChallengeWebhookEventEventType string
const (
	ThreeDSAuthenticationChallengeWebhookEventEventTypeThreeDSAuthenticationChallenge ThreeDSAuthenticationChallengeWebhookEventEventType = "three_ds_authentication.challenge"
)

func (ThreeDSAuthenticationChallengeWebhookEventEventType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChallengeWebhookEventEventType) IsKnown() bool

type ThreeDSAuthenticationChannel added in v0.98.0 

type ThreeDSAuthenticationChannel string

Channel in which the authentication occurs. Maps to EMV 3DS field `deviceChannel`. 

const (
	ThreeDSAuthenticationChannelAppBased                  ThreeDSAuthenticationChannel = "APP_BASED"
	ThreeDSAuthenticationChannelBrowser                   ThreeDSAuthenticationChannel = "BROWSER"
	ThreeDSAuthenticationChannelThreeDSRequestorInitiated ThreeDSAuthenticationChannel = "THREE_DS_REQUESTOR_INITIATED"
)

func (ThreeDSAuthenticationChannel) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationChannel) IsKnown() bool

type ThreeDSAuthenticationCreatedWebhookEvent added in v0.98.0 

type ThreeDSAuthenticationCreatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ThreeDSAuthenticationCreatedWebhookEventEventType `json:"event_type,required"`
	JSON      threeDSAuthenticationCreatedWebhookEventJSON      `json:"-"`
	ThreeDSAuthentication
}

Represents a 3DS authentication

func (*ThreeDSAuthenticationCreatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationCreatedWebhookEventEventType added in v0.98.0 

type ThreeDSAuthenticationCreatedWebhookEventEventType string

The type of event that occurred. 

const (
	ThreeDSAuthenticationCreatedWebhookEventEventTypeThreeDSAuthenticationCreated ThreeDSAuthenticationCreatedWebhookEventEventType = "three_ds_authentication.created"
)

func (ThreeDSAuthenticationCreatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationCreatedWebhookEventEventType) IsKnown() bool

type ThreeDSAuthenticationDecisionMadeBy added in v0.98.0 

type ThreeDSAuthenticationDecisionMadeBy string

Entity that made the authentication decision. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request). 

const (
	ThreeDSAuthenticationDecisionMadeByLithicRules      ThreeDSAuthenticationDecisionMadeBy = "LITHIC_RULES"
	ThreeDSAuthenticationDecisionMadeByLithicDefault    ThreeDSAuthenticationDecisionMadeBy = "LITHIC_DEFAULT"
	ThreeDSAuthenticationDecisionMadeByCustomerRules    ThreeDSAuthenticationDecisionMadeBy = "CUSTOMER_RULES"
	ThreeDSAuthenticationDecisionMadeByCustomerEndpoint ThreeDSAuthenticationDecisionMadeBy = "CUSTOMER_ENDPOINT"
	ThreeDSAuthenticationDecisionMadeByNetwork          ThreeDSAuthenticationDecisionMadeBy = "NETWORK"
	ThreeDSAuthenticationDecisionMadeByUnknown          ThreeDSAuthenticationDecisionMadeBy = "UNKNOWN"
)

func (ThreeDSAuthenticationDecisionMadeBy) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationDecisionMadeBy) IsKnown() bool

type ThreeDSAuthenticationMerchant added in v0.98.0 

type ThreeDSAuthenticationMerchant struct {
	// Object containing additional data indicating additional risk factors related to
	// the e-commerce transaction.
	RiskIndicator ThreeDSAuthenticationMerchantRiskIndicator `json:"risk_indicator,required"`
	// Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
	// `acquirerMerchantId`. May not be present for non-payment authentications.
	ID string `json:"id,nullable"`
	// Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
	// field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
	// (e.g., USA). May not be present for non-payment authentications.
	Country string `json:"country,nullable"`
	// Merchant category code assigned to the merchant that describes its business
	// activity type. Maps to EMV 3DS field `mcc`. May not be present for non-payment
	// authentications.
	Mcc string `json:"mcc,nullable"`
	// Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present
	// for non-payment authentications.
	Name string                            `json:"name,nullable"`
	JSON threeDSAuthenticationMerchantJSON `json:"-"`
}

Object containing data about the merchant involved in the e-commerce transaction.

func (*ThreeDSAuthenticationMerchant) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationMerchantRiskIndicator added in v0.98.0 

type ThreeDSAuthenticationMerchantRiskIndicator 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 ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame `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 int64 `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 int64 `json:"gift_card_count,nullable"`
	// In prepaid or gift card purchase transactions, currency code of the gift card.
	// Maps to EMV 3DS field `giftCardCurr`. Permitted values: ISO 4217 three-character
	// currency code (e.g., USD).
	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 ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability `json:"order_availability,nullable"`
	// In pre-order purchase transactions, the expected date that the merchandise will
	// be available. Maps to EMV 3DS field `preOrderDate`. Permitted values: Date
	// string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ
	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 ThreeDSAuthenticationMerchantRiskIndicatorReorderItems `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 ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod `json:"shipping_method,nullable"`
	JSON           threeDSAuthenticationMerchantRiskIndicatorJSON           `json:"-"`
}

Object containing additional data indicating additional risk factors related to the e-commerce transaction.

func (*ThreeDSAuthenticationMerchantRiskIndicator) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame added in v0.98.0 

type ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame string

The delivery time frame for the merchandise. Maps to EMV 3DS field `deliveryTimeframe`. 

const (
	ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrameElectronicDelivery   ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame = "ELECTRONIC_DELIVERY"
	ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrameOvernightShipping    ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame = "OVERNIGHT_SHIPPING"
	ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrameSameDayShipping      ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame = "SAME_DAY_SHIPPING"
	ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrameTwoDayOrMoreShipping ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame = "TWO_DAY_OR_MORE_SHIPPING"
)

func (ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationMerchantRiskIndicatorDeliveryTimeFrame) IsKnown() bool

type ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability added in v0.98.0 

type ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability string

Indicates whether the purchase is for merchandise that is available now or at a future date. Maps to EMV 3DS field `preOrderPurchaseInd`. 

const (
	ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailabilityFutureAvailability   ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability = "FUTURE_AVAILABILITY"
	ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailabilityMerchandiseAvailable ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability = "MERCHANDISE_AVAILABLE"
)

func (ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationMerchantRiskIndicatorOrderAvailability) IsKnown() bool

type ThreeDSAuthenticationMerchantRiskIndicatorReorderItems added in v0.98.0 

type ThreeDSAuthenticationMerchantRiskIndicatorReorderItems string

Indicates whether the cardholder is reordering previously purchased merchandise. Maps to EMV 3DS field `reorderItemsInd`. 

const (
	ThreeDSAuthenticationMerchantRiskIndicatorReorderItemsFirstTimeOrdered ThreeDSAuthenticationMerchantRiskIndicatorReorderItems = "FIRST_TIME_ORDERED"
	ThreeDSAuthenticationMerchantRiskIndicatorReorderItemsReordered        ThreeDSAuthenticationMerchantRiskIndicatorReorderItems = "REORDERED"
)

func (ThreeDSAuthenticationMerchantRiskIndicatorReorderItems) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationMerchantRiskIndicatorReorderItems) IsKnown() bool

type ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod added in v0.98.0 

type ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod 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 (
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodDigitalGoods               ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "DIGITAL_GOODS"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodLockerDelivery             ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "LOCKER_DELIVERY"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodOther                      ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "OTHER"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodPickUpAndGoDelivery        ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "PICK_UP_AND_GO_DELIVERY"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodShipToBillingAddress       ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "SHIP_TO_BILLING_ADDRESS"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodShipToNonBillingAddress    ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "SHIP_TO_NON_BILLING_ADDRESS"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodShipToOtherVerifiedAddress ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "SHIP_TO_OTHER_VERIFIED_ADDRESS"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodShipToStore                ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "SHIP_TO_STORE"
	ThreeDSAuthenticationMerchantRiskIndicatorShippingMethodTravelAndEventTickets      ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod = "TRAVEL_AND_EVENT_TICKETS"
)

func (ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationMerchantRiskIndicatorShippingMethod) IsKnown() bool

type ThreeDSAuthenticationMessageCategory added in v0.98.0 

type ThreeDSAuthenticationMessageCategory string

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated. 

const (
	ThreeDSAuthenticationMessageCategoryNonPaymentAuthentication ThreeDSAuthenticationMessageCategory = "NON_PAYMENT_AUTHENTICATION"
	ThreeDSAuthenticationMessageCategoryPaymentAuthentication    ThreeDSAuthenticationMessageCategory = "PAYMENT_AUTHENTICATION"
)

func (ThreeDSAuthenticationMessageCategory) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationMessageCategory) 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 *ThreeDSAuthentication, 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). If the authentication decision is to challenge, ensure that the account holder associated with the card transaction has a valid phone number configured to receive the OTP code via SMS.

func (*ThreeDSAuthenticationService) SimulateOtpEntry added in v0.68.0 

func (r *ThreeDSAuthenticationService) SimulateOtpEntry(ctx context.Context, body ThreeDSAuthenticationSimulateOtpEntryParams, opts ...option.RequestOption) (err error)

Endpoint for simulating entering OTP into 3DS Challenge UI. A call to [/v1/three_ds_authentication/simulate](https://docs.lithic.com/reference/postsimulateauthentication) that resulted in triggered SMS-OTP challenge must precede. Only a single attempt is supported; upon entering OTP, the challenge is either approved or declined.

type ThreeDSAuthenticationSimulateOtpEntryParams added in v0.68.0 

type ThreeDSAuthenticationSimulateOtpEntryParams struct {
	// A unique token returned as part of a /v1/three_ds_authentication/simulate call
	// that resulted in PENDING_CHALLENGE authentication result.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// The OTP entered by the cardholder
	Otp param.Field[string] `json:"otp,required"`
}

func (ThreeDSAuthenticationSimulateOtpEntryParams) MarshalJSON added in v0.68.0 

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

type ThreeDSAuthenticationSimulateParams added in v0.7.4 

type ThreeDSAuthenticationSimulateParams struct {
	// Merchant information for the simulated transaction
	Merchant param.Field[ThreeDSAuthenticationSimulateParamsMerchant] `json:"merchant,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// Transaction details for the simulation
	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. If CHALLENGE
	// keyword is included, Lithic will trigger a challenge.
	Name param.Field[string] `json:"name,required"`
}

Merchant information for the simulated transaction

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-character alphabetic ISO 4217 currency code.
	Currency param.Field[string] `json:"currency,required"`
}

Transaction details for the simulation

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 {
	// Globally unique identifier for the 3DS authentication.
	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 ThreeDSAuthenticationThreeDSRequestorChallengeIndicator added in v0.98.0 

type ThreeDSAuthenticationThreeDSRequestorChallengeIndicator string

Indicates whether a challenge is requested for this transaction

  • `NO_PREFERENCE` - No Preference
  • `NO_CHALLENGE_REQUESTED` - No Challenge Requested
  • `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
  • `CHALLENGE_MANDATE` - Challenge requested (Mandate)
  • `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional risk analysis is already performed)
  • `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
  • `OTHER` - Other indicators not captured by above. These are rarely used
const (
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorNoPreference                   ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "NO_PREFERENCE"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorNoChallengeRequested           ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "NO_CHALLENGE_REQUESTED"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorChallengePreference            ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "CHALLENGE_PREFERENCE"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorChallengeMandate               ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "CHALLENGE_MANDATE"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorNoChallengeRiskAlreadyAssessed ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "NO_CHALLENGE_RISK_ALREADY_ASSESSED"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorDataShareOnly                  ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "DATA_SHARE_ONLY"
	ThreeDSAuthenticationThreeDSRequestorChallengeIndicatorOther                          ThreeDSAuthenticationThreeDSRequestorChallengeIndicator = "OTHER"
)

func (ThreeDSAuthenticationThreeDSRequestorChallengeIndicator) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationThreeDSRequestorChallengeIndicator) IsKnown() bool

type ThreeDSAuthenticationThreeRiRequestType added in v0.98.0 

type ThreeDSAuthenticationThreeRiRequestType 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 (
	ThreeDSAuthenticationThreeRiRequestTypeAccountVerification         ThreeDSAuthenticationThreeRiRequestType = "ACCOUNT_VERIFICATION"
	ThreeDSAuthenticationThreeRiRequestTypeAddCard                     ThreeDSAuthenticationThreeRiRequestType = "ADD_CARD"
	ThreeDSAuthenticationThreeRiRequestTypeBillingAgreement            ThreeDSAuthenticationThreeRiRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationThreeRiRequestTypeCardSecurityCodeStatusCheck ThreeDSAuthenticationThreeRiRequestType = "CARD_SECURITY_CODE_STATUS_CHECK"
	ThreeDSAuthenticationThreeRiRequestTypeDelayedShipment             ThreeDSAuthenticationThreeRiRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationThreeRiRequestTypeDeviceBindingStatusCheck    ThreeDSAuthenticationThreeRiRequestType = "DEVICE_BINDING_STATUS_CHECK"
	ThreeDSAuthenticationThreeRiRequestTypeInstallmentTransaction      ThreeDSAuthenticationThreeRiRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationThreeRiRequestTypeMailOrder                   ThreeDSAuthenticationThreeRiRequestType = "MAIL_ORDER"
	ThreeDSAuthenticationThreeRiRequestTypeMaintainCardInfo            ThreeDSAuthenticationThreeRiRequestType = "MAINTAIN_CARD_INFO"
	ThreeDSAuthenticationThreeRiRequestTypeOtherPayment                ThreeDSAuthenticationThreeRiRequestType = "OTHER_PAYMENT"
	ThreeDSAuthenticationThreeRiRequestTypeRecurringTransaction        ThreeDSAuthenticationThreeRiRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationThreeRiRequestTypeSplitPayment                ThreeDSAuthenticationThreeRiRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationThreeRiRequestTypeSplitShipment               ThreeDSAuthenticationThreeRiRequestType = "SPLIT_SHIPMENT"
	ThreeDSAuthenticationThreeRiRequestTypeTelephoneOrder              ThreeDSAuthenticationThreeRiRequestType = "TELEPHONE_ORDER"
	ThreeDSAuthenticationThreeRiRequestTypeTopUp                       ThreeDSAuthenticationThreeRiRequestType = "TOP_UP"
	ThreeDSAuthenticationThreeRiRequestTypeTrustListStatusCheck        ThreeDSAuthenticationThreeRiRequestType = "TRUST_LIST_STATUS_CHECK"
)

func (ThreeDSAuthenticationThreeRiRequestType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationThreeRiRequestType) IsKnown() bool

type ThreeDSAuthenticationTransaction added in v0.98.0 

type ThreeDSAuthenticationTransaction 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"`
	// Approximate amount of the purchase in minor units of cardholder currency.
	// Derived from `amount` using a daily conversion rate.
	CardholderAmount float64 `json:"cardholder_amount,required,nullable"`
	// Currency of the purchase. Maps to EMV 3DS field `purchaseCurrency`. Permitted
	// values: ISO 4217 three-character currency code (e.g., USD).
	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`. Permitted values: Date string
	// in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.
	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 ThreeDSAuthenticationTransactionType `json:"type,required,nullable"`
	JSON threeDSAuthenticationTransactionJSON `json:"-"`
}

Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

func (*ThreeDSAuthenticationTransaction) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationTransactionType added in v0.98.0 

type ThreeDSAuthenticationTransactionType string

Type of the transaction for which a 3DS authentication request is occurring. Maps to EMV 3DS field `transType`. 

const (
	ThreeDSAuthenticationTransactionTypeAccountFunding           ThreeDSAuthenticationTransactionType = "ACCOUNT_FUNDING"
	ThreeDSAuthenticationTransactionTypeCheckAcceptance          ThreeDSAuthenticationTransactionType = "CHECK_ACCEPTANCE"
	ThreeDSAuthenticationTransactionTypeGoodsServicePurchase     ThreeDSAuthenticationTransactionType = "GOODS_SERVICE_PURCHASE"
	ThreeDSAuthenticationTransactionTypePrepaidActivationAndLoad ThreeDSAuthenticationTransactionType = "PREPAID_ACTIVATION_AND_LOAD"
	ThreeDSAuthenticationTransactionTypeQuasiCashTransaction     ThreeDSAuthenticationTransactionType = "QUASI_CASH_TRANSACTION"
)

func (ThreeDSAuthenticationTransactionType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationTransactionType) IsKnown() bool

type ThreeDSAuthenticationUpdatedWebhookEvent added in v0.98.0 

type ThreeDSAuthenticationUpdatedWebhookEvent struct {
	// The type of event that occurred.
	EventType ThreeDSAuthenticationUpdatedWebhookEventEventType `json:"event_type,required"`
	JSON      threeDSAuthenticationUpdatedWebhookEventJSON      `json:"-"`
	ThreeDSAuthentication
}

Represents a 3DS authentication

func (*ThreeDSAuthenticationUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type ThreeDSAuthenticationUpdatedWebhookEventEventType added in v0.98.0 

type ThreeDSAuthenticationUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	ThreeDSAuthenticationUpdatedWebhookEventEventTypeThreeDSAuthenticationUpdated ThreeDSAuthenticationUpdatedWebhookEventEventType = "three_ds_authentication.updated"
)

func (ThreeDSAuthenticationUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r ThreeDSAuthenticationUpdatedWebhookEventEventType) IsKnown() bool

type ThreeDSDecisioningChallengeResponseParams added in v0.47.0 

type ThreeDSDecisioningChallengeResponseParams struct {
	// Response from Card Program to a 3DS Authentication challenge
	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. Challenge Request is emitted as a webhook [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge) and your Card Program needs to be configured with Out of Band (OOB) Challenges in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for more information).

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.

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 TokenInfo added in v0.98.0 

type TokenInfo 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 TokenInfoWalletType `json:"wallet_type,required"`
	JSON       tokenInfoJSON       `json:"-"`
}

func (*TokenInfo) UnmarshalJSON added in v0.98.0 

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

type TokenInfoWalletType added in v0.98.0 

type TokenInfoWalletType 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 (
	TokenInfoWalletTypeApplePay   TokenInfoWalletType = "APPLE_PAY"
	TokenInfoWalletTypeGooglePay  TokenInfoWalletType = "GOOGLE_PAY"
	TokenInfoWalletTypeMasterpass TokenInfoWalletType = "MASTERPASS"
	TokenInfoWalletTypeMerchant   TokenInfoWalletType = "MERCHANT"
	TokenInfoWalletTypeOther      TokenInfoWalletType = "OTHER"
	TokenInfoWalletTypeSamsungPay TokenInfoWalletType = "SAMSUNG_PAY"
)

func (TokenInfoWalletType) IsKnown added in v0.98.0 

func (r TokenInfoWalletType) IsKnown() bool

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 dynamic pan assigned to the token by the network.
	Dpan string `json:"dpan,required,nullable"`
	// The status of the tokenization request
	Status TokenizationStatus `json:"status,required"`
	// The entity that requested the tokenization. For digital wallets, this will be
	// one of the defined wallet types. For merchant tokenizations, this will be a
	// free-form merchant name string.
	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"`
	// The device identifier associated with the tokenization.
	DeviceID string `json:"device_id,nullable"`
	// 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,nullable" format:"uuid"`
	// A list of events related to the tokenization.
	Events []TokenizationEvent `json:"events"`
	// The network's unique reference for the card that is tokenized.
	PaymentAccountReferenceID string           `json:"payment_account_reference_id,nullable"`
	JSON                      tokenizationJSON `json:"-"`
}

func (*Tokenization) UnmarshalJSON added in v0.7.1 

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

type TokenizationApprovalRequestWebhookEvent added in v0.98.0 

type TokenizationApprovalRequestWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken string `json:"account_token,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// Contains the metadata for the customer tokenization decision.
	CustomerTokenizationDecision TokenizationApprovalRequestWebhookEventCustomerTokenizationDecision `json:"customer_tokenization_decision,required,nullable"`
	// The name of this event
	EventType TokenizationApprovalRequestWebhookEventEventType `json:"event_type,required"`
	// Whether Lithic decisioned on the token, and if so, what the decision was.
	// APPROVED/VERIFICATION_REQUIRED/DENIED.
	IssuerDecision TokenizationApprovalRequestWebhookEventIssuerDecision `json:"issuer_decision,required"`
	// The channel through which the tokenization was made.
	TokenizationChannel TokenizationApprovalRequestWebhookEventTokenizationChannel `json:"tokenization_channel,required"`
	// Unique identifier for the digital wallet token attempt
	TokenizationToken     string                `json:"tokenization_token,required"`
	WalletDecisioningInfo WalletDecisioningInfo `json:"wallet_decisioning_info,required"`
	Device                Device                `json:"device"`
	// Contains the metadata for the digital wallet being tokenized.
	DigitalWalletTokenMetadata DigitalWalletTokenMetadata `json:"digital_wallet_token_metadata"`
	// Results from rules that were evaluated for this tokenization
	RuleResults []TokenizationRuleResult `json:"rule_results"`
	// List of reasons why the tokenization was declined
	TokenizationDeclineReasons []TokenizationDeclineReason `json:"tokenization_decline_reasons"`
	// The source of the tokenization.
	TokenizationSource TokenizationApprovalRequestWebhookEventTokenizationSource `json:"tokenization_source"`
	// List of reasons why two-factor authentication was required
	TokenizationTfaReasons []TokenizationTfaReason                     `json:"tokenization_tfa_reasons"`
	JSON                   tokenizationApprovalRequestWebhookEventJSON `json:"-"`
}

func (*TokenizationApprovalRequestWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationApprovalRequestWebhookEventCustomerTokenizationDecision added in v0.98.0 

type TokenizationApprovalRequestWebhookEventCustomerTokenizationDecision struct {
	// The outcome of the customer's decision
	Outcome TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome `json:"outcome,required"`
	// The customer's subscribed URL
	ResponderURL string `json:"responder_url,required"`
	// Time in ms it took for the customer's URL to respond
	Latency string `json:"latency"`
	// The response code that the customer provided
	ResponseCode string                                                                  `json:"response_code"`
	JSON         tokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionJSON `json:"-"`
}

Contains the metadata for the customer tokenization decision.

func (*TokenizationApprovalRequestWebhookEventCustomerTokenizationDecision) UnmarshalJSON added in v0.98.0 

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

type TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome added in v0.98.0 

type TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome string

The outcome of the customer's decision 

const (
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeApproved                        TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "APPROVED"
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeDeclined                        TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "DECLINED"
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeError                           TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "ERROR"
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeInvalidResponse                 TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "INVALID_RESPONSE"
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeRequireAdditionalAuthentication TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "REQUIRE_ADDITIONAL_AUTHENTICATION"
	TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcomeTimeout                         TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome = "TIMEOUT"
)

func (TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome) IsKnown added in v0.98.0 

func (r TokenizationApprovalRequestWebhookEventCustomerTokenizationDecisionOutcome) IsKnown() bool

type TokenizationApprovalRequestWebhookEventEventType added in v0.98.0 

type TokenizationApprovalRequestWebhookEventEventType string

The name of this event 

const (
	TokenizationApprovalRequestWebhookEventEventTypeTokenizationApprovalRequest TokenizationApprovalRequestWebhookEventEventType = "tokenization.approval_request"
)

func (TokenizationApprovalRequestWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationApprovalRequestWebhookEventEventType) IsKnown() bool

type TokenizationApprovalRequestWebhookEventIssuerDecision added in v0.98.0 

type TokenizationApprovalRequestWebhookEventIssuerDecision string

Whether Lithic decisioned on the token, and if so, what the decision was. APPROVED/VERIFICATION_REQUIRED/DENIED. 

const (
	TokenizationApprovalRequestWebhookEventIssuerDecisionApproved             TokenizationApprovalRequestWebhookEventIssuerDecision = "APPROVED"
	TokenizationApprovalRequestWebhookEventIssuerDecisionDenied               TokenizationApprovalRequestWebhookEventIssuerDecision = "DENIED"
	TokenizationApprovalRequestWebhookEventIssuerDecisionVerificationRequired TokenizationApprovalRequestWebhookEventIssuerDecision = "VERIFICATION_REQUIRED"
)

func (TokenizationApprovalRequestWebhookEventIssuerDecision) IsKnown added in v0.98.0 

func (r TokenizationApprovalRequestWebhookEventIssuerDecision) IsKnown() bool

type TokenizationApprovalRequestWebhookEventTokenizationChannel added in v0.98.0 

type TokenizationApprovalRequestWebhookEventTokenizationChannel string

The channel through which the tokenization was made. 

const (
	TokenizationApprovalRequestWebhookEventTokenizationChannelDigitalWallet TokenizationApprovalRequestWebhookEventTokenizationChannel = "DIGITAL_WALLET"
	TokenizationApprovalRequestWebhookEventTokenizationChannelMerchant      TokenizationApprovalRequestWebhookEventTokenizationChannel = "MERCHANT"
)

func (TokenizationApprovalRequestWebhookEventTokenizationChannel) IsKnown added in v0.98.0 

func (r TokenizationApprovalRequestWebhookEventTokenizationChannel) IsKnown() bool

type TokenizationApprovalRequestWebhookEventTokenizationSource added in v0.98.0 

type TokenizationApprovalRequestWebhookEventTokenizationSource string

The source of the tokenization. 

const (
	TokenizationApprovalRequestWebhookEventTokenizationSourceAccountOnFile   TokenizationApprovalRequestWebhookEventTokenizationSource = "ACCOUNT_ON_FILE"
	TokenizationApprovalRequestWebhookEventTokenizationSourceContactlessTap  TokenizationApprovalRequestWebhookEventTokenizationSource = "CONTACTLESS_TAP"
	TokenizationApprovalRequestWebhookEventTokenizationSourceManualProvision TokenizationApprovalRequestWebhookEventTokenizationSource = "MANUAL_PROVISION"
	TokenizationApprovalRequestWebhookEventTokenizationSourcePushProvision   TokenizationApprovalRequestWebhookEventTokenizationSource = "PUSH_PROVISION"
	TokenizationApprovalRequestWebhookEventTokenizationSourceToken           TokenizationApprovalRequestWebhookEventTokenizationSource = "TOKEN"
	TokenizationApprovalRequestWebhookEventTokenizationSourceUnknown         TokenizationApprovalRequestWebhookEventTokenizationSource = "UNKNOWN"
)

func (TokenizationApprovalRequestWebhookEventTokenizationSource) IsKnown added in v0.98.0 

func (r TokenizationApprovalRequestWebhookEventTokenizationSource) IsKnown() bool

type TokenizationDecisioningRequestWebhookEvent added in v0.98.0 

type TokenizationDecisioningRequestWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken string `json:"account_token,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// The name of this event
	EventType TokenizationDecisioningRequestWebhookEventEventType `json:"event_type,required"`
	// Whether Lithic decisioned on the token, and if so, what the decision was.
	// APPROVED/VERIFICATION_REQUIRED/DENIED.
	IssuerDecision TokenizationDecisioningRequestWebhookEventIssuerDecision `json:"issuer_decision,required"`
	// The channel through which the tokenization was made.
	TokenizationChannel TokenizationDecisioningRequestWebhookEventTokenizationChannel `json:"tokenization_channel,required"`
	// Unique identifier for the digital wallet token attempt
	TokenizationToken     string                `json:"tokenization_token,required"`
	WalletDecisioningInfo WalletDecisioningInfo `json:"wallet_decisioning_info,required"`
	Device                Device                `json:"device"`
	// Contains the metadata for the digital wallet being tokenized.
	DigitalWalletTokenMetadata DigitalWalletTokenMetadata `json:"digital_wallet_token_metadata"`
	// The source of the tokenization.
	TokenizationSource TokenizationDecisioningRequestWebhookEventTokenizationSource `json:"tokenization_source"`
	JSON               tokenizationDecisioningRequestWebhookEventJSON               `json:"-"`
}

A webhook for tokenization decisioning sent to the customer's responder endpoint

func (*TokenizationDecisioningRequestWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationDecisioningRequestWebhookEventEventType added in v0.98.0 

type TokenizationDecisioningRequestWebhookEventEventType string

The name of this event 

const (
	TokenizationDecisioningRequestWebhookEventEventTypeDigitalWalletTokenizationApprovalRequest TokenizationDecisioningRequestWebhookEventEventType = "digital_wallet.tokenization_approval_request"
)

func (TokenizationDecisioningRequestWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationDecisioningRequestWebhookEventEventType) IsKnown() bool

type TokenizationDecisioningRequestWebhookEventIssuerDecision added in v0.98.0 

type TokenizationDecisioningRequestWebhookEventIssuerDecision string

Whether Lithic decisioned on the token, and if so, what the decision was. APPROVED/VERIFICATION_REQUIRED/DENIED. 

const (
	TokenizationDecisioningRequestWebhookEventIssuerDecisionApproved             TokenizationDecisioningRequestWebhookEventIssuerDecision = "APPROVED"
	TokenizationDecisioningRequestWebhookEventIssuerDecisionDenied               TokenizationDecisioningRequestWebhookEventIssuerDecision = "DENIED"
	TokenizationDecisioningRequestWebhookEventIssuerDecisionVerificationRequired TokenizationDecisioningRequestWebhookEventIssuerDecision = "VERIFICATION_REQUIRED"
)

func (TokenizationDecisioningRequestWebhookEventIssuerDecision) IsKnown added in v0.98.0 

func (r TokenizationDecisioningRequestWebhookEventIssuerDecision) IsKnown() bool

type TokenizationDecisioningRequestWebhookEventTokenizationChannel added in v0.98.0 

type TokenizationDecisioningRequestWebhookEventTokenizationChannel string

The channel through which the tokenization was made. 

const (
	TokenizationDecisioningRequestWebhookEventTokenizationChannelDigitalWallet TokenizationDecisioningRequestWebhookEventTokenizationChannel = "DIGITAL_WALLET"
	TokenizationDecisioningRequestWebhookEventTokenizationChannelMerchant      TokenizationDecisioningRequestWebhookEventTokenizationChannel = "MERCHANT"
)

func (TokenizationDecisioningRequestWebhookEventTokenizationChannel) IsKnown added in v0.98.0 

func (r TokenizationDecisioningRequestWebhookEventTokenizationChannel) IsKnown() bool

type TokenizationDecisioningRequestWebhookEventTokenizationSource added in v0.98.0 

type TokenizationDecisioningRequestWebhookEventTokenizationSource string

The source of the tokenization. 

const (
	TokenizationDecisioningRequestWebhookEventTokenizationSourceAccountOnFile   TokenizationDecisioningRequestWebhookEventTokenizationSource = "ACCOUNT_ON_FILE"
	TokenizationDecisioningRequestWebhookEventTokenizationSourceContactlessTap  TokenizationDecisioningRequestWebhookEventTokenizationSource = "CONTACTLESS_TAP"
	TokenizationDecisioningRequestWebhookEventTokenizationSourceManualProvision TokenizationDecisioningRequestWebhookEventTokenizationSource = "MANUAL_PROVISION"
	TokenizationDecisioningRequestWebhookEventTokenizationSourcePushProvision   TokenizationDecisioningRequestWebhookEventTokenizationSource = "PUSH_PROVISION"
	TokenizationDecisioningRequestWebhookEventTokenizationSourceToken           TokenizationDecisioningRequestWebhookEventTokenizationSource = "TOKEN"
	TokenizationDecisioningRequestWebhookEventTokenizationSourceUnknown         TokenizationDecisioningRequestWebhookEventTokenizationSource = "UNKNOWN"
)

func (TokenizationDecisioningRequestWebhookEventTokenizationSource) IsKnown added in v0.98.0 

func (r TokenizationDecisioningRequestWebhookEventTokenizationSource) IsKnown() bool

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 TokenizationDeclineReason added in v0.98.0 

type TokenizationDeclineReason string

Reason code for why a tokenization was declined 

const (
	TokenizationDeclineReasonAccountScore1                  TokenizationDeclineReason = "ACCOUNT_SCORE_1"
	TokenizationDeclineReasonDeviceScore1                   TokenizationDeclineReason = "DEVICE_SCORE_1"
	TokenizationDeclineReasonAllWalletDeclineReasonsPresent TokenizationDeclineReason = "ALL_WALLET_DECLINE_REASONS_PRESENT"
	TokenizationDeclineReasonWalletRecommendedDecisionRed   TokenizationDeclineReason = "WALLET_RECOMMENDED_DECISION_RED"
	TokenizationDeclineReasonCvcMismatch                    TokenizationDeclineReason = "CVC_MISMATCH"
	TokenizationDeclineReasonCardExpiryMonthMismatch        TokenizationDeclineReason = "CARD_EXPIRY_MONTH_MISMATCH"
	TokenizationDeclineReasonCardExpiryYearMismatch         TokenizationDeclineReason = "CARD_EXPIRY_YEAR_MISMATCH"
	TokenizationDeclineReasonCardInvalidState               TokenizationDeclineReason = "CARD_INVALID_STATE"
	TokenizationDeclineReasonCustomerRedPath                TokenizationDeclineReason = "CUSTOMER_RED_PATH"
	TokenizationDeclineReasonInvalidCustomerResponse        TokenizationDeclineReason = "INVALID_CUSTOMER_RESPONSE"
	TokenizationDeclineReasonNetworkFailure                 TokenizationDeclineReason = "NETWORK_FAILURE"
	TokenizationDeclineReasonGenericDecline                 TokenizationDeclineReason = "GENERIC_DECLINE"
	TokenizationDeclineReasonDigitalCardArtRequired         TokenizationDeclineReason = "DIGITAL_CARD_ART_REQUIRED"
)

func (TokenizationDeclineReason) IsKnown added in v0.98.0 

func (r TokenizationDeclineReason) IsKnown() bool

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"`
	// Results from rules that were evaluated for this tokenization
	RuleResults []TokenizationRuleResult `json:"rule_results"`
	// List of reasons why the tokenization was declined
	TokenizationDeclineReasons []TokenizationDeclineReason `json:"tokenization_decline_reasons"`
	// List of reasons why two-factor authentication was required
	TokenizationTfaReasons []TokenizationTfaReason `json:"tokenization_tfa_reasons"`
	// 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"
	TokenizationEventsResultTokenDeletedFromConsumerApp     TokenizationEventsResult = "TOKEN_DELETED_FROM_CONSUMER_APP"
	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 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 TokenizationResultWebhookEvent added in v0.98.0 

type TokenizationResultWebhookEvent struct {
	// Account token
	AccountToken string `json:"account_token,required"`
	// Card token
	CardToken string `json:"card_token,required"`
	// Created date
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType TokenizationResultWebhookEventEventType `json:"event_type,required"`
	// The result of the tokenization request.
	TokenizationResultDetails TokenizationResultWebhookEventTokenizationResultDetails `json:"tokenization_result_details,required"`
	// Tokenization token
	TokenizationToken string                             `json:"tokenization_token,required"`
	JSON              tokenizationResultWebhookEventJSON `json:"-"`
}

func (*TokenizationResultWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationResultWebhookEventEventType added in v0.98.0 

type TokenizationResultWebhookEventEventType string

The type of event that occurred. 

const (
	TokenizationResultWebhookEventEventTypeTokenizationResult TokenizationResultWebhookEventEventType = "tokenization.result"
)

func (TokenizationResultWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationResultWebhookEventEventType) IsKnown() bool

type TokenizationResultWebhookEventTokenizationResultDetails added in v0.98.0 

type TokenizationResultWebhookEventTokenizationResultDetails struct {
	// Lithic's tokenization decision.
	IssuerDecision string `json:"issuer_decision,required"`
	// List of reasons why the tokenization was declined
	TokenizationDeclineReasons []TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason `json:"tokenization_decline_reasons,required"`
	// The customer's tokenization decision if applicable.
	CustomerDecision string `json:"customer_decision,nullable"`
	// Results from rules that were evaluated for this tokenization
	RuleResults []TokenizationRuleResult `json:"rule_results"`
	// An RFC 3339 timestamp indicating when the tokenization succeeded.
	TokenActivatedDateTime time.Time `json:"token_activated_date_time,nullable" format:"date-time"`
	// List of reasons why two-factor authentication was required
	TokenizationTfaReasons []TokenizationTfaReason `json:"tokenization_tfa_reasons"`
	// The wallet's recommended decision.
	WalletDecision string                                                      `json:"wallet_decision,nullable"`
	JSON           tokenizationResultWebhookEventTokenizationResultDetailsJSON `json:"-"`
}

The result of the tokenization request.

func (*TokenizationResultWebhookEventTokenizationResultDetails) UnmarshalJSON added in v0.98.0 

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

type TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason added in v0.98.0 

type TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason string
const (
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonAccountScore1                  TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "ACCOUNT_SCORE_1"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonAllWalletDeclineReasonsPresent TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "ALL_WALLET_DECLINE_REASONS_PRESENT"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardExpiryMonthMismatch        TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_EXPIRY_MONTH_MISMATCH"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardExpiryYearMismatch         TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_EXPIRY_YEAR_MISMATCH"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCardInvalidState               TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CARD_INVALID_STATE"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCustomerRedPath                TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CUSTOMER_RED_PATH"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonCvcMismatch                    TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "CVC_MISMATCH"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonDeviceScore1                   TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "DEVICE_SCORE_1"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonGenericDecline                 TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "GENERIC_DECLINE"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonInvalidCustomerResponse        TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "INVALID_CUSTOMER_RESPONSE"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonNetworkFailure                 TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "NETWORK_FAILURE"
	TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReasonWalletRecommendedDecisionRed   TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason = "WALLET_RECOMMENDED_DECISION_RED"
)

func (TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason) IsKnown added in v0.98.0 

func (r TokenizationResultWebhookEventTokenizationResultDetailsTokenizationDeclineReason) IsKnown() bool

type TokenizationRuleResult added in v0.98.0 

type TokenizationRuleResult struct {
	// The Auth Rule Token associated with the rule. If this is set to null, then the
	// result was not associated with a customer-configured rule. This may happen in
	// cases where a tokenization is declined or requires TFA due to a
	// Lithic-configured security or compliance rule, for example.
	AuthRuleToken string `json:"auth_rule_token,required,nullable" format:"uuid"`
	// A human-readable explanation outlining the motivation for the rule's result
	Explanation string `json:"explanation,required,nullable"`
	// The name for the rule, if any was configured
	Name string `json:"name,required,nullable"`
	// The result associated with this rule
	Result TokenizationRuleResultResult `json:"result,required"`
	JSON   tokenizationRuleResultJSON   `json:"-"`
}

func (*TokenizationRuleResult) UnmarshalJSON added in v0.98.0 

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

type TokenizationRuleResultResult added in v0.98.0 

type TokenizationRuleResultResult string

The result associated with this rule 

const (
	TokenizationRuleResultResultApproved   TokenizationRuleResultResult = "APPROVED"
	TokenizationRuleResultResultDeclined   TokenizationRuleResultResult = "DECLINED"
	TokenizationRuleResultResultRequireTfa TokenizationRuleResultResult = "REQUIRE_TFA"
	TokenizationRuleResultResultError      TokenizationRuleResultResult = "ERROR"
)

func (TokenizationRuleResultResult) IsKnown added in v0.98.0 

func (r TokenizationRuleResultResult) 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 *Tokenization, 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 *Tokenization, 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 *Tokenization, 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 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 TokenizationTfaReason added in v0.98.0 

type TokenizationTfaReason string

Reason code for why a tokenization required two-factor authentication 

const (
	TokenizationTfaReasonWalletRecommendedTfa        TokenizationTfaReason = "WALLET_RECOMMENDED_TFA"
	TokenizationTfaReasonSuspiciousActivity          TokenizationTfaReason = "SUSPICIOUS_ACTIVITY"
	TokenizationTfaReasonDeviceRecentlyLost          TokenizationTfaReason = "DEVICE_RECENTLY_LOST"
	TokenizationTfaReasonTooManyRecentAttempts       TokenizationTfaReason = "TOO_MANY_RECENT_ATTEMPTS"
	TokenizationTfaReasonTooManyRecentTokens         TokenizationTfaReason = "TOO_MANY_RECENT_TOKENS"
	TokenizationTfaReasonTooManyDifferentCardholders TokenizationTfaReason = "TOO_MANY_DIFFERENT_CARDHOLDERS"
	TokenizationTfaReasonOutsideHomeTerritory        TokenizationTfaReason = "OUTSIDE_HOME_TERRITORY"
	TokenizationTfaReasonHasSuspendedTokens          TokenizationTfaReason = "HAS_SUSPENDED_TOKENS"
	TokenizationTfaReasonHighRisk                    TokenizationTfaReason = "HIGH_RISK"
	TokenizationTfaReasonAccountScoreLow             TokenizationTfaReason = "ACCOUNT_SCORE_LOW"
	TokenizationTfaReasonDeviceScoreLow              TokenizationTfaReason = "DEVICE_SCORE_LOW"
	TokenizationTfaReasonCardStateTfa                TokenizationTfaReason = "CARD_STATE_TFA"
	TokenizationTfaReasonHardcodedTfa                TokenizationTfaReason = "HARDCODED_TFA"
	TokenizationTfaReasonCustomerRuleTfa             TokenizationTfaReason = "CUSTOMER_RULE_TFA"
	TokenizationTfaReasonDeviceHostCardEmulation     TokenizationTfaReason = "DEVICE_HOST_CARD_EMULATION"
)

func (TokenizationTfaReason) IsKnown added in v0.98.0 

func (r TokenizationTfaReason) IsKnown() bool

type TokenizationTokenRequestorName added in v0.7.1 

type TokenizationTokenRequestorName string

Digital wallet type 

const (
	TokenizationTokenRequestorNameAmazonOne    TokenizationTokenRequestorName = "AMAZON_ONE"
	TokenizationTokenRequestorNameAndroidPay   TokenizationTokenRequestorName = "ANDROID_PAY"
	TokenizationTokenRequestorNameApplePay     TokenizationTokenRequestorName = "APPLE_PAY"
	TokenizationTokenRequestorNameFacebook     TokenizationTokenRequestorName = "FACEBOOK"
	TokenizationTokenRequestorNameFitbitPay    TokenizationTokenRequestorName = "FITBIT_PAY"
	TokenizationTokenRequestorNameGarminPay    TokenizationTokenRequestorName = "GARMIN_PAY"
	TokenizationTokenRequestorNameGooglePay    TokenizationTokenRequestorName = "GOOGLE_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 TokenizationTwoFactorAuthenticationCodeSentWebhookEvent added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeSentWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken     string                                                                  `json:"account_token,required"`
	ActivationMethod TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod `json:"activation_method,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType `json:"event_type,required"`
	// Unique identifier for the tokenization
	TokenizationToken string                                                      `json:"tokenization_token,required"`
	JSON              tokenizationTwoFactorAuthenticationCodeSentWebhookEventJSON `json:"-"`
}

func (*TokenizationTwoFactorAuthenticationCodeSentWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod 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"
	Type TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType `json:"type,required"`
	// The location to which the authentication code was sent. The format depends on
	// the ActivationMethod.Type field. If Type is Email, the Value will be the email
	// address. If the Type is Sms, the Value will be the phone number.
	Value string                                                                      `json:"value,required"`
	JSON  tokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodJSON `json:"-"`
}

func (*TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethod) UnmarshalJSON added in v0.98.0 

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

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType 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 (
	TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodTypeEmailToCardholderAddress TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType = "EMAIL_TO_CARDHOLDER_ADDRESS"
	TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodTypeTextToCardholderNumber   TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType = "TEXT_TO_CARDHOLDER_NUMBER"
)

func (TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType) IsKnown added in v0.98.0 

func (r TokenizationTwoFactorAuthenticationCodeSentWebhookEventActivationMethodType) IsKnown() bool

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType string

The type of event that occurred. 

const (
	TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventTypeTokenizationTwoFactorAuthenticationCodeSent TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType = "tokenization.two_factor_authentication_code_sent"
)

func (TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationTwoFactorAuthenticationCodeSentWebhookEventEventType) IsKnown() bool

type TokenizationTwoFactorAuthenticationCodeWebhookEvent added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeWebhookEvent struct {
	// Unique identifier for the user tokenizing a card
	AccountToken     string                                                              `json:"account_token,required"`
	ActivationMethod TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod `json:"activation_method,required"`
	// Authentication code to provide to the user tokenizing a card.
	AuthenticationCode string `json:"authentication_code,required"`
	// Unique identifier for the card being tokenized
	CardToken string `json:"card_token,required"`
	// Indicate when the request was received from Mastercard or Visa
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType TokenizationTwoFactorAuthenticationCodeWebhookEventEventType `json:"event_type,required"`
	// Unique identifier for the tokenization
	TokenizationToken string                                                  `json:"tokenization_token,required"`
	JSON              tokenizationTwoFactorAuthenticationCodeWebhookEventJSON `json:"-"`
}

func (*TokenizationTwoFactorAuthenticationCodeWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod 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"
	Type TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType `json:"type,required"`
	// The location where the user wants to receive the authentication code. The format
	// depends on the ActivationMethod.Type field. If Type is Email, the Value will be
	// the email address. If the Type is Sms, the Value will be the phone number.
	Value string                                                                  `json:"value,required"`
	JSON  tokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodJSON `json:"-"`
}

func (*TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethod) UnmarshalJSON added in v0.98.0 

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

type TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType 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 (
	TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodTypeEmailToCardholderAddress TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType = "EMAIL_TO_CARDHOLDER_ADDRESS"
	TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodTypeTextToCardholderNumber   TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType = "TEXT_TO_CARDHOLDER_NUMBER"
)

func (TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType) IsKnown added in v0.98.0 

func (r TokenizationTwoFactorAuthenticationCodeWebhookEventActivationMethodType) IsKnown() bool

type TokenizationTwoFactorAuthenticationCodeWebhookEventEventType added in v0.98.0 

type TokenizationTwoFactorAuthenticationCodeWebhookEventEventType string

The type of event that occurred. 

const (
	TokenizationTwoFactorAuthenticationCodeWebhookEventEventTypeTokenizationTwoFactorAuthenticationCode TokenizationTwoFactorAuthenticationCodeWebhookEventEventType = "tokenization.two_factor_authentication_code"
)

func (TokenizationTwoFactorAuthenticationCodeWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationTwoFactorAuthenticationCodeWebhookEventEventType) 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 TokenizationUpdatedWebhookEvent added in v0.98.0 

type TokenizationUpdatedWebhookEvent struct {
	// Account token
	AccountToken string `json:"account_token,required"`
	// Card token
	CardToken string `json:"card_token,required"`
	// Created date
	Created time.Time `json:"created,required" format:"date-time"`
	// The type of event that occurred.
	EventType    TokenizationUpdatedWebhookEventEventType `json:"event_type,required"`
	Tokenization Tokenization                             `json:"tokenization,required"`
	JSON         tokenizationUpdatedWebhookEventJSON      `json:"-"`
}

func (*TokenizationUpdatedWebhookEvent) UnmarshalJSON added in v0.98.0 

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

type TokenizationUpdatedWebhookEventEventType added in v0.98.0 

type TokenizationUpdatedWebhookEventEventType string

The type of event that occurred. 

const (
	TokenizationUpdatedWebhookEventEventTypeTokenizationUpdated TokenizationUpdatedWebhookEventEventType = "tokenization.updated"
)

func (TokenizationUpdatedWebhookEventEventType) IsKnown added in v0.98.0 

func (r TokenizationUpdatedWebhookEventEventType) IsKnown() bool

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. This field has been deprecated in favor of the
	// `acquirer_reference_number` that resides in the event-level `network_info`.
	//
	// Deprecated: deprecated
	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.
	//
	// Deprecated: deprecated
	Amount  int64              `json:"amount,required"`
	Amounts TransactionAmounts `json:"amounts,required"`
	// The authorization amount of the transaction in the anticipated settlement
	// currency.
	//
	// Deprecated: deprecated
	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 CardholderAuthentication `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"`
	FinancialAccountToken string          `json:"financial_account_token,required,nullable" format:"uuid"`
	Merchant              shared.Merchant `json:"merchant,required"`
	// Analogous to the 'amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAmount int64 `json:"merchant_amount,required,nullable"`
	// Analogous to the 'authorization_amount', but in the merchant currency.
	//
	// Deprecated: deprecated
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,required,nullable"`
	// 3-character alphabetic ISO 4217 code for the local currency of the transaction.
	//
	// Deprecated: deprecated
	MerchantCurrency string `json:"merchant_currency,required"`
	// Card network of the authorization. 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.
	//
	// Deprecated: deprecated
	SettledAmount int64 `json:"settled_amount,required"`
	// Status of the transaction.
	Status    TransactionStatus `json:"status,required"`
	TokenInfo TokenInfo         `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 estimated settled amount of the transaction in the cardholder billing
	// currency.
	Amount int64 `json:"amount,required"`
	// The exchange rate used to convert the merchant amount to the cardholder billing
	// amount.
	ConversionRate string `json:"conversion_rate,required"`
	// 3-character alphabetic ISO 4217 currency
	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 pending amount of the transaction in the anticipated settlement currency.
	Amount int64 `json:"amount,required"`
	// 3-character alphabetic ISO 4217 currency
	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 settled amount of the transaction in the merchant currency.
	Amount int64 `json:"amount,required"`
	// 3-character alphabetic ISO 4217 currency
	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 settled amount of the transaction in the settlement currency.
	Amount int64 `json:"amount,required"`
	// 3-character alphabetic ISO 4217 currency
	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 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. Not available in sandbox.

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.
	//
	// Deprecated: deprecated
	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"`
	// Information provided by the card network in each event. This includes common
	// identifiers shared between you, Lithic, the card network and in some cases the
	// acquirer. These identifiers often link together events within the same
	// transaction lifecycle and can be used to locate a particular transaction, such
	// as during processing of disputes. Not all fields are available in all events,
	// and the presence of these fields is dependent on the card network and the event
	// type. If the field is populated by the network, we will pass it through as is
	// unless otherwise specified. Please consult the official network documentation
	// for more details about these fields and how to use them.
	NetworkInfo TransactionEventsNetworkInfo  `json:"network_info,required,nullable"`
	Result      TransactionEventsResult       `json:"result,required"`
	RuleResults []TransactionEventsRuleResult `json:"rule_results,required"`
	// Type of transaction event
	Type                TransactionEventsType                `json:"type,required"`
	AccountType         TransactionEventsAccountType         `json:"account_type"`
	NetworkSpecificData TransactionEventsNetworkSpecificData `json:"network_specific_data"`
	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. Not available in sandbox.

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 TransactionEventsAccountType added in v0.82.0 

type TransactionEventsAccountType string
const (
	TransactionEventsAccountTypeChecking TransactionEventsAccountType = "CHECKING"
	TransactionEventsAccountTypeSavings  TransactionEventsAccountType = "SAVINGS"
)

func (TransactionEventsAccountType) IsKnown added in v0.82.0 

func (r TransactionEventsAccountType) IsKnown() bool

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 {
	// Amount of the event in the cardholder billing currency.
	Amount int64 `json:"amount,required"`
	// Exchange rate used to convert the merchant amount to the cardholder billing
	// amount.
	ConversionRate string `json:"conversion_rate,required"`
	// 3-character alphabetic ISO 4217 currency
	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 {
	// Amount of the event in the merchant currency.
	Amount int64 `json:"amount,required"`
	// 3-character alphabetic ISO 4217 currency
	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.
	// Non-financial events do not contain this amount because they do not move funds.
	Amount int64 `json:"amount,required"`
	// Exchange rate used to convert the merchant amount to the settlement amount.
	ConversionRate string `json:"conversion_rate,required"`
	// 3-character alphabetic ISO 4217 currency
	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"
	TransactionEventsDetailedResultAccountPaused                               TransactionEventsDetailedResult = "ACCOUNT_PAUSED"
	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"
	TransactionEventsDetailedResultAuthRule                                    TransactionEventsDetailedResult = "AUTH_RULE"
	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"
	TransactionEventsDetailedResultSuspectedFraud                              TransactionEventsDetailedResult = "SUSPECTED_FRAUD"
	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"
	TransactionEventsDetailedResultCardholderChallenged                        TransactionEventsDetailedResult = "CARDHOLDER_CHALLENGED"
	TransactionEventsDetailedResultCardholderChallengeFailed                   TransactionEventsDetailedResult = "CARDHOLDER_CHALLENGE_FAILED"
)

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 TransactionEventsNetworkInfo added in v0.64.0 

type TransactionEventsNetworkInfo struct {
	Acquirer   TransactionEventsNetworkInfoAcquirer   `json:"acquirer,required,nullable"`
	Amex       TransactionEventsNetworkInfoAmex       `json:"amex,required,nullable"`
	Mastercard TransactionEventsNetworkInfoMastercard `json:"mastercard,required,nullable"`
	Visa       TransactionEventsNetworkInfoVisa       `json:"visa,required,nullable"`
	JSON       transactionEventsNetworkInfoJSON       `json:"-"`
}

Information provided by the card network in each event. This includes common identifiers shared between you, Lithic, the card network and in some cases the acquirer. These identifiers often link together events within the same transaction lifecycle and can be used to locate a particular transaction, such as during processing of disputes. Not all fields are available in all events, and the presence of these fields is dependent on the card network and the event type. If the field is populated by the network, we will pass it through as is unless otherwise specified. Please consult the official network documentation for more details about these fields and how to use them.

func (*TransactionEventsNetworkInfo) UnmarshalJSON added in v0.64.0 

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

type TransactionEventsNetworkInfoAcquirer added in v0.64.0 

type TransactionEventsNetworkInfoAcquirer struct {
	// Identifier assigned by the acquirer, applicable to dual-message transactions
	// only. The acquirer reference number (ARN) is only populated once a transaction
	// has been cleared, and it is not available in all transactions (such as automated
	// fuel dispenser transactions). A single transaction can contain multiple ARNs if
	// the merchant sends multiple clearings.
	AcquirerReferenceNumber string `json:"acquirer_reference_number,required,nullable"`
	// Identifier assigned by the acquirer.
	RetrievalReferenceNumber string                                   `json:"retrieval_reference_number,required,nullable"`
	JSON                     transactionEventsNetworkInfoAcquirerJSON `json:"-"`
}

func (*TransactionEventsNetworkInfoAcquirer) UnmarshalJSON added in v0.64.0 

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

type TransactionEventsNetworkInfoAmex added in v0.77.0 

type TransactionEventsNetworkInfoAmex struct {
	// Identifier assigned by American Express. Matches the `transaction_id` of a prior
	// related event. May be populated in incremental authorizations (authorization
	// requests that augment a previously authorized amount), authorization advices,
	// financial authorizations, and clearings.
	OriginalTransactionID string `json:"original_transaction_id,required,nullable"`
	// Identifier assigned by American Express to link original messages to subsequent
	// messages. Guaranteed by American Express to be unique for each original
	// authorization and financial authorization.
	TransactionID string                               `json:"transaction_id,required,nullable"`
	JSON          transactionEventsNetworkInfoAmexJSON `json:"-"`
}

func (*TransactionEventsNetworkInfoAmex) UnmarshalJSON added in v0.77.0 

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

type TransactionEventsNetworkInfoMastercard added in v0.64.0 

type TransactionEventsNetworkInfoMastercard struct {
	// Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any
	// transaction within a specific financial network on any processing day.
	BanknetReferenceNumber string `json:"banknet_reference_number,required,nullable"`
	// Identifier assigned by Mastercard. Matches the `banknet_reference_number` of a
	// prior related event. May be populated in authorization reversals, incremental
	// authorizations (authorization requests that augment a previously authorized
	// amount), automated fuel dispenser authorization advices and clearings, and
	// financial authorizations. If the original banknet reference number contains all
	// zeroes, then no actual reference number could be found by the network or
	// acquirer. If Mastercard converts a transaction from dual-message to
	// single-message, such as for certain ATM transactions, it will populate the
	// original banknet reference number in the resulting financial authorization with
	// the banknet reference number of the initial authorization, which Lithic does not
	// receive.
	OriginalBanknetReferenceNumber string `json:"original_banknet_reference_number,required,nullable"`
	// Identifier assigned by Mastercard. Matches the `switch_serial_number` of a prior
	// related event. May be populated in returns and return reversals. Applicable to
	// single-message transactions only.
	OriginalSwitchSerialNumber string `json:"original_switch_serial_number,required,nullable"`
	// Identifier assigned by Mastercard, applicable to single-message transactions
	// only.
	SwitchSerialNumber string                                     `json:"switch_serial_number,required,nullable"`
	JSON               transactionEventsNetworkInfoMastercardJSON `json:"-"`
}

func (*TransactionEventsNetworkInfoMastercard) UnmarshalJSON added in v0.64.0 

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

type TransactionEventsNetworkInfoVisa added in v0.64.0 

type TransactionEventsNetworkInfoVisa struct {
	// Identifier assigned by Visa. Matches the `transaction_id` of a prior related
	// event. May be populated in incremental authorizations (authorization requests
	// that augment a previously authorized amount), authorization advices, financial
	// authorizations, and clearings.
	OriginalTransactionID string `json:"original_transaction_id,required,nullable"`
	// Identifier assigned by Visa to link original messages to subsequent messages.
	// Guaranteed by Visa to be unique for each original authorization and financial
	// authorization.
	TransactionID string                               `json:"transaction_id,required,nullable"`
	JSON          transactionEventsNetworkInfoVisaJSON `json:"-"`
}

func (*TransactionEventsNetworkInfoVisa) UnmarshalJSON added in v0.64.0 

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

type TransactionEventsNetworkSpecificData added in v0.75.0 

type TransactionEventsNetworkSpecificData struct {
	Mastercard TransactionEventsNetworkSpecificDataMastercard `json:"mastercard,required"`
	Visa       TransactionEventsNetworkSpecificDataVisa       `json:"visa,required"`
	JSON       transactionEventsNetworkSpecificDataJSON       `json:"-"`
}

func (*TransactionEventsNetworkSpecificData) UnmarshalJSON added in v0.75.0 

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

type TransactionEventsNetworkSpecificDataMastercard added in v0.75.0 

type TransactionEventsNetworkSpecificDataMastercard struct {
	// Indicates the electronic commerce security level and UCAF collection.
	EcommerceSecurityLevelIndicator string `json:"ecommerce_security_level_indicator,required,nullable"`
	// The On-behalf Service performed on the transaction and the results. Contains all
	// applicable, on-behalf service results that were performed on a given
	// transaction.
	OnBehalfServiceResult []TransactionEventsNetworkSpecificDataMastercardOnBehalfServiceResult `json:"on_behalf_service_result,required,nullable"`
	// Indicates the type of additional transaction purpose.
	TransactionTypeIdentifier string                                             `json:"transaction_type_identifier,required,nullable"`
	JSON                      transactionEventsNetworkSpecificDataMastercardJSON `json:"-"`
}

func (*TransactionEventsNetworkSpecificDataMastercard) UnmarshalJSON added in v0.75.0 

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

type TransactionEventsNetworkSpecificDataMastercardOnBehalfServiceResult added in v0.75.0 

type TransactionEventsNetworkSpecificDataMastercardOnBehalfServiceResult struct {
	// Indicates the results of the service processing.
	Result1 string `json:"result_1,required"`
	// Identifies the results of the service processing.
	Result2 string `json:"result_2,required"`
	// Indicates the service performed on the transaction.
	Service string                                                                  `json:"service,required"`
	JSON    transactionEventsNetworkSpecificDataMastercardOnBehalfServiceResultJSON `json:"-"`
}

func (*TransactionEventsNetworkSpecificDataMastercardOnBehalfServiceResult) UnmarshalJSON added in v0.75.0 

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

type TransactionEventsNetworkSpecificDataVisa added in v0.75.0 

type TransactionEventsNetworkSpecificDataVisa struct {
	// Identifies the purpose or category of a transaction, used to classify and
	// process transactions according to Visa’s rules.
	BusinessApplicationIdentifier string                                       `json:"business_application_identifier,required,nullable"`
	JSON                          transactionEventsNetworkSpecificDataVisaJSON `json:"-"`
}

func (*TransactionEventsNetworkSpecificDataVisa) UnmarshalJSON added in v0.75.0 

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

type TransactionEventsResult 

type TransactionEventsResult string
const (
	TransactionEventsResultAccountPaused               TransactionEventsResult = "ACCOUNT_PAUSED"
	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"
	TransactionEventsResultSuspectedFraud              TransactionEventsResult = "SUSPECTED_FRAUD"
	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 TransactionEventsRuleResult added in v0.64.0 

type TransactionEventsRuleResult struct {
	// The Auth Rule Token associated with the rule from which the decline originated.
	// If this is set to null, then the decline was not associated with a
	// customer-configured Auth Rule. This may happen in cases where a transaction is
	// declined due to a Lithic-configured security or compliance rule, for example.
	AuthRuleToken string `json:"auth_rule_token,required,nullable" format:"uuid"`
	// A human-readable explanation outlining the motivation for the rule's decline.
	Explanation string `json:"explanation,required,nullable"`
	// The name for the rule, if any was configured.
	Name string `json:"name,required,nullable"`
	// The detailed_result associated with this rule's decline.
	Result TransactionEventsRuleResultsResult `json:"result,required"`
	JSON   transactionEventsRuleResultJSON    `json:"-"`
}

func (*TransactionEventsRuleResult) UnmarshalJSON added in v0.64.0 

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

type TransactionEventsRuleResultsResult added in v0.64.0 

type TransactionEventsRuleResultsResult string

The detailed_result associated with this rule's decline. 

const (
	TransactionEventsRuleResultsResultAccountDailySpendLimitExceeded              TransactionEventsRuleResultsResult = "ACCOUNT_DAILY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsRuleResultsResultAccountDelinquent                           TransactionEventsRuleResultsResult = "ACCOUNT_DELINQUENT"
	TransactionEventsRuleResultsResultAccountInactive                             TransactionEventsRuleResultsResult = "ACCOUNT_INACTIVE"
	TransactionEventsRuleResultsResultAccountLifetimeSpendLimitExceeded           TransactionEventsRuleResultsResult = "ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED"
	TransactionEventsRuleResultsResultAccountMonthlySpendLimitExceeded            TransactionEventsRuleResultsResult = "ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsRuleResultsResultAccountPaused                               TransactionEventsRuleResultsResult = "ACCOUNT_PAUSED"
	TransactionEventsRuleResultsResultAccountUnderReview                          TransactionEventsRuleResultsResult = "ACCOUNT_UNDER_REVIEW"
	TransactionEventsRuleResultsResultAddressIncorrect                            TransactionEventsRuleResultsResult = "ADDRESS_INCORRECT"
	TransactionEventsRuleResultsResultApproved                                    TransactionEventsRuleResultsResult = "APPROVED"
	TransactionEventsRuleResultsResultAuthRuleAllowedCountry                      TransactionEventsRuleResultsResult = "AUTH_RULE_ALLOWED_COUNTRY"
	TransactionEventsRuleResultsResultAuthRuleAllowedMcc                          TransactionEventsRuleResultsResult = "AUTH_RULE_ALLOWED_MCC"
	TransactionEventsRuleResultsResultAuthRuleBlockedCountry                      TransactionEventsRuleResultsResult = "AUTH_RULE_BLOCKED_COUNTRY"
	TransactionEventsRuleResultsResultAuthRuleBlockedMcc                          TransactionEventsRuleResultsResult = "AUTH_RULE_BLOCKED_MCC"
	TransactionEventsRuleResultsResultAuthRule                                    TransactionEventsRuleResultsResult = "AUTH_RULE"
	TransactionEventsRuleResultsResultCardClosed                                  TransactionEventsRuleResultsResult = "CARD_CLOSED"
	TransactionEventsRuleResultsResultCardCryptogramValidationFailure             TransactionEventsRuleResultsResult = "CARD_CRYPTOGRAM_VALIDATION_FAILURE"
	TransactionEventsRuleResultsResultCardExpired                                 TransactionEventsRuleResultsResult = "CARD_EXPIRED"
	TransactionEventsRuleResultsResultCardExpiryDateIncorrect                     TransactionEventsRuleResultsResult = "CARD_EXPIRY_DATE_INCORRECT"
	TransactionEventsRuleResultsResultCardInvalid                                 TransactionEventsRuleResultsResult = "CARD_INVALID"
	TransactionEventsRuleResultsResultCardNotActivated                            TransactionEventsRuleResultsResult = "CARD_NOT_ACTIVATED"
	TransactionEventsRuleResultsResultCardPaused                                  TransactionEventsRuleResultsResult = "CARD_PAUSED"
	TransactionEventsRuleResultsResultCardPinIncorrect                            TransactionEventsRuleResultsResult = "CARD_PIN_INCORRECT"
	TransactionEventsRuleResultsResultCardRestricted                              TransactionEventsRuleResultsResult = "CARD_RESTRICTED"
	TransactionEventsRuleResultsResultCardSecurityCodeIncorrect                   TransactionEventsRuleResultsResult = "CARD_SECURITY_CODE_INCORRECT"
	TransactionEventsRuleResultsResultCardSpendLimitExceeded                      TransactionEventsRuleResultsResult = "CARD_SPEND_LIMIT_EXCEEDED"
	TransactionEventsRuleResultsResultContactCardIssuer                           TransactionEventsRuleResultsResult = "CONTACT_CARD_ISSUER"
	TransactionEventsRuleResultsResultCustomerAsaTimeout                          TransactionEventsRuleResultsResult = "CUSTOMER_ASA_TIMEOUT"
	TransactionEventsRuleResultsResultCustomAsaResult                             TransactionEventsRuleResultsResult = "CUSTOM_ASA_RESULT"
	TransactionEventsRuleResultsResultDeclined                                    TransactionEventsRuleResultsResult = "DECLINED"
	TransactionEventsRuleResultsResultDoNotHonor                                  TransactionEventsRuleResultsResult = "DO_NOT_HONOR"
	TransactionEventsRuleResultsResultDriverNumberInvalid                         TransactionEventsRuleResultsResult = "DRIVER_NUMBER_INVALID"
	TransactionEventsRuleResultsResultFormatError                                 TransactionEventsRuleResultsResult = "FORMAT_ERROR"
	TransactionEventsRuleResultsResultInsufficientFundingSourceBalance            TransactionEventsRuleResultsResult = "INSUFFICIENT_FUNDING_SOURCE_BALANCE"
	TransactionEventsRuleResultsResultInsufficientFunds                           TransactionEventsRuleResultsResult = "INSUFFICIENT_FUNDS"
	TransactionEventsRuleResultsResultLithicSystemError                           TransactionEventsRuleResultsResult = "LITHIC_SYSTEM_ERROR"
	TransactionEventsRuleResultsResultLithicSystemRateLimit                       TransactionEventsRuleResultsResult = "LITHIC_SYSTEM_RATE_LIMIT"
	TransactionEventsRuleResultsResultMalformedAsaResponse                        TransactionEventsRuleResultsResult = "MALFORMED_ASA_RESPONSE"
	TransactionEventsRuleResultsResultMerchantInvalid                             TransactionEventsRuleResultsResult = "MERCHANT_INVALID"
	TransactionEventsRuleResultsResultMerchantLockedCardAttemptedElsewhere        TransactionEventsRuleResultsResult = "MERCHANT_LOCKED_CARD_ATTEMPTED_ELSEWHERE"
	TransactionEventsRuleResultsResultMerchantNotPermitted                        TransactionEventsRuleResultsResult = "MERCHANT_NOT_PERMITTED"
	TransactionEventsRuleResultsResultOverReversalAttempted                       TransactionEventsRuleResultsResult = "OVER_REVERSAL_ATTEMPTED"
	TransactionEventsRuleResultsResultPinBlocked                                  TransactionEventsRuleResultsResult = "PIN_BLOCKED"
	TransactionEventsRuleResultsResultProgramCardSpendLimitExceeded               TransactionEventsRuleResultsResult = "PROGRAM_CARD_SPEND_LIMIT_EXCEEDED"
	TransactionEventsRuleResultsResultProgramSuspended                            TransactionEventsRuleResultsResult = "PROGRAM_SUSPENDED"
	TransactionEventsRuleResultsResultProgramUsageRestriction                     TransactionEventsRuleResultsResult = "PROGRAM_USAGE_RESTRICTION"
	TransactionEventsRuleResultsResultReversalUnmatched                           TransactionEventsRuleResultsResult = "REVERSAL_UNMATCHED"
	TransactionEventsRuleResultsResultSecurityViolation                           TransactionEventsRuleResultsResult = "SECURITY_VIOLATION"
	TransactionEventsRuleResultsResultSingleUseCardReattempted                    TransactionEventsRuleResultsResult = "SINGLE_USE_CARD_REATTEMPTED"
	TransactionEventsRuleResultsResultSuspectedFraud                              TransactionEventsRuleResultsResult = "SUSPECTED_FRAUD"
	TransactionEventsRuleResultsResultTransactionInvalid                          TransactionEventsRuleResultsResult = "TRANSACTION_INVALID"
	TransactionEventsRuleResultsResultTransactionNotPermittedToAcquirerOrTerminal TransactionEventsRuleResultsResult = "TRANSACTION_NOT_PERMITTED_TO_ACQUIRER_OR_TERMINAL"
	TransactionEventsRuleResultsResultTransactionNotPermittedToIssuerOrCardholder TransactionEventsRuleResultsResult = "TRANSACTION_NOT_PERMITTED_TO_ISSUER_OR_CARDHOLDER"
	TransactionEventsRuleResultsResultTransactionPreviouslyCompleted              TransactionEventsRuleResultsResult = "TRANSACTION_PREVIOUSLY_COMPLETED"
	TransactionEventsRuleResultsResultUnauthorizedMerchant                        TransactionEventsRuleResultsResult = "UNAUTHORIZED_MERCHANT"
	TransactionEventsRuleResultsResultVehicleNumberInvalid                        TransactionEventsRuleResultsResult = "VEHICLE_NUMBER_INVALID"
	TransactionEventsRuleResultsResultCardholderChallenged                        TransactionEventsRuleResultsResult = "CARDHOLDER_CHALLENGED"
	TransactionEventsRuleResultsResultCardholderChallengeFailed                   TransactionEventsRuleResultsResult = "CARDHOLDER_CHALLENGE_FAILED"
)

func (TransactionEventsRuleResultsResult) IsKnown added in v0.64.0 

func (r TransactionEventsRuleResultsResult) 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"`
	// Filters for transactions using transaction status field.
	Status param.Field[TransactionListParamsStatus] `query:"status"`
}

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 TransactionListParamsStatus added in v0.64.0 

type TransactionListParamsStatus string

Filters for transactions using transaction status field. 

const (
	TransactionListParamsStatusPending  TransactionListParamsStatus = "PENDING"
	TransactionListParamsStatusVoided   TransactionListParamsStatus = "VOIDED"
	TransactionListParamsStatusSettled  TransactionListParamsStatus = "SETTLED"
	TransactionListParamsStatusDeclined TransactionListParamsStatus = "DECLINED"
	TransactionListParamsStatusExpired  TransactionListParamsStatus = "EXPIRED"
)

func (TransactionListParamsStatus) IsKnown added in v0.64.0 

func (r TransactionListParamsStatus) IsKnown() bool

type TransactionNetwork 

type TransactionNetwork string

Card network of the authorization. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider. 

const (
	TransactionNetworkAmex       TransactionNetwork = "AMEX"
	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"`
	// Uniquely identifies a terminal at the card acceptor location of acquiring
	// institutions or merchant POS Systems
	AcceptorTerminalID string                     `json:"acceptor_terminal_id,nullable"`
	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 (
	TransactionResultAccountPaused               TransactionResult = "ACCOUNT_PAUSED"
	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"
	TransactionResultSuspectedFraud              TransactionResult = "SUSPECTED_FRAUD"
	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) ExpireAuthorization added in v0.70.0 

func (r *TransactionService) ExpireAuthorization(ctx context.Context, transactionToken string, opts ...option.RequestOption) (err error)

Expire authorization

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 card network as if it came from a merchant acquirer. If you are configured for ASA, simulating authorizations requires your ASA client to be set up properly, i.e. be able to respond to the ASA request with a valid JSON. For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. You can update this limit 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 from the card network as if it came from a merchant acquirer. An authorization advice changes the pending 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, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.

If `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

func (*TransactionService) SimulateCreditAuthorization deprecated 

func (r *TransactionService) SimulateCreditAuthorization(ctx context.Context, body TransactionSimulateCreditAuthorizationParams, opts ...option.RequestOption) (res *TransactionSimulateCreditAuthorizationResponse, err error)

Simulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf.

Deprecated: use `SimulateCreditAuthorizationAdvice` instead

func (*TransactionService) SimulateCreditAuthorizationAdvice added in v0.92.0 

func (r *TransactionService) SimulateCreditAuthorizationAdvice(ctx context.Context, body TransactionSimulateCreditAuthorizationAdviceParams, opts ...option.RequestOption) (res *TransactionSimulateCreditAuthorizationAdviceResponse, err error)

Simulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf.

func (*TransactionService) SimulateReturn 

func (r *TransactionService) SimulateReturn(ctx context.Context, body TransactionSimulateReturnParams, opts ...option.RequestOption) (res *TransactionSimulateReturnResponse, err error)

Returns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a `SETTLED` transaction status.

func (*TransactionService) SimulateReturnReversal 

func (r *TransactionService) SimulateReturnReversal(ctx context.Context, body TransactionSimulateReturnReversalParams, opts ...option.RequestOption) (res *TransactionSimulateReturnReversalResponse, err error)

Reverses a return, i.e. a credit transaction with a `SETTLED` status. Returns can be financial credit authorizations, or credit authorizations that have cleared.

func (*TransactionService) SimulateVoid 

func (r *TransactionService) SimulateVoid(ctx context.Context, body TransactionSimulateVoidParams, opts ...option.RequestOption) (res *TransactionSimulateVoidResponse, err error)

Voids a pending authorization. If `amount` is not set, the full amount will be voided. Can be used on partially voided transactions but not partially cleared transactions. _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 result
	// in 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-character 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"`
	// Simulate entering a PIN. If omitted, PIN check will not be performed.
	Pin param.Field[string] `json:"pin"`
	// 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 requesting the balance held on the
	//     card, and is most often observed 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, 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 requesting the balance held on the card, and is most often observed 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, 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 clear. Typically this will match the amount in the original
	// authorization, but can be higher or lower. The sign of this amount will
	// automatically match the sign of the original authorization's amount. For
	// example, entering 100 in this field will result in a -100 amount in the
	// transaction, if the original authorization is a credit authorization.
	//
	// If `amount` is not set, the full amount of the transaction will be cleared.
	// Transactions that have already cleared, either partially or fully, cannot be
	// cleared again using this endpoint.
	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 TransactionSimulateCreditAuthorizationAdviceParams added in v0.92.0 

type TransactionSimulateCreditAuthorizationAdviceParams 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 (TransactionSimulateCreditAuthorizationAdviceParams) MarshalJSON added in v0.92.0 

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

type TransactionSimulateCreditAuthorizationAdviceResponse added in v0.92.0 

type TransactionSimulateCreditAuthorizationAdviceResponse 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               transactionSimulateCreditAuthorizationAdviceResponseJSON `json:"-"`
}

func (*TransactionSimulateCreditAuthorizationAdviceResponse) UnmarshalJSON added in v0.92.0 

func (r *TransactionSimulateCreditAuthorizationAdviceResponse) 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 amount in the original
	// authorization, but can be less. Applies to authorization reversals only. An
	// authorization expiry will always apply to the full pending amount.
	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 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-character 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 []shared.FinancialEvent `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 TransferLimitListParams added in v0.99.0 

type TransferLimitListParams struct {
	// Date for which to retrieve transfer limits (ISO 8601 format)
	Date param.Field[time.Time] `query:"date" format:"date"`
}

func (TransferLimitListParams) URLQuery added in v0.99.0 

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

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

type TransferLimitService added in v0.99.0 

type TransferLimitService struct {
	Options []option.RequestOption
}

TransferLimitService 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 NewTransferLimitService method instead.

func NewTransferLimitService added in v0.99.0 

func NewTransferLimitService(opts ...option.RequestOption) (r *TransferLimitService)

NewTransferLimitService 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 (*TransferLimitService) List added in v0.99.0 

func (r *TransferLimitService) List(ctx context.Context, query TransferLimitListParams, opts ...option.RequestOption) (res *pagination.SinglePage[TransferLimitsResponseData], err error)

Get transfer limits for a specified date

func (*TransferLimitService) ListAutoPaging added in v0.99.0 

func (r *TransferLimitService) ListAutoPaging(ctx context.Context, query TransferLimitListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[TransferLimitsResponseData]

Get transfer limits for a specified date

type TransferLimitsResponse added in v0.99.0 

type TransferLimitsResponse struct {
	// List of transfer limits
	Data []TransferLimitsResponseData `json:"data,required"`
	// Whether there are more transfer limits
	HasMore bool                       `json:"has_more,required"`
	JSON    transferLimitsResponseJSON `json:"-"`
}

func (*TransferLimitsResponse) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseData added in v0.99.0 

type TransferLimitsResponseData struct {
	// Company ID
	CompanyID string `json:"company_id,required"`
	// Daily limits with progress
	DailyLimit TransferLimitsResponseDataDailyLimit `json:"daily_limit,required"`
	// The date for the limit view (ISO format)
	Date time.Time `json:"date,required" format:"date"`
	// Whether the company is a FBO; based on the company ID prefix
	IsFbo bool `json:"is_fbo,required"`
	// Monthly limits with progress
	MonthlyLimit TransferLimitsResponseDataMonthlyLimit `json:"monthly_limit,required"`
	// Program transaction limits
	ProgramLimitPerTransaction TransferLimitsResponseDataProgramLimitPerTransaction `json:"program_limit_per_transaction,required"`
	JSON                       transferLimitsResponseDataJSON                       `json:"-"`
}

func (*TransferLimitsResponseData) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataDailyLimit added in v0.99.0 

type TransferLimitsResponseDataDailyLimit struct {
	// Credit limits
	Credit TransferLimitsResponseDataDailyLimitCredit `json:"credit,required"`
	// Debit limits
	Debit TransferLimitsResponseDataDailyLimitDebit `json:"debit,required"`
	JSON  transferLimitsResponseDataDailyLimitJSON  `json:"-"`
}

Daily limits with progress

func (*TransferLimitsResponseDataDailyLimit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataDailyLimitCredit added in v0.99.0 

type TransferLimitsResponseDataDailyLimitCredit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                          `json:"amount_originated"`
	JSON             transferLimitsResponseDataDailyLimitCreditJSON `json:"-"`
}

Credit limits

func (*TransferLimitsResponseDataDailyLimitCredit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataDailyLimitDebit added in v0.99.0 

type TransferLimitsResponseDataDailyLimitDebit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                         `json:"amount_originated"`
	JSON             transferLimitsResponseDataDailyLimitDebitJSON `json:"-"`
}

Debit limits

func (*TransferLimitsResponseDataDailyLimitDebit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataMonthlyLimit added in v0.99.0 

type TransferLimitsResponseDataMonthlyLimit struct {
	// Credit limits
	Credit TransferLimitsResponseDataMonthlyLimitCredit `json:"credit,required"`
	// Debit limits
	Debit TransferLimitsResponseDataMonthlyLimitDebit `json:"debit,required"`
	JSON  transferLimitsResponseDataMonthlyLimitJSON  `json:"-"`
}

Monthly limits with progress

func (*TransferLimitsResponseDataMonthlyLimit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataMonthlyLimitCredit added in v0.99.0 

type TransferLimitsResponseDataMonthlyLimitCredit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                            `json:"amount_originated"`
	JSON             transferLimitsResponseDataMonthlyLimitCreditJSON `json:"-"`
}

Credit limits

func (*TransferLimitsResponseDataMonthlyLimitCredit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataMonthlyLimitDebit added in v0.99.0 

type TransferLimitsResponseDataMonthlyLimitDebit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                           `json:"amount_originated"`
	JSON             transferLimitsResponseDataMonthlyLimitDebitJSON `json:"-"`
}

Debit limits

func (*TransferLimitsResponseDataMonthlyLimitDebit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataProgramLimitPerTransaction added in v0.99.0 

type TransferLimitsResponseDataProgramLimitPerTransaction struct {
	// Credit limits
	Credit TransferLimitsResponseDataProgramLimitPerTransactionCredit `json:"credit,required"`
	// Debit limits
	Debit TransferLimitsResponseDataProgramLimitPerTransactionDebit `json:"debit,required"`
	JSON  transferLimitsResponseDataProgramLimitPerTransactionJSON  `json:"-"`
}

Program transaction limits

func (*TransferLimitsResponseDataProgramLimitPerTransaction) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataProgramLimitPerTransactionCredit added in v0.99.0 

type TransferLimitsResponseDataProgramLimitPerTransactionCredit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                                          `json:"amount_originated"`
	JSON             transferLimitsResponseDataProgramLimitPerTransactionCreditJSON `json:"-"`
}

Credit limits

func (*TransferLimitsResponseDataProgramLimitPerTransactionCredit) UnmarshalJSON added in v0.99.0 

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

type TransferLimitsResponseDataProgramLimitPerTransactionDebit added in v0.99.0 

type TransferLimitsResponseDataProgramLimitPerTransactionDebit struct {
	// The limit amount
	Limit int64 `json:"limit,required"`
	// Amount originated towards limit
	AmountOriginated int64                                                         `json:"amount_originated"`
	JSON             transferLimitsResponseDataProgramLimitPerTransactionDebitJSON `json:"-"`
}

Debit limits

func (*TransferLimitsResponseDataProgramLimitPerTransactionDebit) UnmarshalJSON added in v0.99.0 

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

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 deprecated 

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

Deprecated: deprecated

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 struct {
	Filters VelocityLimitParamsFilters `json:"filters,required"`
	// Velocity over the current day since 00:00 / 12 AM in Eastern Time
	Period VelocityLimitPeriod `json:"period,required"`
	// The scope the velocity is calculated for
	Scope VelocityLimitParamsScope `json:"scope,required"`
	// 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 int64 `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 int64                   `json:"limit_count,nullable"`
	JSON       velocityLimitParamsJSON `json:"-"`
}

func (*VelocityLimitParams) UnmarshalJSON added in v0.64.0 

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

type VelocityLimitParamsFilters added in v0.51.0 

type VelocityLimitParamsFilters struct {
	// ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
	// Transactions matching any of the provided will be excluded from the calculated
	// velocity.
	ExcludeCountries []string `json:"exclude_countries,nullable"`
	// Merchant Category Codes to exclude from the velocity calculation. Transactions
	// matching this MCC will be excluded from the calculated velocity.
	ExcludeMccs []string `json:"exclude_mccs,nullable"`
	// ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
	// Transactions not matching any of the provided will not be included in the
	// calculated velocity.
	IncludeCountries []string `json:"include_countries,nullable"`
	// Merchant Category Codes to include in the velocity calculation. Transactions not
	// matching this MCC will not be included in the calculated velocity.
	IncludeMccs []string `json:"include_mccs,nullable"`
	// PAN entry modes to include in the velocity calculation. Transactions not
	// matching any of the provided will not be included in the calculated velocity.
	IncludePanEntryModes []VelocityLimitParamsFiltersIncludePanEntryMode `json:"include_pan_entry_modes,nullable"`
	JSON                 velocityLimitParamsFiltersJSON                  `json:"-"`
}

func (*VelocityLimitParamsFilters) UnmarshalJSON added in v0.64.0 

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

type VelocityLimitParamsFiltersIncludePanEntryMode added in v0.93.0 

type VelocityLimitParamsFiltersIncludePanEntryMode string
const (
	VelocityLimitParamsFiltersIncludePanEntryModeAutoEntry           VelocityLimitParamsFiltersIncludePanEntryMode = "AUTO_ENTRY"
	VelocityLimitParamsFiltersIncludePanEntryModeBarCode             VelocityLimitParamsFiltersIncludePanEntryMode = "BAR_CODE"
	VelocityLimitParamsFiltersIncludePanEntryModeContactless         VelocityLimitParamsFiltersIncludePanEntryMode = "CONTACTLESS"
	VelocityLimitParamsFiltersIncludePanEntryModeCredentialOnFile    VelocityLimitParamsFiltersIncludePanEntryMode = "CREDENTIAL_ON_FILE"
	VelocityLimitParamsFiltersIncludePanEntryModeEcommerce           VelocityLimitParamsFiltersIncludePanEntryMode = "ECOMMERCE"
	VelocityLimitParamsFiltersIncludePanEntryModeErrorKeyed          VelocityLimitParamsFiltersIncludePanEntryMode = "ERROR_KEYED"
	VelocityLimitParamsFiltersIncludePanEntryModeErrorMagneticStripe VelocityLimitParamsFiltersIncludePanEntryMode = "ERROR_MAGNETIC_STRIPE"
	VelocityLimitParamsFiltersIncludePanEntryModeIcc                 VelocityLimitParamsFiltersIncludePanEntryMode = "ICC"
	VelocityLimitParamsFiltersIncludePanEntryModeKeyEntered          VelocityLimitParamsFiltersIncludePanEntryMode = "KEY_ENTERED"
	VelocityLimitParamsFiltersIncludePanEntryModeMagneticStripe      VelocityLimitParamsFiltersIncludePanEntryMode = "MAGNETIC_STRIPE"
	VelocityLimitParamsFiltersIncludePanEntryModeManual              VelocityLimitParamsFiltersIncludePanEntryMode = "MANUAL"
	VelocityLimitParamsFiltersIncludePanEntryModeOcr                 VelocityLimitParamsFiltersIncludePanEntryMode = "OCR"
	VelocityLimitParamsFiltersIncludePanEntryModeSecureCardless      VelocityLimitParamsFiltersIncludePanEntryMode = "SECURE_CARDLESS"
	VelocityLimitParamsFiltersIncludePanEntryModeUnspecified         VelocityLimitParamsFiltersIncludePanEntryMode = "UNSPECIFIED"
	VelocityLimitParamsFiltersIncludePanEntryModeUnknown             VelocityLimitParamsFiltersIncludePanEntryMode = "UNKNOWN"
)

func (VelocityLimitParamsFiltersIncludePanEntryMode) IsKnown added in v0.93.0 

func (r VelocityLimitParamsFiltersIncludePanEntryMode) IsKnown() bool

type VelocityLimitParamsScope added in v0.51.0 

type VelocityLimitParamsScope string

The scope the velocity is calculated for 

const (
	VelocityLimitParamsScopeCard    VelocityLimitParamsScope = "CARD"
	VelocityLimitParamsScopeAccount VelocityLimitParamsScope = "ACCOUNT"
)

func (VelocityLimitParamsScope) IsKnown added in v0.64.0 

func (r VelocityLimitParamsScope) IsKnown() bool

type VelocityLimitPeriod added in v0.96.0 

type VelocityLimitPeriod struct {
	Type VelocityLimitPeriodType `json:"type,required"`
	// The day of the month to start from. Accepts values from 1 to 31, and will reset
	// at the end of the month if the day exceeds the number of days in the month.
	// Defaults to the 1st of the month if not specified.
	DayOfMonth int64 `json:"day_of_month"`
	// The day of the week to start the week from. Following ISO-8601, 1 is Monday and
	// 7 is Sunday. Defaults to Monday if not specified.
	DayOfWeek int64 `json:"day_of_week"`
	// 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 (31 days).
	Duration int64 `json:"duration"`
	// The month to start from. 1 is January and 12 is December. Defaults to January if
	// not specified.
	Month int64                   `json:"month"`
	JSON  velocityLimitPeriodJSON `json:"-"`
	// contains filtered or unexported fields
}

Velocity over the current day since 00:00 / 12 AM in Eastern Time

func (VelocityLimitPeriod) AsUnion added in v0.96.0 

func (r VelocityLimitPeriod) AsUnion() VelocityLimitPeriodUnion

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

Possible runtime types of the union are VelocityLimitPeriodTrailingWindowObject, VelocityLimitPeriodFixedWindowDay, VelocityLimitPeriodFixedWindowWeek, VelocityLimitPeriodFixedWindowMonth, VelocityLimitPeriodFixedWindowYear.

func (*VelocityLimitPeriod) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowDay added in v0.96.0 

type VelocityLimitPeriodFixedWindowDay struct {
	Type VelocityLimitPeriodFixedWindowDayType `json:"type,required"`
	JSON velocityLimitPeriodFixedWindowDayJSON `json:"-"`
}

Velocity over the current day since 00:00 / 12 AM in Eastern Time

func (*VelocityLimitPeriodFixedWindowDay) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowDayParam added in v0.96.0 

type VelocityLimitPeriodFixedWindowDayParam struct {
	Type param.Field[VelocityLimitPeriodFixedWindowDayType] `json:"type,required"`
}

Velocity over the current day since 00:00 / 12 AM in Eastern Time

func (VelocityLimitPeriodFixedWindowDayParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowDayType added in v0.96.0 

type VelocityLimitPeriodFixedWindowDayType string
const (
	VelocityLimitPeriodFixedWindowDayTypeDay VelocityLimitPeriodFixedWindowDayType = "DAY"
)

func (VelocityLimitPeriodFixedWindowDayType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodFixedWindowDayType) IsKnown() bool

type VelocityLimitPeriodFixedWindowMonth added in v0.96.0 

type VelocityLimitPeriodFixedWindowMonth struct {
	Type VelocityLimitPeriodFixedWindowMonthType `json:"type,required"`
	// The day of the month to start from. Accepts values from 1 to 31, and will reset
	// at the end of the month if the day exceeds the number of days in the month.
	// Defaults to the 1st of the month if not specified.
	DayOfMonth int64                                   `json:"day_of_month"`
	JSON       velocityLimitPeriodFixedWindowMonthJSON `json:"-"`
}

Velocity over the current month since 00:00 / 12 AM in Eastern Time on specified `day_of_month`.

func (*VelocityLimitPeriodFixedWindowMonth) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowMonthParam added in v0.96.0 

type VelocityLimitPeriodFixedWindowMonthParam struct {
	Type param.Field[VelocityLimitPeriodFixedWindowMonthType] `json:"type,required"`
	// The day of the month to start from. Accepts values from 1 to 31, and will reset
	// at the end of the month if the day exceeds the number of days in the month.
	// Defaults to the 1st of the month if not specified.
	DayOfMonth param.Field[int64] `json:"day_of_month"`
}

Velocity over the current month since 00:00 / 12 AM in Eastern Time on specified `day_of_month`.

func (VelocityLimitPeriodFixedWindowMonthParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowMonthType added in v0.96.0 

type VelocityLimitPeriodFixedWindowMonthType string
const (
	VelocityLimitPeriodFixedWindowMonthTypeMonth VelocityLimitPeriodFixedWindowMonthType = "MONTH"
)

func (VelocityLimitPeriodFixedWindowMonthType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodFixedWindowMonthType) IsKnown() bool

type VelocityLimitPeriodFixedWindowWeek added in v0.96.0 

type VelocityLimitPeriodFixedWindowWeek struct {
	Type VelocityLimitPeriodFixedWindowWeekType `json:"type,required"`
	// The day of the week to start the week from. Following ISO-8601, 1 is Monday and
	// 7 is Sunday. Defaults to Monday if not specified.
	DayOfWeek int64                                  `json:"day_of_week"`
	JSON      velocityLimitPeriodFixedWindowWeekJSON `json:"-"`
}

Velocity over the current week since 00:00 / 12 AM in Eastern Time on specified `day_of_week`

func (*VelocityLimitPeriodFixedWindowWeek) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowWeekParam added in v0.96.0 

type VelocityLimitPeriodFixedWindowWeekParam struct {
	Type param.Field[VelocityLimitPeriodFixedWindowWeekType] `json:"type,required"`
	// The day of the week to start the week from. Following ISO-8601, 1 is Monday and
	// 7 is Sunday. Defaults to Monday if not specified.
	DayOfWeek param.Field[int64] `json:"day_of_week"`
}

Velocity over the current week since 00:00 / 12 AM in Eastern Time on specified `day_of_week`

func (VelocityLimitPeriodFixedWindowWeekParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowWeekType added in v0.96.0 

type VelocityLimitPeriodFixedWindowWeekType string
const (
	VelocityLimitPeriodFixedWindowWeekTypeWeek VelocityLimitPeriodFixedWindowWeekType = "WEEK"
)

func (VelocityLimitPeriodFixedWindowWeekType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodFixedWindowWeekType) IsKnown() bool

type VelocityLimitPeriodFixedWindowYear added in v0.96.0 

type VelocityLimitPeriodFixedWindowYear struct {
	Type VelocityLimitPeriodFixedWindowYearType `json:"type,required"`
	// The day of the month to start from. Defaults to the 1st of the month if not
	// specified.
	DayOfMonth int64 `json:"day_of_month"`
	// The month to start from. 1 is January and 12 is December. Defaults to January if
	// not specified.
	Month int64                                  `json:"month"`
	JSON  velocityLimitPeriodFixedWindowYearJSON `json:"-"`
}

Velocity over the current year since 00:00 / 12 AM in Eastern Time on specified `month` and `day_of_month`. This validates the month and day of the year to start from is a real date. In the event that February 29th is selected, in non-leap years, the window will start from February 28th.

func (*VelocityLimitPeriodFixedWindowYear) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowYearParam added in v0.96.0 

type VelocityLimitPeriodFixedWindowYearParam struct {
	Type param.Field[VelocityLimitPeriodFixedWindowYearType] `json:"type,required"`
	// The day of the month to start from. Defaults to the 1st of the month if not
	// specified.
	DayOfMonth param.Field[int64] `json:"day_of_month"`
	// The month to start from. 1 is January and 12 is December. Defaults to January if
	// not specified.
	Month param.Field[int64] `json:"month"`
}

Velocity over the current year since 00:00 / 12 AM in Eastern Time on specified `month` and `day_of_month`. This validates the month and day of the year to start from is a real date. In the event that February 29th is selected, in non-leap years, the window will start from February 28th.

func (VelocityLimitPeriodFixedWindowYearParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodFixedWindowYearType added in v0.96.0 

type VelocityLimitPeriodFixedWindowYearType string
const (
	VelocityLimitPeriodFixedWindowYearTypeYear VelocityLimitPeriodFixedWindowYearType = "YEAR"
)

func (VelocityLimitPeriodFixedWindowYearType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodFixedWindowYearType) IsKnown() bool

type VelocityLimitPeriodParam added in v0.96.0 

type VelocityLimitPeriodParam struct {
	Type param.Field[VelocityLimitPeriodType] `json:"type,required"`
	// The day of the month to start from. Accepts values from 1 to 31, and will reset
	// at the end of the month if the day exceeds the number of days in the month.
	// Defaults to the 1st of the month if not specified.
	DayOfMonth param.Field[int64] `json:"day_of_month"`
	// The day of the week to start the week from. Following ISO-8601, 1 is Monday and
	// 7 is Sunday. Defaults to Monday if not specified.
	DayOfWeek param.Field[int64] `json:"day_of_week"`
	// 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 (31 days).
	Duration param.Field[int64] `json:"duration"`
	// The month to start from. 1 is January and 12 is December. Defaults to January if
	// not specified.
	Month param.Field[int64] `json:"month"`
}

Velocity over the current day since 00:00 / 12 AM in Eastern Time

func (VelocityLimitPeriodParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodTrailingWindowObject added in v0.96.0 

type VelocityLimitPeriodTrailingWindowObject struct {
	// 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 (31 days).
	Duration int64                                       `json:"duration,required"`
	Type     VelocityLimitPeriodTrailingWindowObjectType `json:"type,required"`
	JSON     velocityLimitPeriodTrailingWindowObjectJSON `json:"-"`
}

func (*VelocityLimitPeriodTrailingWindowObject) UnmarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodTrailingWindowObjectParam added in v0.96.0 

type VelocityLimitPeriodTrailingWindowObjectParam struct {
	// 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 (31 days).
	Duration param.Field[int64]                                       `json:"duration,required"`
	Type     param.Field[VelocityLimitPeriodTrailingWindowObjectType] `json:"type,required"`
}

func (VelocityLimitPeriodTrailingWindowObjectParam) MarshalJSON added in v0.96.0 

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

type VelocityLimitPeriodTrailingWindowObjectType added in v0.96.0 

type VelocityLimitPeriodTrailingWindowObjectType string
const (
	VelocityLimitPeriodTrailingWindowObjectTypeCustom VelocityLimitPeriodTrailingWindowObjectType = "CUSTOM"
)

func (VelocityLimitPeriodTrailingWindowObjectType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodTrailingWindowObjectType) IsKnown() bool

type VelocityLimitPeriodType added in v0.96.0 

type VelocityLimitPeriodType string
const (
	VelocityLimitPeriodTypeCustom VelocityLimitPeriodType = "CUSTOM"
	VelocityLimitPeriodTypeDay    VelocityLimitPeriodType = "DAY"
	VelocityLimitPeriodTypeWeek   VelocityLimitPeriodType = "WEEK"
	VelocityLimitPeriodTypeMonth  VelocityLimitPeriodType = "MONTH"
	VelocityLimitPeriodTypeYear   VelocityLimitPeriodType = "YEAR"
)

func (VelocityLimitPeriodType) IsKnown added in v0.96.0 

func (r VelocityLimitPeriodType) IsKnown() bool

type VelocityLimitPeriodUnion added in v0.96.0 

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

Velocity over the current day since 00:00 / 12 AM in Eastern Time

Union satisfied by VelocityLimitPeriodTrailingWindowObject, VelocityLimitPeriodFixedWindowDay, VelocityLimitPeriodFixedWindowWeek, VelocityLimitPeriodFixedWindowMonth or VelocityLimitPeriodFixedWindowYear.

type VelocityLimitPeriodUnionParam added in v0.96.0 

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

Velocity over the current day since 00:00 / 12 AM in Eastern Time

Satisfied by VelocityLimitPeriodTrailingWindowObjectParam, VelocityLimitPeriodFixedWindowDayParam, VelocityLimitPeriodFixedWindowWeekParam, VelocityLimitPeriodFixedWindowMonthParam, VelocityLimitPeriodFixedWindowYearParam, VelocityLimitPeriodParam.

type VerificationMethod added in v0.6.5 

type VerificationMethod string
const (
	VerificationMethodManual             VerificationMethod = "MANUAL"
	VerificationMethodMicroDeposit       VerificationMethod = "MICRO_DEPOSIT"
	VerificationMethodPrenote            VerificationMethod = "PRENOTE"
	VerificationMethodExternallyVerified VerificationMethod = "EXTERNALLY_VERIFIED"
	VerificationMethodUnverified         VerificationMethod = "UNVERIFIED"
)

func (VerificationMethod) IsKnown added in v0.27.0 

func (r VerificationMethod) IsKnown() bool

type WalletDecisioningInfo added in v0.98.0 

type WalletDecisioningInfo struct {
	// Score given to the account by the Wallet Provider
	AccountScore string `json:"account_score,required,nullable"`
	// Score given to the device by the Wallet Provider
	DeviceScore string `json:"device_score,required,nullable"`
	// The decision recommended by the Wallet Provider
	RecommendedDecision string `json:"recommended_decision,required,nullable"`
	// Reasons provided to the Wallet Provider on how the recommended decision was
	// reached
	RecommendationReasons []string                  `json:"recommendation_reasons,nullable"`
	JSON                  walletDecisioningInfoJSON `json:"-"`
}

func (*WalletDecisioningInfo) UnmarshalJSON added in v0.98.0 

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

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) Parse added in v0.98.0 

func (r *WebhookService) Parse(payload []byte, headers http.Header, opts ...option.RequestOption) (*ParsedWebhookEvent, error)

func (*WebhookService) ParseUnsafe added in v0.98.0 

func (r *WebhookService) ParseUnsafe(payload []byte) (*ParsedWebhookEvent, error)

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 WirePartyDetails added in v0.90.0 

type WirePartyDetails struct {
	// Account number
	AccountNumber string `json:"account_number,nullable"`
	// Routing number or BIC of the financial institution
	AgentID string `json:"agent_id,nullable"`
	// Name of the financial institution
	AgentName string `json:"agent_name,nullable"`
	// Name of the person or company
	Name string               `json:"name,nullable"`
	JSON wirePartyDetailsJSON `json:"-"`
}

func (*WirePartyDetails) UnmarshalJSON added in v0.90.0 

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

Source Files

View all Source files

Directories

Path Synopsis
examples
card_embed_html command
dispute_upload command
union command
integrations
pagination command
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.