lithic

package module
v0.21.0 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

README

Lithic Go API Library

Go Reference

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

Installation

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

Or to pin the version:

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

Requirements

This library requires Go 1.18+.

Usage

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

package main

import (
	"context"
	"fmt"
	"github.com/lithic-com/lithic-go"
	"github.com/lithic-com/lithic-go/option"
)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The full list of request options is here.

Pagination

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

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

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

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

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

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

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

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

Retries

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

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

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

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

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

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

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

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

    return res, err
}

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

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

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

Semantic Versioning

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool added in v0.6.5 

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

Bool is a param field helper which helps specify bools.

func F 

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

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

func 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 explciitly 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"`
	// 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`.
	State         AccountState         `json:"state,required"`
	AccountHolder AccountAccountHolder `json:"account_holder"`
	// List of identifiers for the Auth Rule(s) that are applied on the account.
	AuthRuleTokens      []string                   `json:"auth_rule_tokens"`
	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 AccountCreditConfigurationService added in v0.9.0 

type AccountCreditConfigurationService struct {
	Options []option.RequestOption
}

AccountCreditConfigurationService 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 NewAccountCreditConfigurationService method instead.

func NewAccountCreditConfigurationService added in v0.9.0 

func NewAccountCreditConfigurationService(opts ...option.RequestOption) (r *AccountCreditConfigurationService)

NewAccountCreditConfigurationService 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 (*AccountCreditConfigurationService) Get added in v0.9.0 

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

Get an Account's credit configuration

func (*AccountCreditConfigurationService) Update added in v0.9.0 

func (r *AccountCreditConfigurationService) Update(ctx context.Context, accountToken string, body AccountCreditConfigurationUpdateParams, opts ...option.RequestOption) (res *BusinessAccount, err error)

Update a Business Accounts credit configuration

type AccountCreditConfigurationUpdateParams added in v0.9.0 

type AccountCreditConfigurationUpdateParams struct {
	// Number of days within the billing period
	BillingPeriod param.Field[int64] `json:"billing_period"`
	// Credit limit extended to the Business Account
	CreditLimit param.Field[int64] `json:"credit_limit"`
	// The external bank account token to use for auto-collections
	ExternalBankAccountToken param.Field[string] `json:"external_bank_account_token" format:"uuid"`
	// Number of days after the billing period ends that a payment is required
	PaymentPeriod param.Field[int64] `json:"payment_period"`
}

func (AccountCreditConfigurationUpdateParams) MarshalJSON added in v0.9.0 

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

type AccountHolder 

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

func (*AccountHolder) UnmarshalJSON 

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

type AccountHolderBeneficialOwnerEntity added in v0.8.0 

type AccountHolderBeneficialOwnerEntity struct {
	// Business's physical address - PO boxes, UPS drops, and FedEx drops are not
	// acceptable; APO/FPO are acceptable.
	Address shared.Address `json:"address,required"`
	// 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          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"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address.
	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        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"`
	// 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          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"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address.
	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        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 AccountHolderDocument 

type AccountHolderDocument struct {
	// Globally unique identifier for the document.
	Token string `json:"token" format:"uuid"`
	// Globally unique identifier for the account holder.
	AccountHolderToken string `json:"account_holder_token" format:"uuid"`
	// Type of documentation to be submitted for verification.
	DocumentType            AccountHolderDocumentDocumentType             `json:"document_type"`
	RequiredDocumentUploads []AccountHolderDocumentRequiredDocumentUpload `json:"required_document_uploads"`
	JSON                    accountHolderDocumentJSON                     `json:"-"`
}

Describes the document and the required document image uploads required to re-run KYC.

func (*AccountHolderDocument) UnmarshalJSON 

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

type AccountHolderDocumentDocumentType 

type AccountHolderDocumentDocumentType string

Type of documentation to be submitted for verification. 

const (
	AccountHolderDocumentDocumentTypeCommercialLicense AccountHolderDocumentDocumentType = "commercial_license"
	AccountHolderDocumentDocumentTypeDriversLicense    AccountHolderDocumentDocumentType = "drivers_license"
	AccountHolderDocumentDocumentTypePassport          AccountHolderDocumentDocumentType = "passport"
	AccountHolderDocumentDocumentTypePassportCard      AccountHolderDocumentDocumentType = "passport_card"
	AccountHolderDocumentDocumentTypeVisa              AccountHolderDocumentDocumentType = "visa"
)

type AccountHolderDocumentRequiredDocumentUpload added in v0.5.0 

type AccountHolderDocumentRequiredDocumentUpload struct {
	// Type of image to upload.
	ImageType AccountHolderDocumentRequiredDocumentUploadsImageType `json:"image_type"`
	// Status of document image upload.
	Status        AccountHolderDocumentRequiredDocumentUploadsStatus         `json:"status"`
	StatusReasons []AccountHolderDocumentRequiredDocumentUploadsStatusReason `json:"status_reasons"`
	// URL to upload document image to.
	//
	// Note that the upload URLs expire after 7 days. If an upload URL expires, you can
	// refresh the URLs by retrieving the document upload from
	// `GET /account_holders/{account_holder_token}/documents`.
	UploadURL string                                          `json:"upload_url"`
	JSON      accountHolderDocumentRequiredDocumentUploadJSON `json:"-"`
}

Represents a single image of the document to upload.

func (*AccountHolderDocumentRequiredDocumentUpload) UnmarshalJSON added in v0.5.0 

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

type AccountHolderDocumentRequiredDocumentUploadsImageType 

type AccountHolderDocumentRequiredDocumentUploadsImageType string

Type of image to upload. 

const (
	AccountHolderDocumentRequiredDocumentUploadsImageTypeBack  AccountHolderDocumentRequiredDocumentUploadsImageType = "back"
	AccountHolderDocumentRequiredDocumentUploadsImageTypeFront AccountHolderDocumentRequiredDocumentUploadsImageType = "front"
)

type AccountHolderDocumentRequiredDocumentUploadsStatus 

type AccountHolderDocumentRequiredDocumentUploadsStatus string

Status of document image upload. 

const (
	AccountHolderDocumentRequiredDocumentUploadsStatusCompleted AccountHolderDocumentRequiredDocumentUploadsStatus = "COMPLETED"
	AccountHolderDocumentRequiredDocumentUploadsStatusFailed    AccountHolderDocumentRequiredDocumentUploadsStatus = "FAILED"
	AccountHolderDocumentRequiredDocumentUploadsStatusPending   AccountHolderDocumentRequiredDocumentUploadsStatus = "PENDING"
	AccountHolderDocumentRequiredDocumentUploadsStatusUploaded  AccountHolderDocumentRequiredDocumentUploadsStatus = "UPLOADED"
)

type AccountHolderDocumentRequiredDocumentUploadsStatusReason added in v0.5.0 

type AccountHolderDocumentRequiredDocumentUploadsStatusReason string

Reasons for document image upload status. 

const (
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonBackImageBlurry  AccountHolderDocumentRequiredDocumentUploadsStatusReason = "BACK_IMAGE_BLURRY"
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonFileSizeTooLarge AccountHolderDocumentRequiredDocumentUploadsStatusReason = "FILE_SIZE_TOO_LARGE"
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonFrontImageBlurry AccountHolderDocumentRequiredDocumentUploadsStatusReason = "FRONT_IMAGE_BLURRY"
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonFrontImageGlare  AccountHolderDocumentRequiredDocumentUploadsStatusReason = "FRONT_IMAGE_GLARE"
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonInvalidFileType  AccountHolderDocumentRequiredDocumentUploadsStatusReason = "INVALID_FILE_TYPE"
	AccountHolderDocumentRequiredDocumentUploadsStatusReasonUnknownError     AccountHolderDocumentRequiredDocumentUploadsStatusReason = "UNKNOWN_ERROR"
)

type AccountHolderExemptionType added in v0.8.0 

type AccountHolderExemptionType string

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

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

type AccountHolderIndividual added in v0.8.0 

type AccountHolderIndividual struct {
	// Individual's current address
	Address shared.Address `json:"address"`
	// Individual's date of birth, as an RFC 3339 date.
	Dob string `json:"dob"`
	// Individual's email address.
	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        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 []AccountHolderDocument                `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 {
	// 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"`
	// The number of account_holders to limit the response to.
	Limit param.Field[int64] `query:"limit"`
	// 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 interface {
	ImplementsAccountHolderNewParams()
}

This interface is a union satisfied by one of the following: AccountHolderNewParamsKYB, AccountHolderNewParamsKYC, AccountHolderNewParamsKYCExempt.

type AccountHolderNewParamsKYB added in v0.3.1 

type AccountHolderNewParamsKYB struct {
	// List of all entities with >25% ownership in the company. If no entity or
	// individual owns >25% of the company, and the largest shareholder is an entity,
	// please identify them in this field. See
	// [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
	// (Section I) for more background. If no business owner is an entity, pass in an
	// empty list. However, either this parameter or `beneficial_owner_individuals`
	// must be populated. on entities that should be included.
	BeneficialOwnerEntities param.Field[[]AccountHolderNewParamsKYBBeneficialOwnerEntity] `json:"beneficial_owner_entities,required"`
	// List of all individuals with >25% ownership in the company. If no entity or
	// individual owns >25% of the company, and the largest shareholder is an
	// individual, please identify them in this field. See
	// [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
	// (Section I) for more background on individuals that should be included. If no
	// individual is an entity, pass in an empty list. However, either this parameter
	// or `beneficial_owner_entities` must be populated.
	BeneficialOwnerIndividuals param.Field[[]AccountHolderNewParamsKYBBeneficialOwnerIndividual] `json:"beneficial_owner_individuals,required"`
	// Information for business for which the account is being opened and KYB is being
	// run.
	BusinessEntity param.Field[AccountHolderNewParamsKYBBusinessEntity] `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[AccountHolderNewParamsKYBControlPerson] `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[AccountHolderNewParamsKYBWorkflow] `json:"workflow,required"`
	// A user provided id that can be used to link an account holder with an external
	// system
	ExternalID param.Field[string] `json:"external_id"`
	// An RFC 3339 timestamp indicating when precomputed KYC was completed on the
	// business with a pass result.
	//
	// This field is required only if workflow type is `KYB_BYO`.
	KYBPassedTimestamp param.Field[string] `json:"kyb_passed_timestamp"`
	// Company website URL.
	WebsiteURL param.Field[string] `json:"website_url"`
}

func (AccountHolderNewParamsKYB) ImplementsAccountHolderNewParams added in v0.3.1 

func (AccountHolderNewParamsKYB) ImplementsAccountHolderNewParams()

func (AccountHolderNewParamsKYB) MarshalJSON added in v0.3.1 

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

type AccountHolderNewParamsKYBBeneficialOwnerEntity added in v0.5.0 

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

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

type AccountHolderNewParamsKYBBeneficialOwnerIndividual added in v0.5.0 

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

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

type AccountHolderNewParamsKYBBusinessEntity added in v0.3.1 

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

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

type AccountHolderNewParamsKYBControlPerson added in v0.3.1 

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

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

type AccountHolderNewParamsKYBWorkflow added in v0.3.1 

type AccountHolderNewParamsKYBWorkflow string

Specifies the type of KYB workflow to run. 

const (
	AccountHolderNewParamsKYBWorkflowKYBBasic AccountHolderNewParamsKYBWorkflow = "KYB_BASIC"
	AccountHolderNewParamsKYBWorkflowKYBByo   AccountHolderNewParamsKYBWorkflow = "KYB_BYO"
)

type AccountHolderNewParamsKYC added in v0.3.1 

type AccountHolderNewParamsKYC struct {
	// Information on individual for whom the account is being opened and KYC is being
	// run.
	Individual param.Field[AccountHolderNewParamsKYCIndividual] `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[AccountHolderNewParamsKYCWorkflow] `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 (AccountHolderNewParamsKYC) ImplementsAccountHolderNewParams added in v0.3.1 

func (AccountHolderNewParamsKYC) ImplementsAccountHolderNewParams()

func (AccountHolderNewParamsKYC) MarshalJSON added in v0.3.1 

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

type AccountHolderNewParamsKYCExempt added in v0.3.1 

type AccountHolderNewParamsKYCExempt struct {
	// 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[AccountHolderNewParamsKYCExemptKYCExemptionType] `json:"kyc_exemption_type,required"`
	// The KYC Exempt user's last name
	LastName param.Field[string] `json:"last_name,required"`
	// The KYC Exempt user's phone number
	PhoneNumber param.Field[string] `json:"phone_number,required"`
	// Specifies the workflow type. This must be 'KYC_EXEMPT'
	Workflow param.Field[AccountHolderNewParamsKYCExemptWorkflow] `json:"workflow,required"`
	// KYC Exempt user'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"`
	// 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 (AccountHolderNewParamsKYCExempt) ImplementsAccountHolderNewParams added in v0.3.1 

func (AccountHolderNewParamsKYCExempt) ImplementsAccountHolderNewParams()

func (AccountHolderNewParamsKYCExempt) MarshalJSON added in v0.3.1 

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

type AccountHolderNewParamsKYCExemptKYCExemptionType added in v0.3.1 

type AccountHolderNewParamsKYCExemptKYCExemptionType string

Specifies the type of KYC Exempt user 

const (
	AccountHolderNewParamsKYCExemptKYCExemptionTypeAuthorizedUser  AccountHolderNewParamsKYCExemptKYCExemptionType = "AUTHORIZED_USER"
	AccountHolderNewParamsKYCExemptKYCExemptionTypePrepaidCardUser AccountHolderNewParamsKYCExemptKYCExemptionType = "PREPAID_CARD_USER"
)

type AccountHolderNewParamsKYCExemptWorkflow added in v0.3.1 

type AccountHolderNewParamsKYCExemptWorkflow string

Specifies the workflow type. This must be 'KYC_EXEMPT' 

const (
	AccountHolderNewParamsKYCExemptWorkflowKYCExempt AccountHolderNewParamsKYCExemptWorkflow = "KYC_EXEMPT"
)

type AccountHolderNewParamsKYCIndividual added in v0.3.1 

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

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

type AccountHolderNewParamsKYCWorkflow added in v0.3.1 

type AccountHolderNewParamsKYCWorkflow string

Specifies the type of KYC workflow to run. 

const (
	AccountHolderNewParamsKYCWorkflowKYCAdvanced AccountHolderNewParamsKYCWorkflow = "KYC_ADVANCED"
	AccountHolderNewParamsKYCWorkflowKYCBasic    AccountHolderNewParamsKYCWorkflow = "KYC_BASIC"
	AccountHolderNewParamsKYCWorkflowKYCByo      AccountHolderNewParamsKYCWorkflow = "KYC_BYO"
)

type AccountHolderNewResponse added in v0.20.0 

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

func (*AccountHolderNewResponse) UnmarshalJSON added in v0.20.0 

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

type AccountHolderNewResponseStatus added in v0.20.0 

type AccountHolderNewResponseStatus string

KYC and KYB evaluation states. Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED` workflow. 

const (
	AccountHolderNewResponseStatusAccepted        AccountHolderNewResponseStatus = "ACCEPTED"
	AccountHolderNewResponseStatusPendingDocument AccountHolderNewResponseStatus = "PENDING_DOCUMENT"
	AccountHolderNewResponseStatusPendingResubmit AccountHolderNewResponseStatus = "PENDING_RESUBMIT"
	AccountHolderNewResponseStatusRejected        AccountHolderNewResponseStatus = "REJECTED"
)

type AccountHolderNewResponseStatusReason added in v0.20.0 

type AccountHolderNewResponseStatusReason string
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"
)

type AccountHolderResubmitParams 

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

func (AccountHolderResubmitParams) MarshalJSON 

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

type AccountHolderResubmitParamsIndividual 

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

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

func (AccountHolderResubmitParamsIndividual) MarshalJSON added in v0.3.1 

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

type AccountHolderResubmitParamsWorkflow 

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

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 *AccountHolderDocument, 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 *shared.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) *shared.SinglePageAutoPager[AccountHolder]

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

func (*AccountHolderService) ListDocuments 

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

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

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

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

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

func (*AccountHolderService) New 

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

Run an individual or business's information through the Customer Identification Program (CIP) and return an `account_token` if the status is accepted or pending (i.e., further action required). All calls to this endpoint will return an immediate response - though 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) Resubmit 

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

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

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

func (*AccountHolderService) Update 

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

Update the information associated with a particular account holder.

func (*AccountHolderService) UploadDocument 

func (r *AccountHolderService) UploadDocument(ctx context.Context, accountHolderToken string, body AccountHolderUploadDocumentParams, opts ...option.RequestOption) (res *AccountHolderDocument, 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 AccountHolderStatus 

type AccountHolderStatus string

<Deprecated. Use verification_application.status instead> KYC and KYB evaluation states. Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED` workflow. 

const (
	AccountHolderStatusAccepted        AccountHolderStatus = "ACCEPTED"
	AccountHolderStatusPendingDocument AccountHolderStatus = "PENDING_DOCUMENT"
	AccountHolderStatusPendingResubmit AccountHolderStatus = "PENDING_RESUBMIT"
	AccountHolderStatusRejected        AccountHolderStatus = "REJECTED"
)

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"
)

type AccountHolderUpdateParams 

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

func (AccountHolderUpdateParams) MarshalJSON 

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

type AccountHolderUpdateResponse 

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

func (*AccountHolderUpdateResponse) UnmarshalJSON 

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

type AccountHolderUploadDocumentParams 

type AccountHolderUploadDocumentParams struct {
	// Type of the document to upload.
	DocumentType param.Field[AccountHolderUploadDocumentParamsDocumentType] `json:"document_type,required"`
}

func (AccountHolderUploadDocumentParams) MarshalJSON 

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

type AccountHolderUploadDocumentParamsDocumentType 

type AccountHolderUploadDocumentParamsDocumentType string

Type of the document to upload. 

const (
	AccountHolderUploadDocumentParamsDocumentTypeCommercialLicense AccountHolderUploadDocumentParamsDocumentType = "commercial_license"
	AccountHolderUploadDocumentParamsDocumentTypeDriversLicense    AccountHolderUploadDocumentParamsDocumentType = "drivers_license"
	AccountHolderUploadDocumentParamsDocumentTypePassport          AccountHolderUploadDocumentParamsDocumentType = "passport"
	AccountHolderUploadDocumentParamsDocumentTypePassportCard      AccountHolderUploadDocumentParamsDocumentType = "passport_card"
	AccountHolderUploadDocumentParamsDocumentTypeVisa              AccountHolderUploadDocumentParamsDocumentType = "visa"
)

type AccountHolderUserType added in v0.8.0 

type AccountHolderUserType string

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

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

type AccountHolderVerificationApplication added in v0.8.0 

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

Information about the most recent identity verification attempt

func (*AccountHolderVerificationApplication) UnmarshalJSON added in v0.8.0 

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

type AccountHolderVerificationApplicationStatus added in v0.8.0 

type AccountHolderVerificationApplicationStatus string

KYC and KYB evaluation states. Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED` workflow. 

const (
	AccountHolderVerificationApplicationStatusAccepted        AccountHolderVerificationApplicationStatus = "ACCEPTED"
	AccountHolderVerificationApplicationStatusPendingDocument AccountHolderVerificationApplicationStatus = "PENDING_DOCUMENT"
	AccountHolderVerificationApplicationStatusPendingResubmit AccountHolderVerificationApplicationStatus = "PENDING_RESUBMIT"
	AccountHolderVerificationApplicationStatusRejected        AccountHolderVerificationApplicationStatus = "REJECTED"
)

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"
)

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
	CreditConfigurations *AccountCreditConfigurationService
}

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 *shared.CursorPage[Account], err error)

List account configurations.

func (*AccountService) ListAutoPaging 

func (r *AccountService) ListAutoPaging(ctx context.Context, query AccountListParams, opts ...option.RequestOption) *shared.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 spend limits and verification address. 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"`
	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 relative to the daily limit configured on the Account.
	Daily int64 `json:"daily"`
	// The available spend limit relative to the lifetime limit configured on the
	// Account.
	Lifetime int64 `json:"lifetime"`
	// The available spend limit 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 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`.
const (
	AccountStateActive AccountState = "ACTIVE"
	AccountStatePaused AccountState = "PAUSED"
)

type AccountUpdateParams 

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

type AccountUpdateParamsVerificationAddress 

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

Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules.

func (AccountUpdateParamsVerificationAddress) MarshalJSON added in v0.3.1 

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

type AccountVerificationAddress 

type AccountVerificationAddress struct {
	// Valid deliverable address (no PO boxes).
	Address1 string `json:"address1,required"`
	// City name.
	City string `json:"city,required"`
	// Country name. Only USA is currently supported.
	Country string `json:"country,required"`
	// Valid postal code. Only USA 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     accountVerificationAddressJSON `json:"-"`
}

func (*AccountVerificationAddress) UnmarshalJSON 

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

type Address added in v0.8.0 

type Address = shared.Address

This is an alias to an internal type.

type AddressParam 

type AddressParam = shared.AddressParam

This is an alias to an internal type.

type AggregateBalance 

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

Aggregate Balance across all end-user accounts

func (*AggregateBalance) UnmarshalJSON 

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

type AggregateBalanceFinancialAccountType 

type AggregateBalanceFinancialAccountType string

Type of financial account 

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

type AggregateBalanceListParams 

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

func (AggregateBalanceListParams) URLQuery 

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

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

type AggregateBalanceListParamsFinancialAccountType 

type AggregateBalanceListParamsFinancialAccountType string

Get the aggregate balance for a given Financial Account type. 

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

type AggregateBalanceService 

type AggregateBalanceService struct {
	Options []option.RequestOption
}

AggregateBalanceService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAggregateBalanceService method instead.

func NewAggregateBalanceService 

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

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

func (*AggregateBalanceService) List 

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

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

func (*AggregateBalanceService) ListAutoPaging 

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

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

type AuthRule 

type AuthRule struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Indicates whether the Auth Rule is ACTIVE or INACTIVE
	State AuthRuleState `json:"state,required"`
	// Array of account_token(s) identifying the accounts that the Auth Rule applies
	// to. Note that only this field or `card_tokens` can be provided for a given Auth
	// Rule.
	AccountTokens []string `json:"account_tokens"`
	// Countries in which the Auth Rule permits transactions. Note that Lithic
	// maintains a list of countries in which all transactions are blocked; "allowing"
	// those countries in an Auth Rule does not override the Lithic-wide restrictions.
	AllowedCountries []string `json:"allowed_countries"`
	// Merchant category codes for which the Auth Rule permits transactions.
	AllowedMcc []string `json:"allowed_mcc"`
	// Countries in which the Auth Rule automatically declines transactions.
	BlockedCountries []string `json:"blocked_countries"`
	// Merchant category codes for which the Auth Rule automatically declines
	// transactions.
	BlockedMcc []string `json:"blocked_mcc"`
	// Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
	// that only this field or `account_tokens` can be provided for a given Auth Rule.
	CardTokens []string `json:"card_tokens"`
	// Boolean indicating whether the Auth Rule is applied at the program level.
	ProgramLevel bool         `json:"program_level"`
	JSON         authRuleJSON `json:"-"`
}

func (*AuthRule) UnmarshalJSON 

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

type AuthRuleApplyParams 

type AuthRuleApplyParams struct {
	// Array of account_token(s) identifying the accounts that the Auth Rule applies
	// to. Note that only this field or `card_tokens` can be provided for a given Auth
	// Rule.
	AccountTokens param.Field[[]string] `json:"account_tokens"`
	// Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
	// that only this field or `account_tokens` can be provided for a given Auth Rule.
	CardTokens param.Field[[]string] `json:"card_tokens"`
	// Boolean indicating whether the Auth Rule is applied at the program level.
	ProgramLevel param.Field[bool] `json:"program_level"`
}

func (AuthRuleApplyParams) MarshalJSON 

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

type AuthRuleGetResponse added in v0.5.0 

type AuthRuleGetResponse struct {
	Data []AuthRule              `json:"data"`
	JSON authRuleGetResponseJSON `json:"-"`
}

func (*AuthRuleGetResponse) UnmarshalJSON added in v0.5.0 

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

type AuthRuleListParams 

type AuthRuleListParams 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 (AuthRuleListParams) URLQuery 

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

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

type AuthRuleNewParams 

type AuthRuleNewParams struct {
	// Array of account_token(s) identifying the accounts that the Auth Rule applies
	// to. Note that only this field or `card_tokens` can be provided for a given Auth
	// Rule.
	AccountTokens param.Field[[]string] `json:"account_tokens"`
	// Countries in which the Auth Rule permits transactions. Note that Lithic
	// maintains a list of countries in which all transactions are blocked; "allowing"
	// those countries in an Auth Rule does not override the Lithic-wide restrictions.
	AllowedCountries param.Field[[]string] `json:"allowed_countries"`
	// Merchant category codes for which the Auth Rule permits transactions.
	AllowedMcc param.Field[[]string] `json:"allowed_mcc"`
	// Countries in which the Auth Rule automatically declines transactions.
	BlockedCountries param.Field[[]string] `json:"blocked_countries"`
	// Merchant category codes for which the Auth Rule automatically declines
	// transactions.
	BlockedMcc param.Field[[]string] `json:"blocked_mcc"`
	// Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
	// that only this field or `account_tokens` can be provided for a given Auth Rule.
	CardTokens param.Field[[]string] `json:"card_tokens"`
	// Boolean indicating whether the Auth Rule is applied at the program level.
	ProgramLevel param.Field[bool] `json:"program_level"`
}

func (AuthRuleNewParams) MarshalJSON 

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

type AuthRuleRemoveParams 

type AuthRuleRemoveParams struct {
	// Array of account_token(s) identifying the accounts that the Auth Rule applies
	// to. Note that only this field or `card_tokens` can be provided for a given Auth
	// Rule.
	AccountTokens param.Field[[]string] `json:"account_tokens"`
	// Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
	// that only this field or `account_tokens` can be provided for a given Auth Rule.
	CardTokens param.Field[[]string] `json:"card_tokens"`
	// Boolean indicating whether the Auth Rule is applied at the program level.
	ProgramLevel param.Field[bool] `json:"program_level"`
}

func (AuthRuleRemoveParams) MarshalJSON 

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

type AuthRuleRemoveResponse 

type AuthRuleRemoveResponse struct {
	AccountTokens []string                   `json:"account_tokens"`
	CardTokens    []string                   `json:"card_tokens"`
	ProgramLevel  bool                       `json:"program_level"`
	JSON          authRuleRemoveResponseJSON `json:"-"`
}

func (*AuthRuleRemoveResponse) UnmarshalJSON 

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

type AuthRuleService 

type AuthRuleService struct {
	Options []option.RequestOption
}

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.

func (*AuthRuleService) Apply 

func (r *AuthRuleService) Apply(ctx context.Context, authRuleToken string, body AuthRuleApplyParams, opts ...option.RequestOption) (res *AuthRule, err error)

Applies an existing authorization rule (Auth Rule) to an program, account, or card level.

func (*AuthRuleService) Get 

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

Detail the properties and entities (program, accounts, and cards) associated with an existing authorization rule (Auth Rule).

func (*AuthRuleService) List 

func (r *AuthRuleService) List(ctx context.Context, query AuthRuleListParams, opts ...option.RequestOption) (res *shared.CursorPage[AuthRule], err error)

Return all of the Auth Rules under the program.

func (*AuthRuleService) ListAutoPaging 

func (r *AuthRuleService) ListAutoPaging(ctx context.Context, query AuthRuleListParams, opts ...option.RequestOption) *shared.CursorPageAutoPager[AuthRule]

Return all of the Auth Rules under the program.

func (*AuthRuleService) New 

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

Creates an authorization rule (Auth Rule) and applies it at the program, account, or card level.

func (*AuthRuleService) Remove 

func (r *AuthRuleService) Remove(ctx context.Context, body AuthRuleRemoveParams, opts ...option.RequestOption) (res *AuthRuleRemoveResponse, err error)

Remove an existing authorization rule (Auth Rule) from an program, account, or card-level.

func (*AuthRuleService) Update 

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

Update the properties associated with an existing authorization rule (Auth Rule).

type AuthRuleState 

type AuthRuleState string

Indicates whether the Auth Rule is ACTIVE or INACTIVE 

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

type AuthRuleUpdateParams 

type AuthRuleUpdateParams struct {
	// Array of country codes for which the Auth Rule will permit transactions. Note
	// that only this field or `blocked_countries` can be used for a given Auth Rule.
	AllowedCountries param.Field[[]string] `json:"allowed_countries"`
	// Array of merchant category codes for which the Auth Rule will permit
	// transactions. Note that only this field or `blocked_mcc` can be used for a given
	// Auth Rule.
	AllowedMcc param.Field[[]string] `json:"allowed_mcc"`
	// Array of country codes for which the Auth Rule will automatically decline
	// transactions. Note that only this field or `allowed_countries` can be used for a
	// given Auth Rule.
	BlockedCountries param.Field[[]string] `json:"blocked_countries"`
	// Array of merchant category codes for which the Auth Rule will automatically
	// decline transactions. Note that only this field or `allowed_mcc` can be used for
	// a given Auth Rule.
	BlockedMcc param.Field[[]string] `json:"blocked_mcc"`
}

func (AuthRuleUpdateParams) MarshalJSON 

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

type AuthStreamEnrollmentService 

type AuthStreamEnrollmentService struct {
	Options []option.RequestOption
}

AuthStreamEnrollmentService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAuthStreamEnrollmentService method instead.

func NewAuthStreamEnrollmentService 

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

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

func (*AuthStreamEnrollmentService) GetSecret 

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

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

func (*AuthStreamEnrollmentService) RotateSecret 

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

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

type AuthStreamSecret 

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

func (*AuthStreamSecret) UnmarshalJSON 

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

type Balance 

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

Balance of a Financial Account

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"
	BalanceFinancialAccountTypeReserve BalanceFinancialAccountType = "RESERVE"
)

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 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"
	BalanceListParamsFinancialAccountTypeReserve BalanceListParamsFinancialAccountType = "RESERVE"
)

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 *shared.SinglePage[Balance], err error)

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

func (*BalanceService) ListAutoPaging 

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

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

type BusinessAccount added in v0.9.0 

type BusinessAccount struct {
	// Account token
	Token                    string                                  `json:"token,required" format:"uuid"`
	CollectionsConfiguration BusinessAccountCollectionsConfiguration `json:"collections_configuration"`
	// Credit limit extended to the Account
	CreditLimit int64               `json:"credit_limit"`
	JSON        businessAccountJSON `json:"-"`
}

func (*BusinessAccount) UnmarshalJSON added in v0.9.0 

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

type BusinessAccountCollectionsConfiguration added in v0.9.0 

type BusinessAccountCollectionsConfiguration struct {
	// Number of days within the billing period
	BillingPeriod int64 `json:"billing_period,required"`
	// Number of days after the billing period ends that a payment is required
	PaymentPeriod int64 `json:"payment_period,required"`
	// The external bank account token to use for auto-collections
	ExternalBankAccountToken string                                      `json:"external_bank_account_token" format:"uuid"`
	JSON                     businessAccountCollectionsConfigurationJSON `json:"-"`
}

func (*BusinessAccountCollectionsConfiguration) UnmarshalJSON added in v0.9.0 

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

type Card 

type Card struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// An RFC 3339 timestamp for when the card was created. UTC time zone.
	Created time.Time   `json:"created,required" format:"date-time"`
	Funding CardFunding `json:"funding,required"`
	// Last four digits of the card number.
	LastFour string `json:"last_four,required"`
	// Amount (in cents) to limit approved authorizations. Transaction requests above
	// the spend limit will be declined.
	SpendLimit int64 `json:"spend_limit,required"`
	// Spend limit duration values:
	//
	//   - `ANNUALLY` - Card will authorize transactions up to spend limit in a calendar
	//     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. Month is calculated as this 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` - Each business day at 2pm Eastern Time Zone (ET), cards
	//     of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card
	//     production warehouse and updated to state `PENDING_ACTIVATION` . Similar to
	//     `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
	//     transactions. API clients should update the card's state to `OPEN` only after
	//     the cardholder confirms receipt of the card.
	//
	// In sandbox, the same daily batch fulfillment occurs, but no cards are actually
	// manufactured.
	State CardState `json:"state,required"`
	// Card types:
	//
	//   - `VIRTUAL` - Card will authorize at any merchant and can be added to a digital
	//     wallet like Apple Pay or Google Pay (if the card program is digital
	//     wallet-enabled).
	//   - `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label
	//     branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality.
	//     Reach out at [lithic.com/contact](https://lithic.com/contact) for more
	//     information.
	//   - `SINGLE_USE` - Card is closed upon first successful authorization.
	//   - `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that
	//     successfully authorizes the card.
	Type CardType `json:"type,required"`
	// List of identifiers for the Auth Rule(s) that are applied on the card.
	AuthRuleTokens []string `json:"auth_rule_tokens"`
	// Three digit cvv printed on the back of the card.
	Cvv string `json:"cvv"`
	// Specifies the digital card art to be displayed in the user’s digital wallet
	// after tokenization. This artwork must be approved by Mastercard and configured
	// by Lithic to use. See
	// [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
	DigitalCardArtToken string `json:"digital_card_art_token" format:"uuid"`
	// Two digit (MM) expiry month.
	ExpMonth string `json:"exp_month"`
	// Four digit (yyyy) expiry year.
	ExpYear string `json:"exp_year"`
	// Hostname of card’s locked merchant (will be empty if not applicable).
	Hostname string `json:"hostname"`
	// Friendly name to identify the card. We recommend against using this field to
	// store JSON data as it can cause unexpected behavior.
	Memo string `json:"memo"`
	// Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
	// compliant to have PAN returned as a field in production. Please contact
	// [support@lithic.com](mailto:support@lithic.com) for questions.
	Pan  string   `json:"pan"`
	JSON cardJSON `json:"-"`
}

func (*Card) UnmarshalJSON 

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

type CardAggregateBalanceListParams added in v0.9.0 

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

func (CardAggregateBalanceListParams) URLQuery added in v0.9.0 

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

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

type CardAggregateBalanceListResponse added in v0.9.0 

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

Card Aggregate Balance across all end-user accounts

func (*CardAggregateBalanceListResponse) UnmarshalJSON added in v0.9.0 

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

type CardAggregateBalanceService added in v0.9.0 

type CardAggregateBalanceService struct {
	Options []option.RequestOption
}

CardAggregateBalanceService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardAggregateBalanceService method instead.

func NewCardAggregateBalanceService added in v0.9.0 

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

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

func (*CardAggregateBalanceService) List added in v0.9.0 

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

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

func (*CardAggregateBalanceService) ListAutoPaging added in v0.9.0 

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

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

type CardBalanceListParams added in v0.9.0 

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

func (CardBalanceListParams) URLQuery added in v0.9.0 

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

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

type 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 *shared.SinglePage[Balance], 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) *shared.SinglePageAutoPager[Balance]

Get the balances for a given card.

type CardEmbedParams 

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

func (CardEmbedParams) URLQuery 

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

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

type CardFinancialTransactionListParams added in v0.9.0 

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

func (CardFinancialTransactionListParams) URLQuery added in v0.9.0 

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

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

type CardFinancialTransactionListParamsCategory added in v0.9.0 

type CardFinancialTransactionListParamsCategory string

Financial Transaction category to be returned. 

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

type CardFinancialTransactionListParamsResult added in v0.9.0 

type CardFinancialTransactionListParamsResult string

Financial Transaction result to be returned. 

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

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"
)

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 *shared.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) *shared.SinglePageAutoPager[FinancialTransaction]

List the financial transactions for a given card.

type CardFunding 

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

func (*CardFunding) UnmarshalJSON 

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

type CardFundingState 

type CardFundingState string

State of funding source.

Funding source states:

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

type CardFundingType 

type CardFundingType string

Types of funding source:

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

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

type CardGetEmbedHTMLParams added in v0.3.1 

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

func (CardGetEmbedHTMLParams) MarshalJSON added in v0.3.1 

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

type CardGetEmbedURLParams added in v0.3.1 

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

func (CardGetEmbedURLParams) MarshalJSON added in v0.3.1 

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

type CardListParams 

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

func (CardListParams) URLQuery 

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

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

type CardListParamsState added in v0.6.0 

type CardListParamsState string

Returns cards with the specified state. 

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

type CardNewParams 

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

func (CardNewParams) MarshalJSON 

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

type CardNewParamsShippingMethod 

type CardNewParamsShippingMethod string

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

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

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"
)

type CardNewParamsType 

type CardNewParamsType string

Card types:

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

type CardProductCreditDetailResponse added in v0.9.0 

type CardProductCreditDetailResponse struct {
	// The amount of credit extended within the program
	CreditExtended int64 `json:"credit_extended,required"`
	// The total credit limit of the program
	CreditLimit int64                               `json:"credit_limit,required"`
	JSON        cardProductCreditDetailResponseJSON `json:"-"`
}

func (*CardProductCreditDetailResponse) UnmarshalJSON added in v0.9.0 

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

type CardProductService added in v0.9.0 

type CardProductService struct {
	Options []option.RequestOption
}

CardProductService 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 NewCardProductService method instead.

func NewCardProductService added in v0.9.0 

func NewCardProductService(opts ...option.RequestOption) (r *CardProductService)

NewCardProductService 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 (*CardProductService) CreditDetail added in v0.9.0 

func (r *CardProductService) CreditDetail(ctx context.Context, opts ...option.RequestOption) (res *CardProductCreditDetailResponse, err error)

Get the Credit Detail for the card product

type CardProgram added in v0.10.0 

type CardProgram struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when the card program was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// The name of the card program.
	Name string `json:"name,required"`
	// The first digits of the card number that this card program ends with.
	PanRangeEnd string `json:"pan_range_end,required"`
	// The first digits of the card number that this card program starts with.
	PanRangeStart string          `json:"pan_range_start,required"`
	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 *shared.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) *shared.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"`
	// 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"
)

type CardProvisionResponse 

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

func (*CardProvisionResponse) UnmarshalJSON 

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

type CardReissueParams 

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

func (CardReissueParams) MarshalJSON 

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

type CardReissueParamsShippingMethod 

type CardReissueParamsShippingMethod string

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

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

type CardRenewParams added in v0.19.0 

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

func (CardRenewParams) MarshalJSON added in v0.19.0 

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

type CardRenewParamsShippingMethod added in v0.19.0 

type CardRenewParamsShippingMethod string

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

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

type CardSearchByPanParams added in v0.21.0 

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

func (CardSearchByPanParams) MarshalJSON added in v0.21.0 

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

type CardService 

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

CardService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardService method instead.

func NewCardService 

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

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

func (*CardService) Embed 

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

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

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

```html <iframe 

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

></iframe> ```

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

func (*CardService) Get 

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

Get card configuration such as spend limit and state.

func (*CardService) GetEmbedHTML 

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

func (*CardService) GetEmbedURL 

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

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

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

```html <iframe 

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

></iframe> ```

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

func (*CardService) GetSpendLimits added in v0.15.0 

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

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

func (*CardService) List 

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

List cards.

func (*CardService) ListAutoPaging 

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

List cards.

func (*CardService) New 

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

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

func (*CardService) Provision 

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

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

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

func (*CardService) Reissue 

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

Initiate print and shipment of a duplicate physical card.

Only applies to cards of type `PHYSICAL`.

func (*CardService) Renew added in v0.19.0 

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

Initiate print and shipment of a renewed physical card.

Only applies to cards of type `PHYSICAL`.

func (*CardService) SearchByPan added in v0.21.0 

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

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

func (*CardService) Update 

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

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

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

type CardSpendLimits added in v0.15.0 

type CardSpendLimits struct {
	AvailableSpendLimit CardSpendLimitsAvailableSpendLimit `json:"available_spend_limit,required"`
	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 relative to the annual limit configured on the Card.
	Annually int64 `json:"annually"`
	// The available spend limit relative to the forever limit configured on the Card.
	Forever int64 `json:"forever"`
	// The available spend limit 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 CardState 

type CardState string

Card state values:

  • `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.
  • `OPEN` - Card will approve authorizations (if they match card and account parameters).
  • `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
  • `PENDING_FULFILLMENT` - The initial state for cards of type `PHYSICAL`. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for "Card Present" purchases where the physical card itself is present.
  • `PENDING_ACTIVATION` - Each business day at 2pm Eastern Time Zone (ET), cards of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to state `PENDING_ACTIVATION` . Similar to `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce transactions. API clients should update the card's state to `OPEN` only after the cardholder confirms receipt of the card.

In sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured. 

const (
	CardStateClosed             CardState = "CLOSED"
	CardStateOpen               CardState = "OPEN"
	CardStatePaused             CardState = "PAUSED"
	CardStatePendingActivation  CardState = "PENDING_ACTIVATION"
	CardStatePendingFulfillment CardState = "PENDING_FULFILLMENT"
)

type CardType 

type CardType string

Card types:

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

type CardUpdateParams 

type CardUpdateParams struct {
	// Identifier for any Auth Rules that will be applied to transactions taking place
	// with the card.
	AuthRuleToken param.Field[string] `json:"auth_rule_token"`
	// 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. We recommend against using this field to
	// store JSON data as it can cause unexpected behavior.
	Memo param.Field[string] `json:"memo"`
	// Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
	// `VIRTUAL`. See
	// [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block-enterprise).
	Pin param.Field[string] `json:"pin"`
	// Amount (in cents) to limit approved authorizations. Transaction requests above
	// the spend limit will be declined. Note that a spend limit of 0 is effectively no
	// limit, and should only be used to reset or remove a prior limit. Only a limit of
	// 1 or above will result in declined transactions due to checks against the card
	// limit.
	SpendLimit param.Field[int64] `json:"spend_limit"`
	// Spend limit duration values:
	//
	//   - `ANNUALLY` - Card will authorize transactions up to spend limit in a calendar
	//     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. Month is calculated as this calendar date one month prior.
	//   - `TRANSACTION` - Card will authorize multiple transactions if each individual
	//     transaction is under the spend limit.
	SpendLimitDuration param.Field[SpendLimitDuration] `json:"spend_limit_duration"`
	// Card state values:
	//
	//   - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
	//     be undone.
	//   - `OPEN` - Card will approve authorizations (if they match card and account
	//     parameters).
	//   - `PAUSED` - Card will decline authorizations, but can be resumed at a later
	//     time.
	State param.Field[CardUpdateParamsState] `json:"state"`
}

func (CardUpdateParams) MarshalJSON 

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

type 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"
)

type CarrierParam added in v0.6.7 

type CarrierParam = shared.CarrierParam

This is an alias to an internal type.

type Client 

type Client struct {
	Options                 []option.RequestOption
	Accounts                *AccountService
	AccountHolders          *AccountHolderService
	AuthRules               *AuthRuleService
	AuthStreamEnrollment    *AuthStreamEnrollmentService
	TokenizationDecisioning *TokenizationDecisioningService
	Tokenizations           *TokenizationService
	Cards                   *CardService
	Balances                *BalanceService
	AggregateBalances       *AggregateBalanceService
	Disputes                *DisputeService
	Events                  *EventService
	Transfers               *TransferService
	FinancialAccounts       *FinancialAccountService
	Transactions            *TransactionService
	ResponderEndpoints      *ResponderEndpointService
	Webhooks                *WebhookService
	ExternalBankAccounts    *ExternalBankAccountService
	Payments                *PaymentService
	ThreeDS                 *ThreeDSService
	Reports                 *ReportService
	CardProduct             *CardProductService
	CardPrograms            *CardProgramService
	DigitalCardArt          *DigitalCardArtService
}

Client creates a struct with services and top level methods that help with interacting with the lithic API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (LITHIC_API_KEY, LITHIC_WEBHOOK_SECRET). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) APIStatus 

func (r *Client) APIStatus(ctx context.Context, opts ...option.RequestOption) (res *APIStatus, err error)

Status of api

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"
)

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 *shared.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) *shared.CursorPageAutoPager[DigitalCardArt]

List digital card art.

type Dispute 

type Dispute struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount under dispute. May be different from the original transaction amount.
	Amount int64 `json:"amount,required"`
	// Date dispute entered arbitration.
	ArbitrationDate time.Time `json:"arbitration_date,required,nullable" format:"date-time"`
	// Timestamp of when first Dispute was reported.
	Created time.Time `json:"created,required" format:"date-time"`
	// Date that the dispute was filed by the customer making the dispute.
	CustomerFiledDate time.Time `json:"customer_filed_date,required,nullable" format:"date-time"`
	// End customer description of the reason for the dispute.
	CustomerNote string `json:"customer_note,required,nullable"`
	// Unique identifiers for the dispute from the network.
	NetworkClaimIDs []string `json:"network_claim_ids,required,nullable"`
	// Date that the dispute was submitted to the network.
	NetworkFiledDate time.Time `json:"network_filed_date,required,nullable" format:"date-time"`
	// Network reason code used to file the dispute.
	NetworkReasonCode string `json:"network_reason_code,required,nullable"`
	// Date dispute entered pre-arbitration.
	PrearbitrationDate time.Time `json:"prearbitration_date,required,nullable" format:"date-time"`
	// Unique identifier for the dispute from the network. If there are multiple, this
	// will be the first claim id set by the network
	PrimaryClaimID string `json:"primary_claim_id,required,nullable"`
	// Dispute reason:
	//
	//   - `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
	//   - `CANCELLED`: Transaction was cancelled by the customer.
	//   - `DUPLICATED`: The transaction was a duplicate.
	//   - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
	//   - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
	//   - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable
	//     merchant activity.
	//   - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as
	//     described.
	//   - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
	//   - `INCORRECT_AMOUNT`: The transaction amount was incorrect.
	//   - `MISSING_AUTH`: The transaction was missing authorization.
	//   - `OTHER`: Other reason.
	//   - `PROCESSING_ERROR`: Processing error.
	//   - `REFUND_NOT_PROCESSED`: The refund was not processed.
	//   - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not
	//     cancelled.
	Reason DisputeReason `json:"reason,required"`
	// Date the representment was received.
	RepresentmentDate time.Time `json:"representment_date,required,nullable" format:"date-time"`
	// Resolution amount net of network fees.
	ResolutionAmount int64 `json:"resolution_amount,required,nullable"`
	// Date that the dispute was resolved.
	ResolutionDate time.Time `json:"resolution_date,required,nullable" format:"date-time"`
	// Note by Dispute team on the case resolution.
	ResolutionNote string `json:"resolution_note,required,nullable"`
	// Reason for the dispute resolution:
	//
	// - `CASE_LOST`: This case was lost at final arbitration.
	// - `NETWORK_REJECTED`: Network rejected.
	// - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS.
	// - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold.
	// - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless.
	// - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid.
	// - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks.
	// - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other.
	// - `PAST_FILING_DATE`: Past filing date.
	// - `PREARBITRATION_REJECTED`: Prearbitration rejected.
	// - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other.
	// - `REFUNDED`: Refunded.
	// - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback.
	// - `WITHDRAWN`: Withdrawn.
	// - `WON_ARBITRATION`: Won arbitration.
	// - `WON_FIRST_CHARGEBACK`: Won first chargeback.
	// - `WON_PREARBITRATION`: Won prearbitration.
	ResolutionReason DisputeResolutionReason `json:"resolution_reason,required,nullable"`
	// Status types:
	//
	//   - `NEW` - New dispute case is opened.
	//   - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more
	//     information.
	//   - `SUBMITTED` - Dispute is submitted to the card network.
	//   - `REPRESENTMENT` - Case has entered second presentment.
	//   - `PREARBITRATION` - Case has entered prearbitration.
	//   - `ARBITRATION` - Case has entered arbitration.
	//   - `CASE_WON` - Case was won and credit will be issued.
	//   - `CASE_CLOSED` - Case was lost or withdrawn.
	Status DisputeStatus `json:"status,required"`
	// The transaction that is being disputed. A transaction can only be disputed once
	// but may have multiple dispute cases.
	TransactionToken string      `json:"transaction_token,required" format:"uuid"`
	JSON             disputeJSON `json:"-"`
}

Dispute.

func (*Dispute) UnmarshalJSON 

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

type DisputeEvidence 

type DisputeEvidence struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Timestamp of when dispute evidence was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Dispute token evidence is attached to.
	DisputeToken string `json:"dispute_token,required" format:"uuid"`
	// Upload status types:
	//
	// - `DELETED` - Evidence was deleted.
	// - `ERROR` - Evidence upload failed.
	// - `PENDING` - Evidence is pending upload.
	// - `REJECTED` - Evidence was rejected.
	// - `UPLOADED` - Evidence was uploaded.
	UploadStatus DisputeEvidenceUploadStatus `json:"upload_status,required"`
	// URL to download evidence. Only shown when `upload_status` is `UPLOADED`.
	DownloadURL string `json:"download_url"`
	// File name of evidence. Recommended to give the dispute evidence a human-readable
	// identifier.
	Filename string `json:"filename"`
	// URL to upload evidence. Only shown when `upload_status` is `PENDING`.
	UploadURL string              `json:"upload_url"`
	JSON      disputeEvidenceJSON `json:"-"`
}

Dispute evidence.

func (*DisputeEvidence) UnmarshalJSON 

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

type DisputeEvidenceUploadStatus 

type DisputeEvidenceUploadStatus string

Upload status types:

- `DELETED` - Evidence was deleted. - `ERROR` - Evidence upload failed. - `PENDING` - Evidence is pending upload. - `REJECTED` - Evidence was rejected. - `UPLOADED` - Evidence was uploaded. 

const (
	DisputeEvidenceUploadStatusDeleted  DisputeEvidenceUploadStatus = "DELETED"
	DisputeEvidenceUploadStatusError    DisputeEvidenceUploadStatus = "ERROR"
	DisputeEvidenceUploadStatusPending  DisputeEvidenceUploadStatus = "PENDING"
	DisputeEvidenceUploadStatusRejected DisputeEvidenceUploadStatus = "REJECTED"
	DisputeEvidenceUploadStatusUploaded DisputeEvidenceUploadStatus = "UPLOADED"
)

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"
)

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"
)

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"
)

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"
)

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 *shared.CursorPage[Dispute], err error)

List disputes.

func (*DisputeService) ListAutoPaging 

func (r *DisputeService) ListAutoPaging(ctx context.Context, query DisputeListParams, opts ...option.RequestOption) *shared.CursorPageAutoPager[Dispute]

List disputes.

func (*DisputeService) ListEvidences 

func (r *DisputeService) ListEvidences(ctx context.Context, disputeToken string, query DisputeListEvidencesParams, opts ...option.RequestOption) (res *shared.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) *shared.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"
)

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"
)

type DisputeUploadEvidenceParams added in v0.3.1 

type DisputeUploadEvidenceParams struct {
}

type Error 

type Error = apierror.Error

type Event 

type Event struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// An RFC 3339 timestamp for when the event was created. UTC time zone.
	//
	// If no timezone is specified, UTC will be used.
	Created time.Time `json:"created,required" format:"date-time"`
	// Event types:
	//
	//   - `account_holder.created` - Notification that a new account holder has been
	//     created and was not rejected.
	//   - `account_holder.updated` - Notification that an account holder was updated.
	//   - `account_holder.verification` - Notification than an account holder's identity
	//     verification is complete.
	//   - `card.created` - Notification that a card has been created.
	//   - `card.renewed` - Notification that a card has been renewed.
	//   - `card.shipped` - Physical card shipment notification. See
	//     https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
	//   - `card_transaction.updated` - Transaction Lifecycle webhook. See
	//     https://docs.lithic.com/docs/transaction-webhooks.
	//   - `dispute.updated` - A dispute has been updated.
	//   - `digital_wallet.tokenization_approval_request` - Card network's request to
	//     Lithic to activate a digital wallet token.
	//   - `digital_wallet.tokenization_result` - Notification of the end result of a
	//     tokenization, whether successful or failed.
	//   - `digital_wallet.tokenization_two_factor_authentication_code` - A code to be
	//     passed to an end user to complete digital wallet authentication. See
	//     https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
	EventType EventEventType         `json:"event_type,required"`
	Payload   map[string]interface{} `json:"payload,required"`
	JSON      eventJSON              `json:"-"`
}

A single event that affects the transaction state and lifecycle.

func (*Event) UnmarshalJSON 

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

type EventEventType 

type EventEventType string

Event types:

  • `account_holder.created` - Notification that a new account holder has been created and was not rejected.
  • `account_holder.updated` - Notification that an account holder was updated.
  • `account_holder.verification` - Notification than an account holder's identity verification is complete.
  • `card.created` - Notification that a card has been created.
  • `card.renewed` - Notification that a card has been renewed.
  • `card.shipped` - Physical card shipment notification. See https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
  • `card_transaction.updated` - Transaction Lifecycle webhook. See https://docs.lithic.com/docs/transaction-webhooks.
  • `dispute.updated` - A dispute has been updated.
  • `digital_wallet.tokenization_approval_request` - Card network's request to Lithic to activate a digital wallet token.
  • `digital_wallet.tokenization_result` - Notification of the end result of a tokenization, whether successful or failed.
  • `digital_wallet.tokenization_two_factor_authentication_code` - A code to be passed to an end user to complete digital wallet authentication. See https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
const (
	EventEventTypeAccountHolderCreated                                 EventEventType = "account_holder.created"
	EventEventTypeAccountHolderUpdated                                 EventEventType = "account_holder.updated"
	EventEventTypeAccountHolderVerification                            EventEventType = "account_holder.verification"
	EventEventTypeBalanceUpdated                                       EventEventType = "balance.updated"
	EventEventTypeCardCreated                                          EventEventType = "card.created"
	EventEventTypeCardRenewed                                          EventEventType = "card.renewed"
	EventEventTypeCardShipped                                          EventEventType = "card.shipped"
	EventEventTypeCardTransactionUpdated                               EventEventType = "card_transaction.updated"
	EventEventTypeDigitalWalletTokenizationApprovalRequest             EventEventType = "digital_wallet.tokenization_approval_request"
	EventEventTypeDigitalWalletTokenizationResult                      EventEventType = "digital_wallet.tokenization_result"
	EventEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventEventTypeDisputeUpdated                                       EventEventType = "dispute.updated"
	EventEventTypeDisputeEvidenceUploadFailed                          EventEventType = "dispute_evidence.upload_failed"
	EventEventTypePaymentTransactionCreated                            EventEventType = "payment_transaction.created"
	EventEventTypePaymentTransactionUpdated                            EventEventType = "payment_transaction.updated"
	EventEventTypeThreeDSAuthenticationCreated                         EventEventType = "three_ds_authentication.created"
	EventEventTypeTransferTransactionCreated                           EventEventType = "transfer_transaction.created"
)

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"
)

type EventListParams 

type EventListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Event types to filter events by.
	EventTypes param.Field[[]EventListParamsEventType] `query:"event_types"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
	// Whether to include the event payload content in the response.
	WithContent param.Field[bool] `query:"with_content"`
}

func (EventListParams) URLQuery 

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

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

type EventListParamsEventType added in v0.5.0 

type EventListParamsEventType string
const (
	EventListParamsEventTypeAccountHolderCreated                                 EventListParamsEventType = "account_holder.created"
	EventListParamsEventTypeAccountHolderUpdated                                 EventListParamsEventType = "account_holder.updated"
	EventListParamsEventTypeAccountHolderVerification                            EventListParamsEventType = "account_holder.verification"
	EventListParamsEventTypeBalanceUpdated                                       EventListParamsEventType = "balance.updated"
	EventListParamsEventTypeCardCreated                                          EventListParamsEventType = "card.created"
	EventListParamsEventTypeCardRenewed                                          EventListParamsEventType = "card.renewed"
	EventListParamsEventTypeCardShipped                                          EventListParamsEventType = "card.shipped"
	EventListParamsEventTypeCardTransactionUpdated                               EventListParamsEventType = "card_transaction.updated"
	EventListParamsEventTypeDigitalWalletTokenizationApprovalRequest             EventListParamsEventType = "digital_wallet.tokenization_approval_request"
	EventListParamsEventTypeDigitalWalletTokenizationResult                      EventListParamsEventType = "digital_wallet.tokenization_result"
	EventListParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventListParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventListParamsEventTypeDisputeUpdated                                       EventListParamsEventType = "dispute.updated"
	EventListParamsEventTypeDisputeEvidenceUploadFailed                          EventListParamsEventType = "dispute_evidence.upload_failed"
	EventListParamsEventTypePaymentTransactionCreated                            EventListParamsEventType = "payment_transaction.created"
	EventListParamsEventTypePaymentTransactionUpdated                            EventListParamsEventType = "payment_transaction.updated"
	EventListParamsEventTypeThreeDSAuthenticationCreated                         EventListParamsEventType = "three_ds_authentication.created"
	EventListParamsEventTypeTransferTransactionCreated                           EventListParamsEventType = "transfer_transaction.created"
)

type EventService 

type EventService struct {
	Options       []option.RequestOption
	Subscriptions *EventSubscriptionService
}

EventService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEventService method instead.

func NewEventService 

func NewEventService(opts ...option.RequestOption) (r *EventService)

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

func (*EventService) Get 

func (r *EventService) Get(ctx context.Context, eventToken string, opts ...option.RequestOption) (res *Event, err error)

Get an event.

func (*EventService) List 

func (r *EventService) List(ctx context.Context, query EventListParams, opts ...option.RequestOption) (res *shared.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 *shared.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) *shared.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) *shared.CursorPageAutoPager[Event]

List all events.

type EventSubscription 

type EventSubscription struct {
	// Globally unique identifier.
	Token string `json:"token,required"`
	// A description of the subscription.
	Description string `json:"description,required"`
	// Whether the subscription is disabled.
	Disabled   bool                         `json:"disabled,required"`
	URL        string                       `json:"url,required" format:"uri"`
	EventTypes []EventSubscriptionEventType `json:"event_types,nullable"`
	JSON       eventSubscriptionJSON        `json:"-"`
}

A subscription to specific event types.

func (*EventSubscription) UnmarshalJSON 

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

type EventSubscriptionEventType added in v0.5.0 

type EventSubscriptionEventType string
const (
	EventSubscriptionEventTypeAccountHolderCreated                                 EventSubscriptionEventType = "account_holder.created"
	EventSubscriptionEventTypeAccountHolderUpdated                                 EventSubscriptionEventType = "account_holder.updated"
	EventSubscriptionEventTypeAccountHolderVerification                            EventSubscriptionEventType = "account_holder.verification"
	EventSubscriptionEventTypeBalanceUpdated                                       EventSubscriptionEventType = "balance.updated"
	EventSubscriptionEventTypeCardCreated                                          EventSubscriptionEventType = "card.created"
	EventSubscriptionEventTypeCardRenewed                                          EventSubscriptionEventType = "card.renewed"
	EventSubscriptionEventTypeCardShipped                                          EventSubscriptionEventType = "card.shipped"
	EventSubscriptionEventTypeCardTransactionUpdated                               EventSubscriptionEventType = "card_transaction.updated"
	EventSubscriptionEventTypeDigitalWalletTokenizationApprovalRequest             EventSubscriptionEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionEventTypeDigitalWalletTokenizationResult                      EventSubscriptionEventType = "digital_wallet.tokenization_result"
	EventSubscriptionEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventSubscriptionEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionEventTypeDisputeUpdated                                       EventSubscriptionEventType = "dispute.updated"
	EventSubscriptionEventTypeDisputeEvidenceUploadFailed                          EventSubscriptionEventType = "dispute_evidence.upload_failed"
	EventSubscriptionEventTypePaymentTransactionCreated                            EventSubscriptionEventType = "payment_transaction.created"
	EventSubscriptionEventTypePaymentTransactionUpdated                            EventSubscriptionEventType = "payment_transaction.updated"
	EventSubscriptionEventTypeThreeDSAuthenticationCreated                         EventSubscriptionEventType = "three_ds_authentication.created"
	EventSubscriptionEventTypeTransferTransactionCreated                           EventSubscriptionEventType = "transfer_transaction.created"
)

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"
)

type EventSubscriptionListParams 

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

func (EventSubscriptionListParams) URLQuery 

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

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

type EventSubscriptionNewParams 

type EventSubscriptionNewParams struct {
	// URL to which event webhooks will be sent. URL must be a valid HTTPS address.
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Event subscription description.
	Description param.Field[string] `json:"description"`
	// Whether the event subscription is active (false) or inactive (true).
	Disabled param.Field[bool] `json:"disabled"`
	// Indicates types of events that will be sent to this subscription. If left blank,
	// all types will be sent.
	EventTypes param.Field[[]EventSubscriptionNewParamsEventType] `json:"event_types"`
}

func (EventSubscriptionNewParams) MarshalJSON 

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

type EventSubscriptionNewParamsEventType added in v0.5.0 

type EventSubscriptionNewParamsEventType string
const (
	EventSubscriptionNewParamsEventTypeAccountHolderCreated                                 EventSubscriptionNewParamsEventType = "account_holder.created"
	EventSubscriptionNewParamsEventTypeAccountHolderUpdated                                 EventSubscriptionNewParamsEventType = "account_holder.updated"
	EventSubscriptionNewParamsEventTypeAccountHolderVerification                            EventSubscriptionNewParamsEventType = "account_holder.verification"
	EventSubscriptionNewParamsEventTypeBalanceUpdated                                       EventSubscriptionNewParamsEventType = "balance.updated"
	EventSubscriptionNewParamsEventTypeCardCreated                                          EventSubscriptionNewParamsEventType = "card.created"
	EventSubscriptionNewParamsEventTypeCardRenewed                                          EventSubscriptionNewParamsEventType = "card.renewed"
	EventSubscriptionNewParamsEventTypeCardShipped                                          EventSubscriptionNewParamsEventType = "card.shipped"
	EventSubscriptionNewParamsEventTypeCardTransactionUpdated                               EventSubscriptionNewParamsEventType = "card_transaction.updated"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationApprovalRequest             EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationResult                      EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionNewParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventSubscriptionNewParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionNewParamsEventTypeDisputeUpdated                                       EventSubscriptionNewParamsEventType = "dispute.updated"
	EventSubscriptionNewParamsEventTypeDisputeEvidenceUploadFailed                          EventSubscriptionNewParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionNewParamsEventTypePaymentTransactionCreated                            EventSubscriptionNewParamsEventType = "payment_transaction.created"
	EventSubscriptionNewParamsEventTypePaymentTransactionUpdated                            EventSubscriptionNewParamsEventType = "payment_transaction.updated"
	EventSubscriptionNewParamsEventTypeThreeDSAuthenticationCreated                         EventSubscriptionNewParamsEventType = "three_ds_authentication.created"
	EventSubscriptionNewParamsEventTypeTransferTransactionCreated                           EventSubscriptionNewParamsEventType = "transfer_transaction.created"
)

type EventSubscriptionRecoverParams 

type EventSubscriptionRecoverParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
}

func (EventSubscriptionRecoverParams) URLQuery 

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

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

type EventSubscriptionReplayMissingParams 

type EventSubscriptionReplayMissingParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
}

func (EventSubscriptionReplayMissingParams) URLQuery 

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

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

type EventSubscriptionSendSimulatedExampleParams added in v0.7.4 

type EventSubscriptionSendSimulatedExampleParams struct {
	// Event type to send example message for.
	EventType param.Field[EventSubscriptionSendSimulatedExampleParamsEventType] `json:"event_type"`
}

func (EventSubscriptionSendSimulatedExampleParams) MarshalJSON added in v0.7.4 

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

type EventSubscriptionSendSimulatedExampleParamsEventType added in v0.7.4 

type EventSubscriptionSendSimulatedExampleParamsEventType string

Event type to send example message for. 

const (
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderCreated                                 EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderUpdated                                 EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeAccountHolderVerification                            EventSubscriptionSendSimulatedExampleParamsEventType = "account_holder.verification"
	EventSubscriptionSendSimulatedExampleParamsEventTypeBalanceUpdated                                       EventSubscriptionSendSimulatedExampleParamsEventType = "balance.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardCreated                                          EventSubscriptionSendSimulatedExampleParamsEventType = "card.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardRenewed                                          EventSubscriptionSendSimulatedExampleParamsEventType = "card.renewed"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardShipped                                          EventSubscriptionSendSimulatedExampleParamsEventType = "card.shipped"
	EventSubscriptionSendSimulatedExampleParamsEventTypeCardTransactionUpdated                               EventSubscriptionSendSimulatedExampleParamsEventType = "card_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationApprovalRequest             EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationResult                      EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventSubscriptionSendSimulatedExampleParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeUpdated                                       EventSubscriptionSendSimulatedExampleParamsEventType = "dispute.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeDisputeEvidenceUploadFailed                          EventSubscriptionSendSimulatedExampleParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionCreated                            EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypePaymentTransactionUpdated                            EventSubscriptionSendSimulatedExampleParamsEventType = "payment_transaction.updated"
	EventSubscriptionSendSimulatedExampleParamsEventTypeThreeDSAuthenticationCreated                         EventSubscriptionSendSimulatedExampleParamsEventType = "three_ds_authentication.created"
	EventSubscriptionSendSimulatedExampleParamsEventTypeTransferTransactionCreated                           EventSubscriptionSendSimulatedExampleParamsEventType = "transfer_transaction.created"
)

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 *shared.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 *shared.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) *shared.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) *shared.CursorPageAutoPager[EventSubscription]

List all the event subscriptions.

func (*EventSubscriptionService) New 

func (r *EventSubscriptionService) New(ctx context.Context, body EventSubscriptionNewParams, opts ...option.RequestOption) (res *EventSubscription, err error)

Create a new event subscription.

func (*EventSubscriptionService) Recover 

func (r *EventSubscriptionService) Recover(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionRecoverParams, opts ...option.RequestOption) (err error)

Resend all failed messages since a given time.

func (*EventSubscriptionService) ReplayMissing 

func (r *EventSubscriptionService) ReplayMissing(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionReplayMissingParams, opts ...option.RequestOption) (err error)

Replays messages to the endpoint. Only messages that were created after `begin` will be sent. Messages that were previously sent to the endpoint are not resent. Message will be retried if endpoint responds with a non-2xx status code. See [Retry Schedule](https://docs.lithic.com/docs/events-api#retry-schedule) for details.

func (*EventSubscriptionService) RotateSecret 

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

Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.

func (*EventSubscriptionService) SendSimulatedExample added in v0.7.4 

func (r *EventSubscriptionService) SendSimulatedExample(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionSendSimulatedExampleParams, opts ...option.RequestOption) (err error)

Send an example message for event.

func (*EventSubscriptionService) Update 

func (r *EventSubscriptionService) Update(ctx context.Context, eventSubscriptionToken string, body EventSubscriptionUpdateParams, opts ...option.RequestOption) (res *EventSubscription, err error)

Update an event subscription.

type EventSubscriptionUpdateParams 

type EventSubscriptionUpdateParams struct {
	// URL to which event webhooks will be sent. URL must be a valid HTTPS address.
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Event subscription description.
	Description param.Field[string] `json:"description"`
	// Whether the event subscription is active (false) or inactive (true).
	Disabled param.Field[bool] `json:"disabled"`
	// Indicates types of events that will be sent to this subscription. If left blank,
	// all types will be sent.
	EventTypes param.Field[[]EventSubscriptionUpdateParamsEventType] `json:"event_types"`
}

func (EventSubscriptionUpdateParams) MarshalJSON 

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

type EventSubscriptionUpdateParamsEventType added in v0.5.0 

type EventSubscriptionUpdateParamsEventType string
const (
	EventSubscriptionUpdateParamsEventTypeAccountHolderCreated                                 EventSubscriptionUpdateParamsEventType = "account_holder.created"
	EventSubscriptionUpdateParamsEventTypeAccountHolderUpdated                                 EventSubscriptionUpdateParamsEventType = "account_holder.updated"
	EventSubscriptionUpdateParamsEventTypeAccountHolderVerification                            EventSubscriptionUpdateParamsEventType = "account_holder.verification"
	EventSubscriptionUpdateParamsEventTypeBalanceUpdated                                       EventSubscriptionUpdateParamsEventType = "balance.updated"
	EventSubscriptionUpdateParamsEventTypeCardCreated                                          EventSubscriptionUpdateParamsEventType = "card.created"
	EventSubscriptionUpdateParamsEventTypeCardRenewed                                          EventSubscriptionUpdateParamsEventType = "card.renewed"
	EventSubscriptionUpdateParamsEventTypeCardShipped                                          EventSubscriptionUpdateParamsEventType = "card.shipped"
	EventSubscriptionUpdateParamsEventTypeCardTransactionUpdated                               EventSubscriptionUpdateParamsEventType = "card_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationApprovalRequest             EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_approval_request"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationResult                      EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_result"
	EventSubscriptionUpdateParamsEventTypeDigitalWalletTokenizationTwoFactorAuthenticationCode EventSubscriptionUpdateParamsEventType = "digital_wallet.tokenization_two_factor_authentication_code"
	EventSubscriptionUpdateParamsEventTypeDisputeUpdated                                       EventSubscriptionUpdateParamsEventType = "dispute.updated"
	EventSubscriptionUpdateParamsEventTypeDisputeEvidenceUploadFailed                          EventSubscriptionUpdateParamsEventType = "dispute_evidence.upload_failed"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionCreated                            EventSubscriptionUpdateParamsEventType = "payment_transaction.created"
	EventSubscriptionUpdateParamsEventTypePaymentTransactionUpdated                            EventSubscriptionUpdateParamsEventType = "payment_transaction.updated"
	EventSubscriptionUpdateParamsEventTypeThreeDSAuthenticationCreated                         EventSubscriptionUpdateParamsEventType = "three_ds_authentication.created"
	EventSubscriptionUpdateParamsEventTypeTransferTransactionCreated                           EventSubscriptionUpdateParamsEventType = "transfer_transaction.created"
)

type ExternalBankAccountAddress added in v0.6.5 

type ExternalBankAccountAddress struct {
	Address1   string                         `json:"address1,required"`
	City       string                         `json:"city,required"`
	Country    string                         `json:"country,required"`
	PostalCode string                         `json:"postal_code,required"`
	State      string                         `json:"state,required"`
	Address2   string                         `json:"address2"`
	JSON       externalBankAccountAddressJSON `json:"-"`
}

Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules.

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

Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules.

func (ExternalBankAccountAddressParam) MarshalJSON added in v0.6.5 

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

type ExternalBankAccountGetResponse added in v0.6.5 

type ExternalBankAccountGetResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner         string                                  `json:"owner,required"`
	OwnerType     ExternalBankAccountGetResponseOwnerType `json:"owner_type,required"`
	RoutingNumber string                                  `json:"routing_number,required"`
	State         ExternalBankAccountGetResponseState     `json:"state,required"`
	Type          ExternalBankAccountGetResponseType      `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64                                            `json:"verification_attempts,required"`
	VerificationMethod   ExternalBankAccountGetResponseVerificationMethod `json:"verification_method,required"`
	VerificationState    ExternalBankAccountGetResponseVerificationState  `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob             time.Time `json:"dob" format:"date"`
	DoingBusinessAs string    `json:"doing_business_as"`
	// The nickname given to this record of External Bank Account
	Name          string `json:"name"`
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                             `json:"verification_failed_reason"`
	JSON                     externalBankAccountGetResponseJSON `json:"-"`
}

func (*ExternalBankAccountGetResponse) UnmarshalJSON added in v0.6.5 

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

type ExternalBankAccountGetResponseOwnerType added in v0.6.5 

type ExternalBankAccountGetResponseOwnerType string
const (
	ExternalBankAccountGetResponseOwnerTypeBusiness   ExternalBankAccountGetResponseOwnerType = "BUSINESS"
	ExternalBankAccountGetResponseOwnerTypeIndividual ExternalBankAccountGetResponseOwnerType = "INDIVIDUAL"
)

type ExternalBankAccountGetResponseState added in v0.6.5 

type ExternalBankAccountGetResponseState string
const (
	ExternalBankAccountGetResponseStateClosed  ExternalBankAccountGetResponseState = "CLOSED"
	ExternalBankAccountGetResponseStateEnabled ExternalBankAccountGetResponseState = "ENABLED"
	ExternalBankAccountGetResponseStatePaused  ExternalBankAccountGetResponseState = "PAUSED"
)

type ExternalBankAccountGetResponseType added in v0.6.5 

type ExternalBankAccountGetResponseType string
const (
	ExternalBankAccountGetResponseTypeChecking ExternalBankAccountGetResponseType = "CHECKING"
	ExternalBankAccountGetResponseTypeSavings  ExternalBankAccountGetResponseType = "SAVINGS"
)

type ExternalBankAccountGetResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountGetResponseVerificationMethod string
const (
	ExternalBankAccountGetResponseVerificationMethodManual       ExternalBankAccountGetResponseVerificationMethod = "MANUAL"
	ExternalBankAccountGetResponseVerificationMethodMicroDeposit ExternalBankAccountGetResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountGetResponseVerificationMethodPlaid        ExternalBankAccountGetResponseVerificationMethod = "PLAID"
)

type ExternalBankAccountGetResponseVerificationState added in v0.6.5 

type ExternalBankAccountGetResponseVerificationState string
const (
	ExternalBankAccountGetResponseVerificationStateEnabled            ExternalBankAccountGetResponseVerificationState = "ENABLED"
	ExternalBankAccountGetResponseVerificationStateFailedVerification ExternalBankAccountGetResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountGetResponseVerificationStatePending            ExternalBankAccountGetResponseVerificationState = "PENDING"
)

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"
)

type ExternalBankAccountListParamsState added in v0.6.5 

type ExternalBankAccountListParamsState string
const (
	ExternalBankAccountListParamsStateClosed  ExternalBankAccountListParamsState = "CLOSED"
	ExternalBankAccountListParamsStateEnabled ExternalBankAccountListParamsState = "ENABLED"
	ExternalBankAccountListParamsStatePaused  ExternalBankAccountListParamsState = "PAUSED"
)

type ExternalBankAccountListParamsVerificationState added in v0.6.5 

type ExternalBankAccountListParamsVerificationState string
const (
	ExternalBankAccountListParamsVerificationStateEnabled            ExternalBankAccountListParamsVerificationState = "ENABLED"
	ExternalBankAccountListParamsVerificationStateFailedVerification ExternalBankAccountListParamsVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountListParamsVerificationStatePending            ExternalBankAccountListParamsVerificationState = "PENDING"
)

type ExternalBankAccountListResponse added in v0.6.5 

type ExternalBankAccountListResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner         string                                   `json:"owner,required"`
	OwnerType     ExternalBankAccountListResponseOwnerType `json:"owner_type,required"`
	RoutingNumber string                                   `json:"routing_number,required"`
	State         ExternalBankAccountListResponseState     `json:"state,required"`
	Type          ExternalBankAccountListResponseType      `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64                                             `json:"verification_attempts,required"`
	VerificationMethod   ExternalBankAccountListResponseVerificationMethod `json:"verification_method,required"`
	VerificationState    ExternalBankAccountListResponseVerificationState  `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob             time.Time `json:"dob" format:"date"`
	DoingBusinessAs string    `json:"doing_business_as"`
	// The nickname given to this record of External Bank Account
	Name          string `json:"name"`
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                              `json:"verification_failed_reason"`
	JSON                     externalBankAccountListResponseJSON `json:"-"`
}

func (*ExternalBankAccountListResponse) UnmarshalJSON added in v0.6.5 

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

type ExternalBankAccountListResponseOwnerType added in v0.6.5 

type ExternalBankAccountListResponseOwnerType string
const (
	ExternalBankAccountListResponseOwnerTypeBusiness   ExternalBankAccountListResponseOwnerType = "BUSINESS"
	ExternalBankAccountListResponseOwnerTypeIndividual ExternalBankAccountListResponseOwnerType = "INDIVIDUAL"
)

type ExternalBankAccountListResponseState added in v0.6.5 

type ExternalBankAccountListResponseState string
const (
	ExternalBankAccountListResponseStateClosed  ExternalBankAccountListResponseState = "CLOSED"
	ExternalBankAccountListResponseStateEnabled ExternalBankAccountListResponseState = "ENABLED"
	ExternalBankAccountListResponseStatePaused  ExternalBankAccountListResponseState = "PAUSED"
)

type ExternalBankAccountListResponseType added in v0.6.5 

type ExternalBankAccountListResponseType string
const (
	ExternalBankAccountListResponseTypeChecking ExternalBankAccountListResponseType = "CHECKING"
	ExternalBankAccountListResponseTypeSavings  ExternalBankAccountListResponseType = "SAVINGS"
)

type ExternalBankAccountListResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountListResponseVerificationMethod string
const (
	ExternalBankAccountListResponseVerificationMethodManual       ExternalBankAccountListResponseVerificationMethod = "MANUAL"
	ExternalBankAccountListResponseVerificationMethodMicroDeposit ExternalBankAccountListResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountListResponseVerificationMethodPlaid        ExternalBankAccountListResponseVerificationMethod = "PLAID"
)

type ExternalBankAccountListResponseVerificationState added in v0.6.5 

type ExternalBankAccountListResponseVerificationState string
const (
	ExternalBankAccountListResponseVerificationStateEnabled            ExternalBankAccountListResponseVerificationState = "ENABLED"
	ExternalBankAccountListResponseVerificationStateFailedVerification ExternalBankAccountListResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountListResponseVerificationStatePending            ExternalBankAccountListResponseVerificationState = "PENDING"
)

type ExternalBankAccountMicroDepositNewParams added in v0.6.5 

type ExternalBankAccountMicroDepositNewParams struct {
	MicroDeposits param.Field[[]int64] `json:"micro_deposits,required"`
}

func (ExternalBankAccountMicroDepositNewParams) MarshalJSON added in v0.6.5 

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

type ExternalBankAccountMicroDepositNewResponse added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner         string                                              `json:"owner,required"`
	OwnerType     ExternalBankAccountMicroDepositNewResponseOwnerType `json:"owner_type,required"`
	RoutingNumber string                                              `json:"routing_number,required"`
	State         ExternalBankAccountMicroDepositNewResponseState     `json:"state,required"`
	Type          ExternalBankAccountMicroDepositNewResponseType      `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64                                                        `json:"verification_attempts,required"`
	VerificationMethod   ExternalBankAccountMicroDepositNewResponseVerificationMethod `json:"verification_method,required"`
	VerificationState    ExternalBankAccountMicroDepositNewResponseVerificationState  `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob             time.Time `json:"dob" format:"date"`
	DoingBusinessAs string    `json:"doing_business_as"`
	// The nickname given to this record of External Bank Account
	Name          string `json:"name"`
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                         `json:"verification_failed_reason"`
	JSON                     externalBankAccountMicroDepositNewResponseJSON `json:"-"`
}

func (*ExternalBankAccountMicroDepositNewResponse) UnmarshalJSON added in v0.6.5 

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

type ExternalBankAccountMicroDepositNewResponseOwnerType added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseOwnerType string
const (
	ExternalBankAccountMicroDepositNewResponseOwnerTypeBusiness   ExternalBankAccountMicroDepositNewResponseOwnerType = "BUSINESS"
	ExternalBankAccountMicroDepositNewResponseOwnerTypeIndividual ExternalBankAccountMicroDepositNewResponseOwnerType = "INDIVIDUAL"
)

type ExternalBankAccountMicroDepositNewResponseState added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseState string
const (
	ExternalBankAccountMicroDepositNewResponseStateClosed  ExternalBankAccountMicroDepositNewResponseState = "CLOSED"
	ExternalBankAccountMicroDepositNewResponseStateEnabled ExternalBankAccountMicroDepositNewResponseState = "ENABLED"
	ExternalBankAccountMicroDepositNewResponseStatePaused  ExternalBankAccountMicroDepositNewResponseState = "PAUSED"
)

type ExternalBankAccountMicroDepositNewResponseType added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseType string
const (
	ExternalBankAccountMicroDepositNewResponseTypeChecking ExternalBankAccountMicroDepositNewResponseType = "CHECKING"
	ExternalBankAccountMicroDepositNewResponseTypeSavings  ExternalBankAccountMicroDepositNewResponseType = "SAVINGS"
)

type ExternalBankAccountMicroDepositNewResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseVerificationMethod string
const (
	ExternalBankAccountMicroDepositNewResponseVerificationMethodManual       ExternalBankAccountMicroDepositNewResponseVerificationMethod = "MANUAL"
	ExternalBankAccountMicroDepositNewResponseVerificationMethodMicroDeposit ExternalBankAccountMicroDepositNewResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountMicroDepositNewResponseVerificationMethodPlaid        ExternalBankAccountMicroDepositNewResponseVerificationMethod = "PLAID"
)

type ExternalBankAccountMicroDepositNewResponseVerificationState added in v0.6.5 

type ExternalBankAccountMicroDepositNewResponseVerificationState string
const (
	ExternalBankAccountMicroDepositNewResponseVerificationStateEnabled            ExternalBankAccountMicroDepositNewResponseVerificationState = "ENABLED"
	ExternalBankAccountMicroDepositNewResponseVerificationStateFailedVerification ExternalBankAccountMicroDepositNewResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountMicroDepositNewResponseVerificationStatePending            ExternalBankAccountMicroDepositNewResponseVerificationState = "PENDING"
)

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 interface {
	ImplementsExternalBankAccountNewParams()
}

This interface is a union satisfied by one of the following: ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest, ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest.

type ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest added in v0.6.5 

type ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest struct {
	AccountNumber      param.Field[string]                                                                  `json:"account_number,required"`
	Country            param.Field[string]                                                                  `json:"country,required"`
	Currency           param.Field[string]                                                                  `json:"currency,required"`
	Owner              param.Field[string]                                                                  `json:"owner,required"`
	OwnerType          param.Field[OwnerType]                                                               `json:"owner_type,required"`
	RoutingNumber      param.Field[string]                                                                  `json:"routing_number,required"`
	Type               param.Field[ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestType] `json:"type,required"`
	VerificationMethod param.Field[VerificationMethod]                                                      `json:"verification_method,required"`
	AccountToken       param.Field[string]                                                                  `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address   param.Field[ExternalBankAccountAddressParam] `json:"address"`
	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"`
	DoingBusinessAs param.Field[string]    `json:"doing_business_as"`
	Name            param.Field[string]    `json:"name"`
	UserDefinedID   param.Field[string]    `json:"user_defined_id"`
	// Indicates whether verification was enforced for a given association record. For
	// MICRO_DEPOSIT, option to disable verification if the external bank account has
	// already been verified before. By default, verification will be required unless
	// users pass in a value of false
	VerificationEnforcement param.Field[bool] `json:"verification_enforcement"`
}

func (ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest) ImplementsExternalBankAccountNewParams added in v0.6.5 

func (ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest) ImplementsExternalBankAccountNewParams()

func (ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequest) MarshalJSON added in v0.6.5 

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

type ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestType added in v0.6.5 

type ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestType string
const (
	ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestTypeChecking ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestType = "CHECKING"
	ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestTypeSavings  ExternalBankAccountNewParamsBankVerifiedCreateBankAccountAPIRequestType = "SAVINGS"
)

type ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest added in v0.6.5 

type ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest struct {
	Owner              param.Field[string]             `json:"owner,required"`
	OwnerType          param.Field[OwnerType]          `json:"owner_type,required"`
	ProcessorToken     param.Field[string]             `json:"processor_token,required"`
	VerificationMethod param.Field[VerificationMethod] `json:"verification_method,required"`
	AccountToken       param.Field[string]             `json:"account_token" format:"uuid"`
	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"`
	DoingBusinessAs param.Field[string]    `json:"doing_business_as"`
	UserDefinedID   param.Field[string]    `json:"user_defined_id"`
}

func (ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest) ImplementsExternalBankAccountNewParams added in v0.6.5 

func (ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest) ImplementsExternalBankAccountNewParams()

func (ExternalBankAccountNewParamsPlaidCreateBankAccountAPIRequest) MarshalJSON added in v0.6.5 

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

type ExternalBankAccountNewResponse added in v0.6.5 

type ExternalBankAccountNewResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner         string                                  `json:"owner,required"`
	OwnerType     ExternalBankAccountNewResponseOwnerType `json:"owner_type,required"`
	RoutingNumber string                                  `json:"routing_number,required"`
	State         ExternalBankAccountNewResponseState     `json:"state,required"`
	Type          ExternalBankAccountNewResponseType      `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64                                            `json:"verification_attempts,required"`
	VerificationMethod   ExternalBankAccountNewResponseVerificationMethod `json:"verification_method,required"`
	VerificationState    ExternalBankAccountNewResponseVerificationState  `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob             time.Time `json:"dob" format:"date"`
	DoingBusinessAs string    `json:"doing_business_as"`
	// The nickname given to this record of External Bank Account
	Name          string `json:"name"`
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                             `json:"verification_failed_reason"`
	JSON                     externalBankAccountNewResponseJSON `json:"-"`
}

func (*ExternalBankAccountNewResponse) UnmarshalJSON added in v0.6.5 

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

type ExternalBankAccountNewResponseOwnerType added in v0.6.5 

type ExternalBankAccountNewResponseOwnerType string
const (
	ExternalBankAccountNewResponseOwnerTypeBusiness   ExternalBankAccountNewResponseOwnerType = "BUSINESS"
	ExternalBankAccountNewResponseOwnerTypeIndividual ExternalBankAccountNewResponseOwnerType = "INDIVIDUAL"
)

type ExternalBankAccountNewResponseState added in v0.6.5 

type ExternalBankAccountNewResponseState string
const (
	ExternalBankAccountNewResponseStateClosed  ExternalBankAccountNewResponseState = "CLOSED"
	ExternalBankAccountNewResponseStateEnabled ExternalBankAccountNewResponseState = "ENABLED"
	ExternalBankAccountNewResponseStatePaused  ExternalBankAccountNewResponseState = "PAUSED"
)

type ExternalBankAccountNewResponseType added in v0.6.5 

type ExternalBankAccountNewResponseType string
const (
	ExternalBankAccountNewResponseTypeChecking ExternalBankAccountNewResponseType = "CHECKING"
	ExternalBankAccountNewResponseTypeSavings  ExternalBankAccountNewResponseType = "SAVINGS"
)

type ExternalBankAccountNewResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountNewResponseVerificationMethod string
const (
	ExternalBankAccountNewResponseVerificationMethodManual       ExternalBankAccountNewResponseVerificationMethod = "MANUAL"
	ExternalBankAccountNewResponseVerificationMethodMicroDeposit ExternalBankAccountNewResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountNewResponseVerificationMethodPlaid        ExternalBankAccountNewResponseVerificationMethod = "PLAID"
)

type ExternalBankAccountNewResponseVerificationState added in v0.6.5 

type ExternalBankAccountNewResponseVerificationState string
const (
	ExternalBankAccountNewResponseVerificationStateEnabled            ExternalBankAccountNewResponseVerificationState = "ENABLED"
	ExternalBankAccountNewResponseVerificationStateFailedVerification ExternalBankAccountNewResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountNewResponseVerificationStatePending            ExternalBankAccountNewResponseVerificationState = "PENDING"
)

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 *shared.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) *shared.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) Update added in v0.6.5 

func (r *ExternalBankAccountService) Update(ctx context.Context, externalBankAccountToken string, body ExternalBankAccountUpdateParams, opts ...option.RequestOption) (res *ExternalBankAccountUpdateResponse, err error)

Update the external bank account by token.

type ExternalBankAccountUpdateParams added in v0.6.5 

type ExternalBankAccountUpdateParams struct {
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address   param.Field[ExternalBankAccountAddressParam] `json:"address"`
	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"`
	DoingBusinessAs param.Field[string]    `json:"doing_business_as"`
	Name            param.Field[string]    `json:"name"`
	Owner           param.Field[string]    `json:"owner"`
	OwnerType       param.Field[OwnerType] `json:"owner_type"`
	UserDefinedID   param.Field[string]    `json:"user_defined_id"`
}

func (ExternalBankAccountUpdateParams) MarshalJSON added in v0.6.5 

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

type ExternalBankAccountUpdateResponse added in v0.6.5 

type ExternalBankAccountUpdateResponse struct {
	// A globally unique identifier for this record of an external bank account
	// association. If a program links an external bank account to more than one
	// end-user or to both the program and the end-user, then Lithic will return each
	// record of the association
	Token string `json:"token,required" format:"uuid"`
	// The country that the bank account is located in using ISO 3166-1. We will only
	// accept USA bank accounts e.g., USA
	Country string `json:"country,required"`
	// An ISO 8601 string representing when this funding source was added to the Lithic
	// account.
	Created time.Time `json:"created,required" format:"date-time"`
	// currency of the external account 3-digit alphabetic ISO 4217 code
	Currency string `json:"currency,required"`
	// The last 4 digits of the bank account. Derived by Lithic from the account number
	// passed
	LastFour string `json:"last_four,required"`
	// Legal Name of the business or individual who owns the external account. This
	// will appear in statements
	Owner         string                                     `json:"owner,required"`
	OwnerType     ExternalBankAccountUpdateResponseOwnerType `json:"owner_type,required"`
	RoutingNumber string                                     `json:"routing_number,required"`
	State         ExternalBankAccountUpdateResponseState     `json:"state,required"`
	Type          ExternalBankAccountUpdateResponseType      `json:"type,required"`
	// The number of attempts at verification
	VerificationAttempts int64                                               `json:"verification_attempts,required"`
	VerificationMethod   ExternalBankAccountUpdateResponseVerificationMethod `json:"verification_method,required"`
	VerificationState    ExternalBankAccountUpdateResponseVerificationState  `json:"verification_state,required"`
	// Indicates which Lithic account the external account is associated with. For
	// external accounts that are associated with the program, account_token field
	// returned will be null
	AccountToken string `json:"account_token" format:"uuid"`
	// Address used during Address Verification Service (AVS) checks during
	// transactions if enabled via Auth Rules.
	Address ExternalBankAccountAddress `json:"address"`
	// Optional field that helps identify bank accounts in receipts
	CompanyID string `json:"company_id"`
	// Date of Birth of the Individual that owns the external bank account
	Dob             time.Time `json:"dob" format:"date"`
	DoingBusinessAs string    `json:"doing_business_as"`
	// The nickname given to this record of External Bank Account
	Name          string `json:"name"`
	UserDefinedID string `json:"user_defined_id"`
	// Optional free text description of the reason for the failed verification. For
	// ACH micro-deposits returned, this field will display the reason return code sent
	// by the ACH network
	VerificationFailedReason string                                `json:"verification_failed_reason"`
	JSON                     externalBankAccountUpdateResponseJSON `json:"-"`
}

func (*ExternalBankAccountUpdateResponse) UnmarshalJSON added in v0.6.5 

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

type ExternalBankAccountUpdateResponseOwnerType added in v0.6.5 

type ExternalBankAccountUpdateResponseOwnerType string
const (
	ExternalBankAccountUpdateResponseOwnerTypeBusiness   ExternalBankAccountUpdateResponseOwnerType = "BUSINESS"
	ExternalBankAccountUpdateResponseOwnerTypeIndividual ExternalBankAccountUpdateResponseOwnerType = "INDIVIDUAL"
)

type ExternalBankAccountUpdateResponseState added in v0.6.5 

type ExternalBankAccountUpdateResponseState string
const (
	ExternalBankAccountUpdateResponseStateClosed  ExternalBankAccountUpdateResponseState = "CLOSED"
	ExternalBankAccountUpdateResponseStateEnabled ExternalBankAccountUpdateResponseState = "ENABLED"
	ExternalBankAccountUpdateResponseStatePaused  ExternalBankAccountUpdateResponseState = "PAUSED"
)

type ExternalBankAccountUpdateResponseType added in v0.6.5 

type ExternalBankAccountUpdateResponseType string
const (
	ExternalBankAccountUpdateResponseTypeChecking ExternalBankAccountUpdateResponseType = "CHECKING"
	ExternalBankAccountUpdateResponseTypeSavings  ExternalBankAccountUpdateResponseType = "SAVINGS"
)

type ExternalBankAccountUpdateResponseVerificationMethod added in v0.6.5 

type ExternalBankAccountUpdateResponseVerificationMethod string
const (
	ExternalBankAccountUpdateResponseVerificationMethodManual       ExternalBankAccountUpdateResponseVerificationMethod = "MANUAL"
	ExternalBankAccountUpdateResponseVerificationMethodMicroDeposit ExternalBankAccountUpdateResponseVerificationMethod = "MICRO_DEPOSIT"
	ExternalBankAccountUpdateResponseVerificationMethodPlaid        ExternalBankAccountUpdateResponseVerificationMethod = "PLAID"
)

type ExternalBankAccountUpdateResponseVerificationState added in v0.6.5 

type ExternalBankAccountUpdateResponseVerificationState string
const (
	ExternalBankAccountUpdateResponseVerificationStateEnabled            ExternalBankAccountUpdateResponseVerificationState = "ENABLED"
	ExternalBankAccountUpdateResponseVerificationStateFailedVerification ExternalBankAccountUpdateResponseVerificationState = "FAILED_VERIFICATION"
	ExternalBankAccountUpdateResponseVerificationStatePending            ExternalBankAccountUpdateResponseVerificationState = "PENDING"
)

type FinancialAccount 

type FinancialAccount struct {
	// Globally unique identifier for the financial account.
	Token string `json:"token,required" format:"uuid"`
	// Date and time for when the financial account was first created.
	Created time.Time `json:"created,required" format:"date-time"`
	// Type of financial account
	Type FinancialAccountType `json:"type,required"`
	// Date and time for when the financial account was last updated.
	Updated time.Time `json:"updated,required" format:"date-time"`
	// Account number for your Lithic-assigned bank account number, if applicable.
	AccountNumber string `json:"account_number"`
	// Routing number for your Lithic-assigned bank account number, if applicable.
	RoutingNumber string               `json:"routing_number"`
	JSON          financialAccountJSON `json:"-"`
}

Financial Account

func (*FinancialAccount) UnmarshalJSON 

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

type FinancialAccountBalanceListParams 

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

func (FinancialAccountBalanceListParams) URLQuery 

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

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

type 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 *shared.SinglePage[Balance], 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) *shared.SinglePageAutoPager[Balance]

Get the balances for a given financial account.

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 *shared.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) *shared.SinglePageAutoPager[FinancialTransaction]

List the financial transactions for a given financial account.

type FinancialAccountListParams 

type FinancialAccountListParams struct {
	// List financial accounts for a given account_token
	AccountToken param.Field[string] `query:"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"
	FinancialAccountListParamsTypeReserve FinancialAccountListParamsType = "RESERVE"
)

type FinancialAccountService 

type FinancialAccountService struct {
	Options               []option.RequestOption
	Balances              *FinancialAccountBalanceService
	FinancialTransactions *FinancialAccountFinancialTransactionService
	Statements            *FinancialAccountStatementService
}

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) List 

func (r *FinancialAccountService) List(ctx context.Context, query FinancialAccountListParams, opts ...option.RequestOption) (res *shared.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) *shared.SinglePageAutoPager[FinancialAccount]

Retrieve information on your financial accounts including routing and account number.

type FinancialAccountStatementLineItemListParams added in v0.9.0 

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

func (FinancialAccountStatementLineItemListParams) URLQuery added in v0.9.0 

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

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

type FinancialAccountStatementLineItemListResponse added in v0.9.0 

type FinancialAccountStatementLineItemListResponse struct {
	// Globally unique identifier for a Statement Line Item
	Token    string                                                `json:"token,required" format:"uuid"`
	Amount   int64                                                 `json:"amount,required"`
	Category FinancialAccountStatementLineItemListResponseCategory `json:"category,required"`
	// Timestamp of when the line item was generated
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction
	Currency string `json:"currency,required"`
	// Event types:
	//
	//   - `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to
	//     insufficient balance.
	//   - `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
	//   - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
	//     available balance.
	//   - `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
	//   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
	//     balance.
	//   - `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial
	//     Institution.
	//   - `AUTHORIZATION` - Authorize a card transaction.
	//   - `AUTHORIZATION_ADVICE` - Advice on a card transaction.
	//   - `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by
	//     Lithic.
	//   - `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
	//   - `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has
	//     occurred on a card.
	//   - `CLEARING` - Card Transaction is settled.
	//   - `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
	//   - `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
	//   - `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a
	//     merchant.
	//   - `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on
	//     your behalf by the network.
	//   - `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds
	//     without additional clearing.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or
	//     credit card funds without additional clearing.
	//   - `RETURN` - A card refund has been processed on the transaction.
	//   - `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant
	//     reverses an incorrect refund).
	//   - `TRANSFER` - Successful internal transfer of funds between financial accounts.
	//   - `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to
	//     insufficient balance of the sender.
	EventType FinancialAccountStatementLineItemListResponseEventType `json:"event_type,required"`
	// Globally unique identifier for a financial account
	FinancialAccountToken string `json:"financial_account_token,required" format:"uuid"`
	// Globally unique identifier for a financial transaction
	FinancialTransactionToken string `json:"financial_transaction_token,required" format:"uuid"`
	// Date that the transaction settled
	SettledDate time.Time `json:"settled_date,required" format:"date"`
	// Globally unique identifier for a card
	CardToken  string                                            `json:"card_token" format:"uuid"`
	Descriptor string                                            `json:"descriptor"`
	JSON       financialAccountStatementLineItemListResponseJSON `json:"-"`
}

func (*FinancialAccountStatementLineItemListResponse) UnmarshalJSON added in v0.9.0 

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

type FinancialAccountStatementLineItemListResponseCategory added in v0.9.0 

type FinancialAccountStatementLineItemListResponseCategory string
const (
	FinancialAccountStatementLineItemListResponseCategoryACH      FinancialAccountStatementLineItemListResponseCategory = "ACH"
	FinancialAccountStatementLineItemListResponseCategoryCard     FinancialAccountStatementLineItemListResponseCategory = "CARD"
	FinancialAccountStatementLineItemListResponseCategoryTransfer FinancialAccountStatementLineItemListResponseCategory = "TRANSFER"
)

type FinancialAccountStatementLineItemListResponseEventType added in v0.9.0 

type FinancialAccountStatementLineItemListResponseEventType string

Event types:

  • `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to insufficient balance.
  • `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
  • `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.
  • `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
  • `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.
  • `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial Institution.
  • `AUTHORIZATION` - Authorize a card transaction.
  • `AUTHORIZATION_ADVICE` - Advice on a card transaction.
  • `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
  • `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has occurred on a card.
  • `CLEARING` - Card Transaction is settled.
  • `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
  • `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
  • `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a merchant.
  • `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on your behalf by the network.
  • `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds without additional clearing.
  • `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or credit card funds without additional clearing.
  • `RETURN` - A card refund has been processed on the transaction.
  • `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant reverses an incorrect refund).
  • `TRANSFER` - Successful internal transfer of funds between financial accounts.
  • `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to insufficient balance of the sender.
const (
	FinancialAccountStatementLineItemListResponseEventTypeACHInsufficientFunds         FinancialAccountStatementLineItemListResponseEventType = "ACH_INSUFFICIENT_FUNDS"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationPending        FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_PENDING"
	FinancialAccountStatementLineItemListResponseEventTypeACHOriginationReleased       FinancialAccountStatementLineItemListResponseEventType = "ACH_ORIGINATION_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReceiptPending            FinancialAccountStatementLineItemListResponseEventType = "ACH_RECEIPT_PENDING"
	FinancialAccountStatementLineItemListResponseEventTypeACHReceiptReleased           FinancialAccountStatementLineItemListResponseEventType = "ACH_RECEIPT_RELEASED"
	FinancialAccountStatementLineItemListResponseEventTypeACHReturn                    FinancialAccountStatementLineItemListResponseEventType = "ACH_RETURN"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorization                FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationAdvice          FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_ADVICE"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationExpiry          FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_EXPIRY"
	FinancialAccountStatementLineItemListResponseEventTypeAuthorizationReversal        FinancialAccountStatementLineItemListResponseEventType = "AUTHORIZATION_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeBalanceInquiry               FinancialAccountStatementLineItemListResponseEventType = "BALANCE_INQUIRY"
	FinancialAccountStatementLineItemListResponseEventTypeClearing                     FinancialAccountStatementLineItemListResponseEventType = "CLEARING"
	FinancialAccountStatementLineItemListResponseEventTypeCorrectionCredit             FinancialAccountStatementLineItemListResponseEventType = "CORRECTION_CREDIT"
	FinancialAccountStatementLineItemListResponseEventTypeCorrectionDebit              FinancialAccountStatementLineItemListResponseEventType = "CORRECTION_DEBIT"
	FinancialAccountStatementLineItemListResponseEventTypeCreditAuthorization          FinancialAccountStatementLineItemListResponseEventType = "CREDIT_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeCreditAuthorizationAdvice    FinancialAccountStatementLineItemListResponseEventType = "CREDIT_AUTHORIZATION_ADVICE"
	FinancialAccountStatementLineItemListResponseEventTypeFinancialAuthorization       FinancialAccountStatementLineItemListResponseEventType = "FINANCIAL_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeFinancialCreditAuthorization FinancialAccountStatementLineItemListResponseEventType = "FINANCIAL_CREDIT_AUTHORIZATION"
	FinancialAccountStatementLineItemListResponseEventTypeReturn                       FinancialAccountStatementLineItemListResponseEventType = "RETURN"
	FinancialAccountStatementLineItemListResponseEventTypeReturnReversal               FinancialAccountStatementLineItemListResponseEventType = "RETURN_REVERSAL"
	FinancialAccountStatementLineItemListResponseEventTypeTransfer                     FinancialAccountStatementLineItemListResponseEventType = "TRANSFER"
	FinancialAccountStatementLineItemListResponseEventTypeTransferInsufficientFunds    FinancialAccountStatementLineItemListResponseEventType = "TRANSFER_INSUFFICIENT_FUNDS"
)

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 *shared.CursorPage[FinancialAccountStatementLineItemListResponse], err error)

List the line items for a given statement within a given financial account.

func (*FinancialAccountStatementLineItemService) ListAutoPaging added in v0.9.0 

func (r *FinancialAccountStatementLineItemService) ListAutoPaging(ctx context.Context, financialAccountToken string, statementToken string, query FinancialAccountStatementLineItemListParams, opts ...option.RequestOption) *shared.CursorPageAutoPager[FinancialAccountStatementLineItemListResponse]

List the line items for a given statement within a given financial account.

type FinancialAccountStatementListParams added in v0.9.0 

type FinancialAccountStatementListParams struct {
	// Date string in RFC 3339 format. Only entries created after the specified date
	// will be included.
	Begin param.Field[time.Time] `query:"begin" format:"date"`
	// Date string in RFC 3339 format. Only entries created before the specified date
	// will be included.
	End param.Field[time.Time] `query:"end" format:"date"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// 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 *shared.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) *shared.CursorPageAutoPager[Statement]

List the statements for a given financial account.

type FinancialAccountType 

type FinancialAccountType string

Type of financial account 

const (
	FinancialAccountTypeIssuing FinancialAccountType = "ISSUING"
	FinancialAccountTypeReserve FinancialAccountType = "RESERVE"
)

type FinancialTransaction 

type FinancialTransaction struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Status types:
	//
	//   - `CARD` - Issuing card transaction.
	//   - `ACH` - Transaction over ACH.
	//   - `TRANSFER` - Internal transfer of funds between financial accounts in your
	//     program.
	Category FinancialTransactionCategory `json:"category,required"`
	// Date and time when the financial transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction.
	Currency string `json:"currency,required"`
	// A string that provides a description of the financial transaction; may be useful
	// to display to users.
	Descriptor string `json:"descriptor,required"`
	// A list of all financial events that have modified this financial transaction.
	Events []FinancialTransactionEvent `json:"events,required"`
	// Pending amount of the transaction in the currency's smallest unit (e.g., cents),
	// including any acquirer fees. The value of this field will go to zero over time
	// once the financial transaction is settled.
	PendingAmount int64 `json:"pending_amount,required"`
	// APPROVED transactions were successful while DECLINED transactions were declined
	// by user, Lithic, or the network.
	Result FinancialTransactionResult `json:"result,required"`
	// Amount of the transaction that has been settled in the currency's smallest unit
	// (e.g., cents), including any acquirer fees. This may change over time.
	SettledAmount int64 `json:"settled_amount,required"`
	// Status types:
	//
	//   - `DECLINED` - The card transaction was declined.
	//   - `EXPIRED` - Lithic reversed the card authorization as it has passed its
	//     expiration time.
	//   - `PENDING` - Authorization is pending completion from the merchant or pending
	//     release from ACH hold period
	//   - `SETTLED` - The financial transaction is completed.
	//   - `VOIDED` - The merchant has voided the previously pending card authorization.
	Status FinancialTransactionStatus `json:"status,required"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated time.Time                `json:"updated,required" format:"date-time"`
	JSON    financialTransactionJSON `json:"-"`
}

func (*FinancialTransaction) UnmarshalJSON 

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

type FinancialTransactionCategory 

type FinancialTransactionCategory string

Status types:

  • `CARD` - Issuing card transaction.
  • `ACH` - Transaction over ACH.
  • `TRANSFER` - Internal transfer of funds between financial accounts in your program.
const (
	FinancialTransactionCategoryACH      FinancialTransactionCategory = "ACH"
	FinancialTransactionCategoryCard     FinancialTransactionCategory = "CARD"
	FinancialTransactionCategoryTransfer FinancialTransactionCategory = "TRANSFER"
)

type FinancialTransactionEvent added in v0.5.0 

type FinancialTransactionEvent struct {
	// Globally unique identifier.
	Token string `json:"token" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result FinancialTransactionEventsResult `json:"result"`
	// Event types:
	//
	//   - `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to
	//     insufficient balance.
	//   - `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
	//   - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
	//     available balance.
	//   - `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
	//   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
	//     balance.
	//   - `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial
	//     Institution.
	//   - `AUTHORIZATION` - Authorize a card transaction.
	//   - `AUTHORIZATION_ADVICE` - Advice on a card transaction.
	//   - `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by
	//     Lithic.
	//   - `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
	//   - `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has
	//     occurred on a card.
	//   - `CLEARING` - Card Transaction is settled.
	//   - `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
	//   - `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
	//   - `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a
	//     merchant.
	//   - `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on
	//     your behalf by the network.
	//   - `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds
	//     without additional clearing.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or
	//     credit card funds without additional clearing.
	//   - `RETURN` - A card refund has been processed on the transaction.
	//   - `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant
	//     reverses an incorrect refund).
	//   - `TRANSFER` - Successful internal transfer of funds between financial accounts.
	//   - `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to
	//     insufficient balance of the sender.
	Type FinancialTransactionEventsType `json:"type"`
	JSON financialTransactionEventJSON  `json:"-"`
}

func (*FinancialTransactionEvent) UnmarshalJSON added in v0.5.0 

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

type FinancialTransactionEventsResult 

type FinancialTransactionEventsResult string

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

const (
	FinancialTransactionEventsResultApproved FinancialTransactionEventsResult = "APPROVED"
	FinancialTransactionEventsResultDeclined FinancialTransactionEventsResult = "DECLINED"
)

type FinancialTransactionEventsType 

type FinancialTransactionEventsType string

Event types:

  • `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to insufficient balance.
  • `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
  • `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.
  • `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
  • `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.
  • `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial Institution.
  • `AUTHORIZATION` - Authorize a card transaction.
  • `AUTHORIZATION_ADVICE` - Advice on a card transaction.
  • `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
  • `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has occurred on a card.
  • `CLEARING` - Card Transaction is settled.
  • `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
  • `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
  • `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a merchant.
  • `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on your behalf by the network.
  • `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds without additional clearing.
  • `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or credit card funds without additional clearing.
  • `RETURN` - A card refund has been processed on the transaction.
  • `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant reverses an incorrect refund).
  • `TRANSFER` - Successful internal transfer of funds between financial accounts.
  • `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to insufficient balance of the sender.
const (
	FinancialTransactionEventsTypeACHInsufficientFunds         FinancialTransactionEventsType = "ACH_INSUFFICIENT_FUNDS"
	FinancialTransactionEventsTypeACHOriginationPending        FinancialTransactionEventsType = "ACH_ORIGINATION_PENDING"
	FinancialTransactionEventsTypeACHOriginationReleased       FinancialTransactionEventsType = "ACH_ORIGINATION_RELEASED"
	FinancialTransactionEventsTypeACHReceiptPending            FinancialTransactionEventsType = "ACH_RECEIPT_PENDING"
	FinancialTransactionEventsTypeACHReceiptReleased           FinancialTransactionEventsType = "ACH_RECEIPT_RELEASED"
	FinancialTransactionEventsTypeACHReturn                    FinancialTransactionEventsType = "ACH_RETURN"
	FinancialTransactionEventsTypeAuthorization                FinancialTransactionEventsType = "AUTHORIZATION"
	FinancialTransactionEventsTypeAuthorizationAdvice          FinancialTransactionEventsType = "AUTHORIZATION_ADVICE"
	FinancialTransactionEventsTypeAuthorizationExpiry          FinancialTransactionEventsType = "AUTHORIZATION_EXPIRY"
	FinancialTransactionEventsTypeAuthorizationReversal        FinancialTransactionEventsType = "AUTHORIZATION_REVERSAL"
	FinancialTransactionEventsTypeBalanceInquiry               FinancialTransactionEventsType = "BALANCE_INQUIRY"
	FinancialTransactionEventsTypeClearing                     FinancialTransactionEventsType = "CLEARING"
	FinancialTransactionEventsTypeCorrectionCredit             FinancialTransactionEventsType = "CORRECTION_CREDIT"
	FinancialTransactionEventsTypeCorrectionDebit              FinancialTransactionEventsType = "CORRECTION_DEBIT"
	FinancialTransactionEventsTypeCreditAuthorization          FinancialTransactionEventsType = "CREDIT_AUTHORIZATION"
	FinancialTransactionEventsTypeCreditAuthorizationAdvice    FinancialTransactionEventsType = "CREDIT_AUTHORIZATION_ADVICE"
	FinancialTransactionEventsTypeFinancialAuthorization       FinancialTransactionEventsType = "FINANCIAL_AUTHORIZATION"
	FinancialTransactionEventsTypeFinancialCreditAuthorization FinancialTransactionEventsType = "FINANCIAL_CREDIT_AUTHORIZATION"
	FinancialTransactionEventsTypeReturn                       FinancialTransactionEventsType = "RETURN"
	FinancialTransactionEventsTypeReturnReversal               FinancialTransactionEventsType = "RETURN_REVERSAL"
	FinancialTransactionEventsTypeTransfer                     FinancialTransactionEventsType = "TRANSFER"
	FinancialTransactionEventsTypeTransferInsufficientFunds    FinancialTransactionEventsType = "TRANSFER_INSUFFICIENT_FUNDS"
)

type FinancialTransactionListParams 

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

func (FinancialTransactionListParams) URLQuery 

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

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

type FinancialTransactionListParamsCategory 

type FinancialTransactionListParamsCategory string

Financial Transaction category to be returned. 

const (
	FinancialTransactionListParamsCategoryACH      FinancialTransactionListParamsCategory = "ACH"
	FinancialTransactionListParamsCategoryCard     FinancialTransactionListParamsCategory = "CARD"
	FinancialTransactionListParamsCategoryTransfer FinancialTransactionListParamsCategory = "TRANSFER"
)

type FinancialTransactionListParamsResult 

type FinancialTransactionListParamsResult string

Financial Transaction result to be returned. 

const (
	FinancialTransactionListParamsResultApproved FinancialTransactionListParamsResult = "APPROVED"
	FinancialTransactionListParamsResultDeclined FinancialTransactionListParamsResult = "DECLINED"
)

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"
)

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"
)

type FinancialTransactionStatus 

type FinancialTransactionStatus string

Status types:

  • `DECLINED` - The card transaction was declined.
  • `EXPIRED` - Lithic reversed the card authorization as it has passed its expiration time.
  • `PENDING` - Authorization is pending completion from the merchant or pending release from ACH hold period
  • `SETTLED` - The financial transaction is completed.
  • `VOIDED` - The merchant has voided the previously pending card authorization.
const (
	FinancialTransactionStatusDeclined FinancialTransactionStatus = "DECLINED"
	FinancialTransactionStatusExpired  FinancialTransactionStatus = "EXPIRED"
	FinancialTransactionStatusPending  FinancialTransactionStatus = "PENDING"
	FinancialTransactionStatusSettled  FinancialTransactionStatus = "SETTLED"
	FinancialTransactionStatusVoided   FinancialTransactionStatus = "VOIDED"
)

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"
)

type OwnerType added in v0.6.5 

type OwnerType string
const (
	OwnerTypeBusiness   OwnerType = "BUSINESS"
	OwnerTypeIndividual OwnerType = "INDIVIDUAL"
)

type Payment added in v0.6.5 

type Payment struct {
	Direction                PaymentDirection        `json:"direction,required"`
	Method                   PaymentMethod           `json:"method,required"`
	MethodAttributes         PaymentMethodAttributes `json:"method_attributes,required"`
	Source                   PaymentSource           `json:"source,required"`
	ExternalBankAccountToken string                  `json:"external_bank_account_token" format:"uuid"`
	UserDefinedID            string                  `json:"user_defined_id"`
	JSON                     paymentJSON             `json:"-"`
	FinancialTransaction
}

func (*Payment) UnmarshalJSON added in v0.6.5 

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

type PaymentDirection added in v0.6.5 

type PaymentDirection string
const (
	PaymentDirectionCredit PaymentDirection = "CREDIT"
	PaymentDirectionDebit  PaymentDirection = "DEBIT"
)

type PaymentListParams added in v0.6.5 

type PaymentListParams 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"`
	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 PaymentListParamsResult added in v0.6.5 

type PaymentListParamsResult string
const (
	PaymentListParamsResultApproved PaymentListParamsResult = "APPROVED"
	PaymentListParamsResultDeclined PaymentListParamsResult = "DECLINED"
)

type PaymentListParamsStatus added in v0.6.5 

type PaymentListParamsStatus string
const (
	PaymentListParamsStatusDeclined PaymentListParamsStatus = "DECLINED"
	PaymentListParamsStatusPending  PaymentListParamsStatus = "PENDING"
	PaymentListParamsStatusReturned PaymentListParamsStatus = "RETURNED"
	PaymentListParamsStatusSettled  PaymentListParamsStatus = "SETTLED"
)

type PaymentMethod added in v0.6.5 

type PaymentMethod string
const (
	PaymentMethodACHNextDay PaymentMethod = "ACH_NEXT_DAY"
	PaymentMethodACHSameDay PaymentMethod = "ACH_SAME_DAY"
)

type PaymentMethodAttributes added in v0.6.5 

type PaymentMethodAttributes struct {
	SecCode              PaymentMethodAttributesSecCode `json:"sec_code,required"`
	CompanyID            string                         `json:"company_id"`
	ReceiptRoutingNumber string                         `json:"receipt_routing_number"`
	Retries              int64                          `json:"retries"`
	ReturnReasonCode     string                         `json:"return_reason_code"`
	JSON                 paymentMethodAttributesJSON    `json:"-"`
}

func (*PaymentMethodAttributes) UnmarshalJSON added in v0.6.5 

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

type PaymentMethodAttributesSecCode added in v0.6.5 

type PaymentMethodAttributesSecCode string
const (
	PaymentMethodAttributesSecCodeCcd PaymentMethodAttributesSecCode = "CCD"
	PaymentMethodAttributesSecCodePpd PaymentMethodAttributesSecCode = "PPD"
	PaymentMethodAttributesSecCodeWeb PaymentMethodAttributesSecCode = "WEB"
)

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"
)

type PaymentNewParamsMethodAttributes added in v0.6.5 

type PaymentNewParamsMethodAttributes struct {
	SecCode              param.Field[PaymentNewParamsMethodAttributesSecCode] `json:"sec_code,required"`
	CompanyID            param.Field[string]                                  `json:"company_id"`
	ReceiptRoutingNumber param.Field[string]                                  `json:"receipt_routing_number"`
	Retries              param.Field[int64]                                   `json:"retries"`
	ReturnReasonCode     param.Field[string]                                  `json:"return_reason_code"`
}

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"
)

type PaymentNewParamsType added in v0.6.5 

type PaymentNewParamsType string
const (
	PaymentNewParamsTypeCollection PaymentNewParamsType = "COLLECTION"
	PaymentNewParamsTypePayment    PaymentNewParamsType = "PAYMENT"
)

type PaymentNewResponse added in v0.6.5 

type PaymentNewResponse struct {
	// Balance of a Financial Account
	Balance Balance                `json:"balance"`
	JSON    paymentNewResponseJSON `json:"-"`
	Payment
}

func (*PaymentNewResponse) UnmarshalJSON added in v0.6.5 

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

type PaymentRetryResponse added in v0.9.0 

type PaymentRetryResponse struct {
	// Balance of a Financial Account
	Balance Balance                  `json:"balance"`
	JSON    paymentRetryResponseJSON `json:"-"`
	Payment
}

func (*PaymentRetryResponse) UnmarshalJSON added in v0.9.0 

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

type PaymentService added in v0.6.5 

type PaymentService struct {
	Options []option.RequestOption
}

PaymentService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPaymentService method instead.

func NewPaymentService added in v0.6.5 

func NewPaymentService(opts ...option.RequestOption) (r *PaymentService)

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

func (*PaymentService) Get added in v0.6.5 

func (r *PaymentService) Get(ctx context.Context, paymentToken string, opts ...option.RequestOption) (res *Payment, err error)

Get the payment by token.

func (*PaymentService) List added in v0.6.5 

func (r *PaymentService) List(ctx context.Context, query PaymentListParams, opts ...option.RequestOption) (res *shared.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) *shared.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) 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 PaymentSimulateReleaseParams added in v0.6.5 

type PaymentSimulateReleaseParams struct {
	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 {
	DebuggingRequestID    string                               `json:"debugging_request_id" format:"uuid"`
	Result                PaymentSimulateReleaseResponseResult `json:"result"`
	TransactionEventToken string                               `json:"transaction_event_token" 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
const (
	PaymentSimulateReleaseResponseResultApproved PaymentSimulateReleaseResponseResult = "APPROVED"
	PaymentSimulateReleaseResponseResultDeclined PaymentSimulateReleaseResponseResult = "DECLINED"
)

type PaymentSimulateReturnParams added in v0.7.1 

type PaymentSimulateReturnParams struct {
	PaymentToken     param.Field[string] `json:"payment_token,required" format:"uuid"`
	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 {
	DebuggingRequestID    string                              `json:"debugging_request_id" format:"uuid"`
	Result                PaymentSimulateReturnResponseResult `json:"result"`
	TransactionEventToken string                              `json:"transaction_event_token" 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
const (
	PaymentSimulateReturnResponseResultApproved PaymentSimulateReturnResponseResult = "APPROVED"
	PaymentSimulateReturnResponseResultDeclined PaymentSimulateReturnResponseResult = "DECLINED"
)

type PaymentSource added in v0.6.5 

type PaymentSource string
const (
	PaymentSourceCustomer PaymentSource = "CUSTOMER"
	PaymentSourceLithic   PaymentSource = "LITHIC"
)

type ReportService added in v0.9.0 

type ReportService struct {
	Options    []option.RequestOption
	Settlement *ReportSettlementService
}

ReportService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReportService method instead.

func NewReportService added in v0.9.0 

func NewReportService(opts ...option.RequestOption) (r *ReportService)

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

type ReportSettlementListDetailsParams added in v0.9.0 

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

func (ReportSettlementListDetailsParams) URLQuery added in v0.9.0 

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

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

type ReportSettlementService added in v0.9.0 

type ReportSettlementService struct {
	Options []option.RequestOption
}

ReportSettlementService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReportSettlementService method instead.

func NewReportSettlementService added in v0.9.0 

func NewReportSettlementService(opts ...option.RequestOption) (r *ReportSettlementService)

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

func (*ReportSettlementService) ListDetails added in v0.9.0 

func (r *ReportSettlementService) ListDetails(ctx context.Context, reportDate time.Time, query ReportSettlementListDetailsParams, opts ...option.RequestOption) (res *shared.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) *shared.CursorPageAutoPager[SettlementDetail]

List details.

func (*ReportSettlementService) Summary added in v0.9.0 

func (r *ReportSettlementService) Summary(ctx context.Context, reportDate time.Time, opts ...option.RequestOption) (res *SettlementReport, err error)

Get the settlement report for a specified report date.

type 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"
)

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"
)

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"
)

type ResponderEndpointNewResponse added in v0.5.0 

type ResponderEndpointNewResponse struct {
	// True if the endpoint was enrolled successfully.
	Enrolled bool                             `json:"enrolled"`
	JSON     responderEndpointNewResponseJSON `json:"-"`
}

func (*ResponderEndpointNewResponse) UnmarshalJSON added in v0.5.0 

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

type ResponderEndpointService 

type ResponderEndpointService struct {
	Options []option.RequestOption
}

ResponderEndpointService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewResponderEndpointService method instead.

func NewResponderEndpointService 

func NewResponderEndpointService(opts ...option.RequestOption) (r *ResponderEndpointService)

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

func (*ResponderEndpointService) CheckStatus 

func (r *ResponderEndpointService) CheckStatus(ctx context.Context, query ResponderEndpointCheckStatusParams, opts ...option.RequestOption) (res *ResponderEndpointStatus, err error)

Check the status of a responder endpoint

func (*ResponderEndpointService) Delete 

func (r *ResponderEndpointService) Delete(ctx context.Context, body ResponderEndpointDeleteParams, opts ...option.RequestOption) (err error)

Disenroll a responder endpoint

func (*ResponderEndpointService) New 

func (r *ResponderEndpointService) New(ctx context.Context, body ResponderEndpointNewParams, opts ...option.RequestOption) (res *ResponderEndpointNewResponse, err error)

Enroll a responder endpoint

type ResponderEndpointStatus 

type ResponderEndpointStatus struct {
	// True if the instance has an endpoint enrolled.
	Enrolled bool `json:"enrolled"`
	// The URL of the currently enrolled endpoint or null.
	URL  string                      `json:"url,nullable" format:"uri"`
	JSON responderEndpointStatusJSON `json:"-"`
}

func (*ResponderEndpointStatus) UnmarshalJSON 

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

type SettlementDetail added in v0.9.0 

type SettlementDetail struct {
	// Globally unique identifier denoting the Settlement Detail.
	Token string `json:"token,required" format:"uuid"`
	// The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
	// for Visa).
	AccountToken string `json:"account_token,required" format:"uuid"`
	// Globally unique identifier denoting the card program that the associated
	// Transaction occurred on.
	CardProgramToken string `json:"card_program_token,required" format:"uuid"`
	// Globally unique identifier denoting the card that the associated Transaction
	// occurred on.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Date and time when the transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Three-digit alphabetic ISO 4217 code.
	Currency string `json:"currency,required"`
	// The total gross amount of disputes settlements.
	DisputesGrossAmount int64 `json:"disputes_gross_amount,required"`
	// Globally unique identifiers denoting the Events associated with this settlement.
	EventTokens []string `json:"event_tokens,required"`
	// The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
	// for Visa).
	Institution string `json:"institution,required"`
	// The total amount of interchange in six-digit extended precision.
	InterchangeFeeExtendedPrecision int64 `json:"interchange_fee_extended_precision,required"`
	// The total amount of interchange.
	InterchangeGrossAmount int64 `json:"interchange_gross_amount,required"`
	// Card network where the transaction took place.
	Network SettlementDetailNetwork `json:"network,required"`
	// The total gross amount of other fees by type.
	OtherFeesDetails SettlementDetailOtherFeesDetails `json:"other_fees_details,required"`
	// Total amount of gross other fees outside of interchange.
	OtherFeesGrossAmount int64 `json:"other_fees_gross_amount,required"`
	// Date of when the report was first generated.
	ReportDate string `json:"report_date,required"`
	// Date of when money movement is triggered for the transaction.
	SettlementDate string `json:"settlement_date,required"`
	// Globally unique identifier denoting the associated Transaction object.
	TransactionToken string `json:"transaction_token,required" format:"uuid"`
	// The total amount of settlement impacting transactions (excluding interchange,
	// fees, and disputes).
	TransactionsGrossAmount int64 `json:"transactions_gross_amount,required"`
	// The type of settlement record.
	Type SettlementDetailType `json:"type,required"`
	// Date and time when the transaction first occurred. UTC time zone.
	Updated time.Time            `json:"updated,required" format:"date-time"`
	JSON    settlementDetailJSON `json:"-"`
}

func (*SettlementDetail) UnmarshalJSON added in v0.9.0 

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

type SettlementDetailNetwork added in v0.9.0 

type SettlementDetailNetwork string

Card network where the transaction took place. 

const (
	SettlementDetailNetworkInterlink  SettlementDetailNetwork = "INTERLINK"
	SettlementDetailNetworkMaestro    SettlementDetailNetwork = "MAESTRO"
	SettlementDetailNetworkMastercard SettlementDetailNetwork = "MASTERCARD"
	SettlementDetailNetworkUnknown    SettlementDetailNetwork = "UNKNOWN"
	SettlementDetailNetworkVisa       SettlementDetailNetwork = "VISA"
)

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 (
	SettlementDetailTypeClearing       SettlementDetailType = "CLEARING"
	SettlementDetailTypeFinancial      SettlementDetailType = "FINANCIAL"
	SettlementDetailTypeNonFinancial   SettlementDetailType = "NON-FINANCIAL"
	SettlementDetailTypeAdjustment     SettlementDetailType = "ADJUSTMENT"
	SettlementDetailTypeChargeback     SettlementDetailType = "CHARGEBACK"
	SettlementDetailTypeRepresentment  SettlementDetailType = "REPRESENTMENT"
	SettlementDetailTypePrearbitration SettlementDetailType = "PREARBITRATION"
	SettlementDetailTypeArbitration    SettlementDetailType = "ARBITRATION"
	SettlementDetailTypeFee            SettlementDetailType = "FEE"
)

type SettlementReport added in v0.9.0 

type SettlementReport struct {
	// Date and time when the transaction first occurred. UTC time zone.
	Created time.Time `json:"created,required" format:"date-time"`
	// Three-digit alphabetic ISO 4217 code.
	Currency string                     `json:"currency,required"`
	Details  []SettlementSummaryDetails `json:"details,required"`
	// The total gross amount of disputes settlements.
	DisputesGrossAmount int64 `json:"disputes_gross_amount,required"`
	// The total amount of interchange.
	InterchangeGrossAmount int64 `json:"interchange_gross_amount,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"`
	// The total net amount of cash moved. (net value of settled_gross_amount,
	// interchange, fees).
	SettledNetAmount int64 `json:"settled_net_amount,required"`
	// The total amount of settlement impacting transactions (excluding interchange,
	// fees, and disputes).
	TransactionsGrossAmount int64 `json:"transactions_gross_amount,required"`
	// Date and time when the transaction first occurred. UTC time zone.
	Updated time.Time            `json:"updated,required" format:"date-time"`
	JSON    settlementReportJSON `json:"-"`
}

func (*SettlementReport) UnmarshalJSON added in v0.9.0 

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

type SettlementSummaryDetails added in v0.9.0 

type SettlementSummaryDetails struct {
	// 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"
)

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 in a calendar 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. Month is calculated as this 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"
)

type Statement added in v0.9.0 

type Statement struct {
	// Globally unique identifier for a statement
	Token string `json:"token,required"`
	// Total payments during this billing period.
	ACHPeriodTotal int64 `json:"ach_period_total,required"`
	// Year-to-date settled payment total
	ACHYtdTotal int64 `json:"ach_ytd_total,required"`
	// Total adjustments during this billing period.
	AdjustmentsPeriodTotal int64 `json:"adjustments_period_total,required"`
	// Year-to-date settled adjustments total
	AdjustmentsYtdTotal int64 `json:"adjustments_ytd_total,required"`
	// Payment due at the end of the billing period. Negative amount indicates
	// something is owed. If the amount owed is positive (e.g., there was a net
	// credit), then payment should be returned to the cardholder via ACH.
	AmountDue int64 `json:"amount_due,required"`
	// Amount of credit available to spend
	AvailableCredit int64 `json:"available_credit,required"`
	// Timestamp of when the statement 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"`
	// 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.
	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" format:"date"`
	// Total settled card transactions during this billing period, determined by
	// liability date.
	PurchasesPeriodTotal int64 `json:"purchases_period_total,required"`
	// Year-to-date settled card transaction total
	PurchasesYtdTotal int64 `json:"purchases_ytd_total,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"`
	// Timestamp of when the statement was updated
	Updated time.Time     `json:"updated,required" format:"date-time"`
	JSON    statementJSON `json:"-"`
}

func (*Statement) UnmarshalJSON added in v0.9.0 

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

type ThreeDSAuthenticationGetResponse added in v0.6.6 

type ThreeDSAuthenticationGetResponse struct {
	// Globally unique identifier for the 3DS authentication.
	Token string `json:"token,required" format:"uuid"`
	// Type of account/card that is being used for the transaction. Maps to EMV 3DS
	// field acctType.
	AccountType ThreeDSAuthenticationGetResponseAccountType `json:"account_type,required,nullable"`
	// Indicates the outcome of the 3DS authentication process.
	AuthenticationResult ThreeDSAuthenticationGetResponseAuthenticationResult `json:"authentication_result,required,nullable"`
	// Indicates whether the expiration date provided by the cardholder during checkout
	// matches Lithic's record of the card's expiration date.
	CardExpiryCheck ThreeDSAuthenticationGetResponseCardExpiryCheck `json:"card_expiry_check,required"`
	// Globally unique identifier for the card on which the 3DS authentication has
	// occurred.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Object containing data about the cardholder provided during the transaction.
	Cardholder ThreeDSAuthenticationGetResponseCardholder `json:"cardholder,required"`
	// Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
	Channel ThreeDSAuthenticationGetResponseChannel `json:"channel,required"`
	// Date and time when the authentication was created in Lithic's system.
	Created time.Time `json:"created,required" format:"date-time"`
	// Entity that made the authentication decision.
	DecisionMadeBy ThreeDSAuthenticationGetResponseDecisionMadeBy `json:"decision_made_by,required,nullable"`
	// Object containing data about the merchant involved in the e-commerce
	// transaction.
	Merchant ThreeDSAuthenticationGetResponseMerchant `json:"merchant,required"`
	// Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
	// NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
	// populated.
	MessageCategory ThreeDSAuthenticationGetResponseMessageCategory `json:"message_category,required"`
	// Object containing additional data about the 3DS request that is beyond the EMV
	// 3DS standard spec (e.g., specific fields that only certain card networks send
	// but are not required across all 3DS requests).
	AdditionalData ThreeDSAuthenticationGetResponseAdditionalData `json:"additional_data,nullable"`
	// Object containing data about the app used in the e-commerce transaction. Present
	// if the channel is 'APP_BASED'.
	App ThreeDSAuthenticationGetResponseApp `json:"app"`
	// Type of authentication request - i.e., the type of transaction or interaction is
	// causing the merchant to request an authentication. Maps to EMV 3DS field
	// threeDSRequestorAuthenticationInd.
	AuthenticationRequestType ThreeDSAuthenticationGetResponseAuthenticationRequestType `json:"authentication_request_type,nullable"`
	// Object containing data about the browser used in the e-commerce transaction.
	// Present if the channel is 'BROWSER'.
	Browser ThreeDSAuthenticationGetResponseBrowser `json:"browser"`
	// Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that
	// takes place at the initiation of the merchant rather than the cardholder. The
	// most common example of this is where a merchant is authenticating before billing
	// for a recurring transaction such as a pay TV subscription or a utility bill.
	// Maps to EMV 3DS field threeRIInd.
	ThreeRiRequestType ThreeDSAuthenticationGetResponseThreeRiRequestType `json:"three_ri_request_type,nullable"`
	// Object containing data about the e-commerce transaction for which the merchant
	// is requesting authentication.
	Transaction ThreeDSAuthenticationGetResponseTransaction `json:"transaction,nullable"`
	JSON        threeDSAuthenticationGetResponseJSON        `json:"-"`
}

func (*ThreeDSAuthenticationGetResponse) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseAccountType added in v0.6.6 

type ThreeDSAuthenticationGetResponseAccountType string

Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType. 

const (
	ThreeDSAuthenticationGetResponseAccountTypeCredit        ThreeDSAuthenticationGetResponseAccountType = "CREDIT"
	ThreeDSAuthenticationGetResponseAccountTypeDebit         ThreeDSAuthenticationGetResponseAccountType = "DEBIT"
	ThreeDSAuthenticationGetResponseAccountTypeNotApplicable ThreeDSAuthenticationGetResponseAccountType = "NOT_APPLICABLE"
)

type ThreeDSAuthenticationGetResponseAdditionalData added in v0.6.6 

type ThreeDSAuthenticationGetResponseAdditionalData struct {
	// Mastercard only: Indicates whether the network would have considered the
	// authentication request to be low risk or not.
	NetworkDecision ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision `json:"network_decision,nullable"`
	// Mastercard only: Assessment by the network of the authentication risk level,
	// with a higher value indicating a higher amount of risk.
	NetworkRiskScore float64                                            `json:"network_risk_score,nullable"`
	JSON             threeDSAuthenticationGetResponseAdditionalDataJSON `json:"-"`
}

Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).

func (*ThreeDSAuthenticationGetResponseAdditionalData) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision added in v0.6.6 

type ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision string

Mastercard only: Indicates whether the network would have considered the authentication request to be low risk or not. 

const (
	ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecisionLowRisk    ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision = "LOW_RISK"
	ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecisionNotLowRisk ThreeDSAuthenticationGetResponseAdditionalDataNetworkDecision = "NOT_LOW_RISK"
)

type ThreeDSAuthenticationGetResponseApp added in v0.6.6 

type ThreeDSAuthenticationGetResponseApp struct {
	// Device information gathered from the cardholder's device - JSON name/value pairs
	// that is Base64url encoded. Maps to EMV 3DS field deviceInfo.
	DeviceInfo string `json:"device_info,nullable"`
	// External IP address used by the app generating the 3DS authentication request.
	// Maps to EMV 3DS field appIp.
	Ip   string                                  `json:"ip"`
	JSON threeDSAuthenticationGetResponseAppJSON `json:"-"`
}

Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

func (*ThreeDSAuthenticationGetResponseApp) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseAuthenticationRequestType added in v0.6.6 

type ThreeDSAuthenticationGetResponseAuthenticationRequestType string

Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd. 

const (
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeAddCard                        ThreeDSAuthenticationGetResponseAuthenticationRequestType = "ADD_CARD"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeBillingAgreement               ThreeDSAuthenticationGetResponseAuthenticationRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeDelayedShipment                ThreeDSAuthenticationGetResponseAuthenticationRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeEmvTokenCardholderVerification ThreeDSAuthenticationGetResponseAuthenticationRequestType = "EMV_TOKEN_CARDHOLDER_VERIFICATION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeInstallmentTransaction         ThreeDSAuthenticationGetResponseAuthenticationRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeMaintainCard                   ThreeDSAuthenticationGetResponseAuthenticationRequestType = "MAINTAIN_CARD"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypePaymentTransaction             ThreeDSAuthenticationGetResponseAuthenticationRequestType = "PAYMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeRecurringTransaction           ThreeDSAuthenticationGetResponseAuthenticationRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeSplitPayment                   ThreeDSAuthenticationGetResponseAuthenticationRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationGetResponseAuthenticationRequestTypeSplitShipment                  ThreeDSAuthenticationGetResponseAuthenticationRequestType = "SPLIT_SHIPMENT"
)

type ThreeDSAuthenticationGetResponseAuthenticationResult added in v0.6.6 

type ThreeDSAuthenticationGetResponseAuthenticationResult string

Indicates the outcome of the 3DS authentication process. 

const (
	ThreeDSAuthenticationGetResponseAuthenticationResultDecline ThreeDSAuthenticationGetResponseAuthenticationResult = "DECLINE"
	ThreeDSAuthenticationGetResponseAuthenticationResultSuccess ThreeDSAuthenticationGetResponseAuthenticationResult = "SUCCESS"
)

type ThreeDSAuthenticationGetResponseBrowser added in v0.6.6 

type ThreeDSAuthenticationGetResponseBrowser struct {
	// IP address of the browser as returned by the HTTP headers to the 3DS requestor
	// (e.g., merchant or digital wallet). Maps to EMV 3DS field browserIP.
	Ip string `json:"ip,nullable"`
	// Indicates whether the cardholder's browser has the ability to execute Java. Maps
	// to EMV 3DS field browserJavaEnabled.
	JavaEnabled bool `json:"java_enabled,nullable"`
	// Indicates whether the cardholder's browser has the ability to execute
	// JavaScript. Maps to EMV 3DS field browserJavascriptEnabled.
	JavascriptEnabled bool `json:"javascript_enabled,nullable"`
	// Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS
	// field browserLanguage.
	Language string `json:"language,nullable"`
	// Time zone of the cardholder's browser offset in minutes between UTC and the
	// cardholder browser's local time. The offset is positive if the local time is
	// behind UTC and negative if it is ahead. Maps to EMV 3DS field browserTz.
	TimeZone string `json:"time_zone,nullable"`
	// Content of the HTTP user-agent header. Maps to EMV 3DS field browserUserAgent.
	UserAgent string                                      `json:"user_agent,nullable"`
	JSON      threeDSAuthenticationGetResponseBrowserJSON `json:"-"`
}

Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

func (*ThreeDSAuthenticationGetResponseBrowser) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseCardExpiryCheck added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardExpiryCheck string

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date. 

const (
	ThreeDSAuthenticationGetResponseCardExpiryCheckMatch      ThreeDSAuthenticationGetResponseCardExpiryCheck = "MATCH"
	ThreeDSAuthenticationGetResponseCardExpiryCheckMismatch   ThreeDSAuthenticationGetResponseCardExpiryCheck = "MISMATCH"
	ThreeDSAuthenticationGetResponseCardExpiryCheckNotPresent ThreeDSAuthenticationGetResponseCardExpiryCheck = "NOT_PRESENT"
)

type ThreeDSAuthenticationGetResponseCardholder added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholder struct {
	// Indicates whether the shipping address and billing address provided by the
	// cardholder are the same. This value - and assessment of whether the addresses
	// match - is provided directly in the 3DS request and is not determined by Lithic.
	// Maps to EMV 3DS field addrMatch.
	AddressMatch bool `json:"address_match,nullable"`
	// Object containing data on the billing address provided during the transaction.
	BillingAddress ThreeDSAuthenticationGetResponseCardholderBillingAddress `json:"billing_address"`
	// Email address that is either provided by the cardholder or is on file with the
	// merchant in a 3RI request. Maps to EMV 3DS field email.
	Email string `json:"email,nullable"`
	// Name of the cardholder. Maps to EMV 3DS field cardholderName.
	Name string `json:"name,nullable"`
	// Home phone number provided by the cardholder. Maps to EMV 3DS fields
	// homePhone.cc and homePhone.subscriber.
	PhoneNumberHome string `json:"phone_number_home,nullable"`
	// Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
	// mobilePhone.cc and mobilePhone.subscriber.
	PhoneNumberMobile string `json:"phone_number_mobile,nullable"`
	// Work phone number provided by the cardholder. Maps to EMV 3DS fields
	// workPhone.cc and workPhone.subscriber.
	PhoneNumberWork string `json:"phone_number_work,nullable"`
	// Object containing data on the shipping address provided during the transaction.
	ShippingAddress ThreeDSAuthenticationGetResponseCardholderShippingAddress `json:"shipping_address"`
	JSON            threeDSAuthenticationGetResponseCardholderJSON            `json:"-"`
}

Object containing data about the cardholder provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholder) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseCardholderBillingAddress added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholderBillingAddress struct {
	// First line of the street address provided by the cardholder.
	Address1 string `json:"address1,nullable"`
	// Second line of the street address provided by the cardholder.
	Address2 string `json:"address2,nullable"`
	// Third line of the street address provided by the cardholder.
	Address3 string `json:"address3,nullable"`
	// City of the address provided by the cardholder.
	City string `json:"city,nullable"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country string `json:"country,nullable"`
	// Postal code (e.g., ZIP code) of the address provided by the cardholder
	PostalCode string                                                       `json:"postal_code,nullable"`
	JSON       threeDSAuthenticationGetResponseCardholderBillingAddressJSON `json:"-"`
}

Object containing data on the billing address provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholderBillingAddress) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseCardholderShippingAddress added in v0.6.6 

type ThreeDSAuthenticationGetResponseCardholderShippingAddress struct {
	// First line of the street address provided by the cardholder.
	Address1 string `json:"address1,nullable"`
	// Second line of the street address provided by the cardholder.
	Address2 string `json:"address2,nullable"`
	// Third line of the street address provided by the cardholder.
	Address3 string `json:"address3,nullable"`
	// City of the address provided by the cardholder.
	City string `json:"city,nullable"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country string `json:"country,nullable"`
	// Postal code (e.g., ZIP code) of the address provided by the cardholder
	PostalCode string                                                        `json:"postal_code,nullable"`
	JSON       threeDSAuthenticationGetResponseCardholderShippingAddressJSON `json:"-"`
}

Object containing data on the shipping address provided during the transaction.

func (*ThreeDSAuthenticationGetResponseCardholderShippingAddress) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseChannel added in v0.6.6 

type ThreeDSAuthenticationGetResponseChannel string

Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. 

const (
	ThreeDSAuthenticationGetResponseChannelAppBased                  ThreeDSAuthenticationGetResponseChannel = "APP_BASED"
	ThreeDSAuthenticationGetResponseChannelBrowser                   ThreeDSAuthenticationGetResponseChannel = "BROWSER"
	ThreeDSAuthenticationGetResponseChannelThreeDSRequestorInitiated ThreeDSAuthenticationGetResponseChannel = "THREE_DS_REQUESTOR_INITIATED"
)

type ThreeDSAuthenticationGetResponseDecisionMadeBy added in v0.6.6 

type ThreeDSAuthenticationGetResponseDecisionMadeBy string

Entity that made the authentication decision. 

const (
	ThreeDSAuthenticationGetResponseDecisionMadeByCustomerEndpoint ThreeDSAuthenticationGetResponseDecisionMadeBy = "CUSTOMER_ENDPOINT"
	ThreeDSAuthenticationGetResponseDecisionMadeByLithicDefault    ThreeDSAuthenticationGetResponseDecisionMadeBy = "LITHIC_DEFAULT"
	ThreeDSAuthenticationGetResponseDecisionMadeByLithicRules      ThreeDSAuthenticationGetResponseDecisionMadeBy = "LITHIC_RULES"
	ThreeDSAuthenticationGetResponseDecisionMadeByNetwork          ThreeDSAuthenticationGetResponseDecisionMadeBy = "NETWORK"
	ThreeDSAuthenticationGetResponseDecisionMadeByUnknown          ThreeDSAuthenticationGetResponseDecisionMadeBy = "UNKNOWN"
)

type ThreeDSAuthenticationGetResponseMerchant added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchant struct {
	// Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
	// acquirerMerchantId.
	ID string `json:"id,required"`
	// Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
	// field merchantCountryCode.
	Country string `json:"country,required"`
	// Merchant category code assigned to the merchant that describes its business
	// activity type. Maps to EMV 3DS field mcc.
	Mcc string `json:"mcc,required"`
	// Name of the merchant. Maps to EMV 3DS field merchantName.
	Name string `json:"name,required"`
	// Object containing additional data indicating additional risk factors related to
	// the e-commerce transaction.
	RiskIndicator ThreeDSAuthenticationGetResponseMerchantRiskIndicator `json:"risk_indicator,required"`
	JSON          threeDSAuthenticationGetResponseMerchantJSON          `json:"-"`
}

Object containing data about the merchant involved in the e-commerce transaction.

func (*ThreeDSAuthenticationGetResponseMerchant) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseMerchantRiskIndicator added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicator struct {
	// In transactions with electronic delivery, email address to which merchandise is
	// delivered. Maps to EMV 3DS field deliveryEmailAddress.
	DeliveryEmailAddress string `json:"delivery_email_address,nullable"`
	// The delivery time frame for the merchandise. Maps to EMV 3DS field
	// deliveryTimeframe.
	DeliveryTimeFrame ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame `json:"delivery_time_frame,nullable"`
	// In prepaid or gift card purchase transactions, purchase amount total in major
	// units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
	// giftCardAmount.
	GiftCardAmount float64 `json:"gift_card_amount,nullable"`
	// In prepaid or gift card purchase transactions, count of individual prepaid or
	// gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.
	GiftCardCount float64 `json:"gift_card_count,nullable"`
	// In prepaid or gift card purchase transactions, currency code of the gift card.
	// Maps to EMV 3DS field giftCardCurr.
	GiftCardCurrency string `json:"gift_card_currency,nullable"`
	// Indicates whether the purchase is for merchandise that is available now or at a
	// future date. Maps to EMV 3DS field preOrderPurchaseInd.
	OrderAvailability ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability `json:"order_availability,nullable"`
	// In pre-order purchase transactions, the expected date that the merchandise will
	// be available. Maps to EMV 3DS field preOrderDate.
	PreOrderAvailableDate time.Time `json:"pre_order_available_date,nullable" format:"date-time"`
	// Indicates whether the cardholder is reordering previously purchased merchandise.
	// Maps to EMV 3DS field reorderItemsInd.
	ReorderItems ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems `json:"reorder_items,nullable"`
	// Shipping method that the cardholder chose for the transaction. If purchase
	// includes one or more item, this indicator is used for the physical goods; if the
	// purchase only includes digital goods, this indicator is used to describe the
	// most expensive item purchased. Maps to EMV 3DS field shipIndicator.
	ShippingMethod ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod `json:"shipping_method,nullable"`
	JSON           threeDSAuthenticationGetResponseMerchantRiskIndicatorJSON           `json:"-"`
}

Object containing additional data indicating additional risk factors related to the e-commerce transaction.

func (*ThreeDSAuthenticationGetResponseMerchantRiskIndicator) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame string

The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimeframe. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameElectronicDelivery   ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "ELECTRONIC_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameOvernightShipping    ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "OVERNIGHT_SHIPPING"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameSameDayShipping      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "SAME_DAY_SHIPPING"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrameTwoDayOrMoreShipping ThreeDSAuthenticationGetResponseMerchantRiskIndicatorDeliveryTimeFrame = "TWO_DAY_OR_MORE_SHIPPING"
)

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability string

Indicates whether the purchase is for merchandise that is available now or at a future date. Maps to EMV 3DS field preOrderPurchaseInd. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailabilityFutureAvailability   ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability = "FUTURE_AVAILABILITY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailabilityMerchandiseAvailable ThreeDSAuthenticationGetResponseMerchantRiskIndicatorOrderAvailability = "MERCHANDISE_AVAILABLE"
)

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems string

Indicates whether the cardholder is reordering previously purchased merchandise. Maps to EMV 3DS field reorderItemsInd. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItemsFirstTimeOrdered ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems = "FIRST_TIME_ORDERED"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItemsReordered        ThreeDSAuthenticationGetResponseMerchantRiskIndicatorReorderItems = "REORDERED"
)

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod added in v0.6.6 

type ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod string

Shipping method that the cardholder chose for the transaction. If purchase includes one or more item, this indicator is used for the physical goods; if the purchase only includes digital goods, this indicator is used to describe the most expensive item purchased. Maps to EMV 3DS field shipIndicator. 

const (
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodDigitalGoods               ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "DIGITAL_GOODS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodLockerDelivery             ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "LOCKER_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodOther                      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "OTHER"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodPickUpAndGoDelivery        ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "PICK_UP_AND_GO_DELIVERY"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToBillingAddress       ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_BILLING_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToNonBillingAddress    ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_NON_BILLING_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToOtherVerifiedAddress ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_OTHER_VERIFIED_ADDRESS"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodShipToStore                ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "SHIP_TO_STORE"
	ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethodTravelAndEventTickets      ThreeDSAuthenticationGetResponseMerchantRiskIndicatorShippingMethod = "TRAVEL_AND_EVENT_TICKETS"
)

type ThreeDSAuthenticationGetResponseMessageCategory added in v0.9.0 

type ThreeDSAuthenticationGetResponseMessageCategory string

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated. 

const (
	ThreeDSAuthenticationGetResponseMessageCategoryNonPaymentAuthentication ThreeDSAuthenticationGetResponseMessageCategory = "NON_PAYMENT_AUTHENTICATION"
	ThreeDSAuthenticationGetResponseMessageCategoryPaymentAuthentication    ThreeDSAuthenticationGetResponseMessageCategory = "PAYMENT_AUTHENTICATION"
)

type ThreeDSAuthenticationGetResponseThreeRiRequestType added in v0.6.6 

type ThreeDSAuthenticationGetResponseThreeRiRequestType string

Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd. 

const (
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeAccountVerification         ThreeDSAuthenticationGetResponseThreeRiRequestType = "ACCOUNT_VERIFICATION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeAddCard                     ThreeDSAuthenticationGetResponseThreeRiRequestType = "ADD_CARD"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeBillingAgreement            ThreeDSAuthenticationGetResponseThreeRiRequestType = "BILLING_AGREEMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeCardSecurityCodeStatusCheck ThreeDSAuthenticationGetResponseThreeRiRequestType = "CARD_SECURITY_CODE_STATUS_CHECK"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeDelayedShipment             ThreeDSAuthenticationGetResponseThreeRiRequestType = "DELAYED_SHIPMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeDeviceBindingStatusCheck    ThreeDSAuthenticationGetResponseThreeRiRequestType = "DEVICE_BINDING_STATUS_CHECK"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeInstallmentTransaction      ThreeDSAuthenticationGetResponseThreeRiRequestType = "INSTALLMENT_TRANSACTION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeMailOrder                   ThreeDSAuthenticationGetResponseThreeRiRequestType = "MAIL_ORDER"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeMaintainCardInfo            ThreeDSAuthenticationGetResponseThreeRiRequestType = "MAINTAIN_CARD_INFO"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeOtherPayment                ThreeDSAuthenticationGetResponseThreeRiRequestType = "OTHER_PAYMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeRecurringTransaction        ThreeDSAuthenticationGetResponseThreeRiRequestType = "RECURRING_TRANSACTION"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeSplitPayment                ThreeDSAuthenticationGetResponseThreeRiRequestType = "SPLIT_PAYMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeSplitShipment               ThreeDSAuthenticationGetResponseThreeRiRequestType = "SPLIT_SHIPMENT"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTelephoneOrder              ThreeDSAuthenticationGetResponseThreeRiRequestType = "TELEPHONE_ORDER"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTopUp                       ThreeDSAuthenticationGetResponseThreeRiRequestType = "TOP_UP"
	ThreeDSAuthenticationGetResponseThreeRiRequestTypeTrustListStatusCheck        ThreeDSAuthenticationGetResponseThreeRiRequestType = "TRUST_LIST_STATUS_CHECK"
)

type ThreeDSAuthenticationGetResponseTransaction added in v0.6.6 

type ThreeDSAuthenticationGetResponseTransaction struct {
	// Amount of the purchase in minor units of currency with all punctuation removed.
	// Maps to EMV 3DS field purchaseAmount.
	Amount float64 `json:"amount,required"`
	// Currency of the purchase. Maps to EMV 3DS field purchaseCurrency.
	Currency string `json:"currency,required"`
	// Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
	// 3DS field purchaseExponent.
	CurrencyExponent float64 `json:"currency_exponent,required"`
	// Date and time when the authentication was generated by the merchant/acquirer's
	// 3DS server. Maps to EMV 3DS field purchaseDate.
	DateTime time.Time `json:"date_time,required" format:"date-time"`
	// Type of the transaction for which a 3DS authentication request is occurring.
	// Maps to EMV 3DS field transType.
	Type ThreeDSAuthenticationGetResponseTransactionType `json:"type,required,nullable"`
	JSON threeDSAuthenticationGetResponseTransactionJSON `json:"-"`
}

Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

func (*ThreeDSAuthenticationGetResponseTransaction) UnmarshalJSON added in v0.6.6 

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

type ThreeDSAuthenticationGetResponseTransactionType added in v0.6.6 

type ThreeDSAuthenticationGetResponseTransactionType string

Type of the transaction for which a 3DS authentication request is occurring. Maps to EMV 3DS field transType. 

const (
	ThreeDSAuthenticationGetResponseTransactionTypeAccountFunding           ThreeDSAuthenticationGetResponseTransactionType = "ACCOUNT_FUNDING"
	ThreeDSAuthenticationGetResponseTransactionTypeCheckAcceptance          ThreeDSAuthenticationGetResponseTransactionType = "CHECK_ACCEPTANCE"
	ThreeDSAuthenticationGetResponseTransactionTypeGoodsServicePurchase     ThreeDSAuthenticationGetResponseTransactionType = "GOODS_SERVICE_PURCHASE"
	ThreeDSAuthenticationGetResponseTransactionTypePrepaidActivationAndLoad ThreeDSAuthenticationGetResponseTransactionType = "PREPAID_ACTIVATION_AND_LOAD"
	ThreeDSAuthenticationGetResponseTransactionTypeQuasiCashTransaction     ThreeDSAuthenticationGetResponseTransactionType = "QUASI_CASH_TRANSACTION"
)

type ThreeDSAuthenticationService added in v0.6.6 

type ThreeDSAuthenticationService struct {
	Options []option.RequestOption
}

ThreeDSAuthenticationService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewThreeDSAuthenticationService method instead.

func NewThreeDSAuthenticationService added in v0.6.6 

func NewThreeDSAuthenticationService(opts ...option.RequestOption) (r *ThreeDSAuthenticationService)

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

func (*ThreeDSAuthenticationService) Get added in v0.6.6 

func (r *ThreeDSAuthenticationService) Get(ctx context.Context, threeDSAuthenticationToken string, opts ...option.RequestOption) (res *ThreeDSAuthenticationGetResponse, err error)

Get 3DS Authentication by token

func (*ThreeDSAuthenticationService) Simulate added in v0.7.4 

func (r *ThreeDSAuthenticationService) Simulate(ctx context.Context, body ThreeDSAuthenticationSimulateParams, opts ...option.RequestOption) (res *ThreeDSAuthenticationSimulateResponse, err error)

Simulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating authentications requires your customer decisioning endpoint to be set up properly (respond with a valid JSON).

type ThreeDSAuthenticationSimulateParams added in v0.7.4 

type ThreeDSAuthenticationSimulateParams struct {
	Merchant param.Field[ThreeDSAuthenticationSimulateParamsMerchant] `json:"merchant,required"`
	// Sixteen digit card number.
	Pan         param.Field[string]                                         `json:"pan,required"`
	Transaction param.Field[ThreeDSAuthenticationSimulateParamsTransaction] `json:"transaction,required"`
}

func (ThreeDSAuthenticationSimulateParams) MarshalJSON added in v0.7.4 

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

type ThreeDSAuthenticationSimulateParamsMerchant added in v0.7.4 

type ThreeDSAuthenticationSimulateParamsMerchant struct {
	// Unique identifier to identify the payment card acceptor. Corresponds to
	// `merchant_acceptor_id` in authorization.
	ID param.Field[string] `json:"id,required"`
	// Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
	// (e.g. USA)
	Country param.Field[string] `json:"country,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc,required"`
	// Merchant descriptor, corresponds to `descriptor` in authorization.
	Name param.Field[string] `json:"name,required"`
}

func (ThreeDSAuthenticationSimulateParamsMerchant) MarshalJSON added in v0.7.4 

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

type ThreeDSAuthenticationSimulateParamsTransaction added in v0.7.4 

type ThreeDSAuthenticationSimulateParamsTransaction struct {
	// Amount (in cents) to authenticate.
	Amount param.Field[int64] `json:"amount,required"`
	// 3-digit alphabetic ISO 4217 currency code.
	Currency param.Field[string] `json:"currency,required"`
}

func (ThreeDSAuthenticationSimulateParamsTransaction) MarshalJSON added in v0.7.4 

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

type ThreeDSAuthenticationSimulateResponse added in v0.7.4 

type ThreeDSAuthenticationSimulateResponse struct {
	// A unique token to reference this transaction with later calls to void or clear
	// the authorization.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                    `json:"debugging_request_id" format:"uuid"`
	JSON               threeDSAuthenticationSimulateResponseJSON `json:"-"`
}

func (*ThreeDSAuthenticationSimulateResponse) UnmarshalJSON added in v0.7.4 

func (r *ThreeDSAuthenticationSimulateResponse) UnmarshalJSON(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) 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 Tokenization added in v0.7.1 

type Tokenization struct {
	// A fixed-width 23-digit numeric identifier for the Transaction that may be set if
	// the transaction originated from the Mastercard network. This number may be used
	// for dispute tracking.
	Token string `json:"token,required" format:"uuid"`
	// The account token associated with the card being tokenized.
	AccountToken string `json:"account_token,required" format:"uuid"`
	// The card token associated with the card being tokenized.
	CardToken string `json:"card_token,required" format:"uuid"`
	// Date and time when the tokenization first occurred. UTC time zone.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The status of the tokenization request
	Status TokenizationStatus `json:"status,required"`
	// The entity that is requested the tokenization. Represents a Digital Wallet.
	TokenRequestorName TokenizationTokenRequestorName `json:"token_requestor_name,required"`
	// The network's unique reference for the tokenization.
	TokenUniqueReference string `json:"token_unique_reference,required"`
	// Latest date and time when the tokenization was updated. UTC time zone.
	UpdatedAt time.Time        `json:"updated_at,required" format:"date-time"`
	JSON      tokenizationJSON `json:"-"`
}

func (*Tokenization) UnmarshalJSON added in v0.7.1 

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

type TokenizationDecisioningRotateSecretResponse 

type TokenizationDecisioningRotateSecretResponse struct {
	// The new Tokenization Decisioning HMAC secret
	Secret string                                          `json:"secret"`
	JSON   tokenizationDecisioningRotateSecretResponseJSON `json:"-"`
}

func (*TokenizationDecisioningRotateSecretResponse) UnmarshalJSON 

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

type TokenizationDecisioningService 

type TokenizationDecisioningService struct {
	Options []option.RequestOption
}

TokenizationDecisioningService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenizationDecisioningService method instead.

func NewTokenizationDecisioningService 

func NewTokenizationDecisioningService(opts ...option.RequestOption) (r *TokenizationDecisioningService)

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

func (*TokenizationDecisioningService) GetSecret 

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

Retrieve the Tokenization Decisioning secret key. If one does not exist your program yet, calling this endpoint will create one for you. The headers of the Tokenization Decisioning request will contain a hmac signature which you can use to verify requests originate from Lithic. See [this page](https://docs.lithic.com/docs/events-api#verifying-webhooks) for more detail about verifying Tokenization Decisioning requests.

func (*TokenizationDecisioningService) RotateSecret 

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

Generate a new Tokenization Decisioning secret key. The old Tokenization Decisioning secret key will be deactivated 24 hours after a successful request to this endpoint.

type 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) Simulate added in v0.7.1 

func (r *TokenizationService) Simulate(ctx context.Context, body TokenizationSimulateParams, opts ...option.RequestOption) (res *TokenizationSimulateResponse, err error)

This endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem.

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"`
	// 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"
)

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"
)

type TokenizationSimulateResponse added in v0.7.1 

type TokenizationSimulateResponse struct {
	Data []Tokenization                   `json:"data"`
	JSON tokenizationSimulateResponseJSON `json:"-"`
}

func (*TokenizationSimulateResponse) UnmarshalJSON added in v0.7.1 

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

type TokenizationStatus added in v0.7.1 

type TokenizationStatus string

The status of the tokenization request 

const (
	TokenizationStatusApproved                        TokenizationStatus = "APPROVED"
	TokenizationStatusDeclined                        TokenizationStatus = "DECLINED"
	TokenizationStatusRequireAdditionalAuthentication TokenizationStatus = "REQUIRE_ADDITIONAL_AUTHENTICATION"
)

type TokenizationTokenRequestorName added in v0.7.1 

type TokenizationTokenRequestorName string

The entity that is requested the tokenization. Represents a Digital Wallet. 

const (
	TokenizationTokenRequestorNameApplePay   TokenizationTokenRequestorName = "APPLE_PAY"
	TokenizationTokenRequestorNameGoogle     TokenizationTokenRequestorName = "GOOGLE"
	TokenizationTokenRequestorNameSamsungPay TokenizationTokenRequestorName = "SAMSUNG_PAY"
)

type Transaction 

type Transaction struct {
	// Globally unique identifier.
	Token string `json:"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"`
	// Unique identifier assigned to a transaction by the acquirer that can be used in
	// dispute and chargeback filing.
	AcquirerReferenceNumber string `json:"acquirer_reference_number,required,nullable"`
	// Authorization amount of the transaction (in cents), including any acquirer fees.
	// This may change over time, and will represent the settled amount once the
	// transaction is settled.
	Amount int64 `json:"amount,required"`
	// Authorization amount (in cents) of the transaction, including any acquirer fees.
	// This amount always represents the amount authorized for the transaction,
	// unaffected by settlement.
	AuthorizationAmount int64 `json:"authorization_amount,required"`
	// A fixed-width 6-digit numeric identifier that can be used to identify a
	// transaction with networks.
	AuthorizationCode string `json:"authorization_code,required"`
	// Token for the card used in this transaction.
	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"`
	// A list of all events that have modified this transaction.
	Events   []TransactionEvent  `json:"events,required"`
	Merchant TransactionMerchant `json:"merchant,required"`
	// Analogous to the "amount" property, but will represent the amount in the
	// transaction's local currency (smallest unit), including any acquirer fees.
	MerchantAmount int64 `json:"merchant_amount,required"`
	// Analogous to the "authorization_amount" property, but will represent the amount
	// in the transaction's local currency (smallest unit), including any acquirer
	// fees.
	MerchantAuthorizationAmount int64 `json:"merchant_authorization_amount,required"`
	// 3-digit alphabetic ISO 4217 code for the local currency of the transaction.
	MerchantCurrency string `json:"merchant_currency,required"`
	// Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
	// `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the
	// network code from the upstream provider.
	Network TransactionNetwork `json:"network,required,nullable"`
	// `APPROVED` or decline reason. See Event result types
	Result TransactionResult `json:"result,required"`
	// Amount of the transaction that has been settled (in cents), including any
	// acquirer fees. This may change over time.
	SettledAmount int64 `json:"settled_amount,required"`
	// Status types:
	//
	//   - `DECLINED` - The transaction was declined.
	//   - `EXPIRED` - Lithic reversed the authorization as it has passed its expiration
	//     time.
	//   - `PENDING` - Authorization is pending completion from the merchant.
	//   - `SETTLED` - The transaction is complete.
	//   - `VOIDED` - The merchant has voided the previously pending authorization.
	Status                   TransactionStatus                   `json:"status,required"`
	CardholderAuthentication TransactionCardholderAuthentication `json:"cardholder_authentication,nullable"`
	JSON                     transactionJSON                     `json:"-"`
}

func (*Transaction) UnmarshalJSON 

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

type TransactionCardholderAuthentication 

type TransactionCardholderAuthentication struct {
	// 3-D Secure Protocol version. Possible enum values:
	//
	// - `1`: 3-D Secure Protocol version 1.x applied to the transaction.
	// - `2`: 3-D Secure Protocol version 2.x applied to the transaction.
	// - `null`: 3-D Secure was not used for the transaction
	ThreeDSVersion string `json:"3ds_version,required,nullable"`
	// Exemption applied by the ACS to authenticate the transaction without requesting
	// a challenge. Possible enum values:
	//
	//   - `AUTHENTICATION_OUTAGE_EXCEPTION`: Authentication Outage Exception exemption.
	//   - `LOW_VALUE`: Low Value Payment exemption.
	//   - `MERCHANT_INITIATED_TRANSACTION`: Merchant Initiated Transaction (3RI).
	//   - `NONE`: No exemption applied.
	//   - `RECURRING_PAYMENT`: Recurring Payment exemption.
	//   - `SECURE_CORPORATE_PAYMENT`: Secure Corporate Payment exemption.
	//   - `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION`: Strong Customer Authentication
	//     Delegation exemption.
	//   - `TRANSACTION_RISK_ANALYSIS`: Acquirer Low-Fraud and Transaction Risk Analysis
	//     exemption.
	//
	// Maps to the 3-D Secure `transChallengeExemption` field.
	AcquirerExemption TransactionCardholderAuthenticationAcquirerExemption `json:"acquirer_exemption,required"`
	// Outcome of the 3DS authentication process. Possible enum values:
	//
	//   - `SUCCESS`: 3DS authentication was successful and the transaction is considered
	//     authenticated.
	//   - `DECLINE`: 3DS authentication was attempted but was unsuccessful — i.e., the
	//     issuer declined to authenticate the cardholder; note that Lithic populates
	//     this value on a best-effort basis based on common data across the 3DS
	//     authentication and ASA data elements.
	//   - `ATTEMPTS`: 3DS authentication was attempted but full authentication did not
	//     occur. A proof of attempted authenticated is provided by the merchant.
	//   - `NONE`: 3DS authentication was not performed on the transaction.
	AuthenticationResult TransactionCardholderAuthenticationAuthenticationResult `json:"authentication_result,required"`
	// Indicator for which party made the 3DS authentication decision. Possible enum
	// values:
	//
	//   - `NETWORK`: A networks tand-in service decided on the outcome; for token
	//     authentications (as indicated in the `liability_shift` attribute), this is the
	//     default value
	//   - `LITHIC_DEFAULT`: A default decision was made by Lithic, without running a
	//     rules-based authentication; this value will be set on card programs that do
	//     not participate in one of our two 3DS product tiers
	//   - `LITHIC_RULES`: A rules-based authentication was conducted by Lithic and
	//     Lithic decided on the outcome
	//   - `CUSTOMER_ENDPOINT`: Lithic customer decided on the outcome based on a
	//     real-time request sent to a configured endpoint
	//   - `UNKNOWN`: Data on which party decided is unavailable
	DecisionMadeBy TransactionCardholderAuthenticationDecisionMadeBy `json:"decision_made_by,required"`
	// Indicates whether chargeback liability shift applies to the transaction.
	// Possible enum values:
	//
	//   - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
	//     Secure flow, chargeback liability shift applies.
	//   - `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong
	//     Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability
	//     remains with the acquirer and in this case the `acquirer_exemption` field is
	//     expected to be not `NONE`.
	//   - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
	//     merchant is liable.
	//   - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
	//     cryptography, possibly recurring. Chargeback liability shift to the issuer
	//     applies.
	LiabilityShift TransactionCardholderAuthenticationLiabilityShift `json:"liability_shift,required"`
	// Unique identifier you can use to match a given 3DS authentication 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" format:"uuid"`
	// Verification attempted values:
	//
	//   - `APP_LOGIN`: Out-of-band login verification was attempted by the ACS.
	//   - `BIOMETRIC`: Out-of-band biometric verification was attempted by the ACS.
	//   - `NONE`: No cardholder verification was attempted by the Access Control Server
	//     (e.g. frictionless 3-D Secure flow, no 3-D Secure, or stand-in Risk Based
	//     Analysis).
	//   - `OTHER`: Other method was used by the ACS to verify the cardholder (e.g.
	//     Mastercard Identity Check Express, recurring transactions, etc.)
	//   - `OTP`: One-time password verification was attempted by the ACS.
	VerificationAttempted TransactionCardholderAuthenticationVerificationAttempted `json:"verification_attempted,required"`
	// This field partially maps to the `transStatus` field in the
	// [EMVCo 3-D Secure specification](https://www.emvco.com/emv-technologies/3d-secure/)
	// and Mastercard SPA2 AAV leading indicators.
	//
	// Verification result values:
	//
	//   - `CANCELLED`: Authentication/Account verification could not be performed,
	//     `transStatus = U`.
	//   - `FAILED`: Transaction was not authenticated. `transStatus = N`, note: the
	//     utilization of exemptions could also result in `transStatus = N`, inspect the
	//     `acquirer_exemption` field for more information.
	//   - `FRICTIONLESS`: Attempts processing performed, the transaction was not
	//     authenticated, but a proof of attempted authentication/verification is
	//     provided. `transStatus = A` and the leading AAV indicator was one of {`kE`,
	//     `kF`, `kQ`}.
	//   - `NOT_ATTEMPTED`: A 3-D Secure flow was not applied to this transaction.
	//     Leading AAV indicator was one of {`kN`, `kX`} or no AAV was provided for the
	//     transaction.
	//   - `REJECTED`: Authentication/Account Verification rejected; `transStatus = R`.
	//     Issuer is rejecting authentication/verification and requests that
	//     authorization not be attempted.
	//   - `SUCCESS`: Authentication verification successful. `transStatus = Y` and
	//     leading AAV indicator for the transaction was one of {`kA`, `kB`, `kC`, `kD`,
	//     `kO`, `kP`, `kR`, `kS`}.
	//
	// Note that the following `transStatus` values are not represented by this field:
	//
	// - `C`: Challenge Required
	// - `D`: Challenge Required; decoupled authentication confirmed
	// - `I`: Informational only
	// - `S`: Challenge using Secure Payment Confirmation (SPC)
	VerificationResult TransactionCardholderAuthenticationVerificationResult `json:"verification_result,required"`
	JSON               transactionCardholderAuthenticationJSON               `json:"-"`
}

func (*TransactionCardholderAuthentication) UnmarshalJSON 

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

type TransactionCardholderAuthenticationAcquirerExemption 

type TransactionCardholderAuthenticationAcquirerExemption string

Exemption applied by the ACS to authenticate the transaction without requesting a challenge. Possible enum values:

  • `AUTHENTICATION_OUTAGE_EXCEPTION`: Authentication Outage Exception exemption.
  • `LOW_VALUE`: Low Value Payment exemption.
  • `MERCHANT_INITIATED_TRANSACTION`: Merchant Initiated Transaction (3RI).
  • `NONE`: No exemption applied.
  • `RECURRING_PAYMENT`: Recurring Payment exemption.
  • `SECURE_CORPORATE_PAYMENT`: Secure Corporate Payment exemption.
  • `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION`: Strong Customer Authentication Delegation exemption.
  • `TRANSACTION_RISK_ANALYSIS`: Acquirer Low-Fraud and Transaction Risk Analysis exemption.

Maps to the 3-D Secure `transChallengeExemption` field. 

const (
	TransactionCardholderAuthenticationAcquirerExemptionAuthenticationOutageException          TransactionCardholderAuthenticationAcquirerExemption = "AUTHENTICATION_OUTAGE_EXCEPTION"
	TransactionCardholderAuthenticationAcquirerExemptionLowValue                               TransactionCardholderAuthenticationAcquirerExemption = "LOW_VALUE"
	TransactionCardholderAuthenticationAcquirerExemptionMerchantInitiatedTransaction           TransactionCardholderAuthenticationAcquirerExemption = "MERCHANT_INITIATED_TRANSACTION"
	TransactionCardholderAuthenticationAcquirerExemptionNone                                   TransactionCardholderAuthenticationAcquirerExemption = "NONE"
	TransactionCardholderAuthenticationAcquirerExemptionRecurringPayment                       TransactionCardholderAuthenticationAcquirerExemption = "RECURRING_PAYMENT"
	TransactionCardholderAuthenticationAcquirerExemptionSecureCorporatePayment                 TransactionCardholderAuthenticationAcquirerExemption = "SECURE_CORPORATE_PAYMENT"
	TransactionCardholderAuthenticationAcquirerExemptionStrongCustomerAuthenticationDelegation TransactionCardholderAuthenticationAcquirerExemption = "STRONG_CUSTOMER_AUTHENTICATION_DELEGATION"
	TransactionCardholderAuthenticationAcquirerExemptionTransactionRiskAnalysis                TransactionCardholderAuthenticationAcquirerExemption = "TRANSACTION_RISK_ANALYSIS"
)

type TransactionCardholderAuthenticationAuthenticationResult added in v0.8.0 

type TransactionCardholderAuthenticationAuthenticationResult string

Outcome of the 3DS authentication process. Possible enum values:

  • `SUCCESS`: 3DS authentication was successful and the transaction is considered authenticated.
  • `DECLINE`: 3DS authentication was attempted but was unsuccessful — i.e., the issuer declined to authenticate the cardholder; note that Lithic populates this value on a best-effort basis based on common data across the 3DS authentication and ASA data elements.
  • `ATTEMPTS`: 3DS authentication was attempted but full authentication did not occur. A proof of attempted authenticated is provided by the merchant.
  • `NONE`: 3DS authentication was not performed on the transaction.
const (
	TransactionCardholderAuthenticationAuthenticationResultAttempts TransactionCardholderAuthenticationAuthenticationResult = "ATTEMPTS"
	TransactionCardholderAuthenticationAuthenticationResultDecline  TransactionCardholderAuthenticationAuthenticationResult = "DECLINE"
	TransactionCardholderAuthenticationAuthenticationResultNone     TransactionCardholderAuthenticationAuthenticationResult = "NONE"
	TransactionCardholderAuthenticationAuthenticationResultSuccess  TransactionCardholderAuthenticationAuthenticationResult = "SUCCESS"
)

type TransactionCardholderAuthenticationDecisionMadeBy added in v0.8.0 

type TransactionCardholderAuthenticationDecisionMadeBy string

Indicator for which party made the 3DS authentication decision. Possible enum values:

  • `NETWORK`: A networks tand-in service decided on the outcome; for token authentications (as indicated in the `liability_shift` attribute), this is the default value
  • `LITHIC_DEFAULT`: A default decision was made by Lithic, without running a rules-based authentication; this value will be set on card programs that do not participate in one of our two 3DS product tiers
  • `LITHIC_RULES`: A rules-based authentication was conducted by Lithic and Lithic decided on the outcome
  • `CUSTOMER_ENDPOINT`: Lithic customer decided on the outcome based on a real-time request sent to a configured endpoint
  • `UNKNOWN`: Data on which party decided is unavailable
const (
	TransactionCardholderAuthenticationDecisionMadeByCustomerEndpoint TransactionCardholderAuthenticationDecisionMadeBy = "CUSTOMER_ENDPOINT"
	TransactionCardholderAuthenticationDecisionMadeByLithicDefault    TransactionCardholderAuthenticationDecisionMadeBy = "LITHIC_DEFAULT"
	TransactionCardholderAuthenticationDecisionMadeByLithicRules      TransactionCardholderAuthenticationDecisionMadeBy = "LITHIC_RULES"
	TransactionCardholderAuthenticationDecisionMadeByNetwork          TransactionCardholderAuthenticationDecisionMadeBy = "NETWORK"
	TransactionCardholderAuthenticationDecisionMadeByUnknown          TransactionCardholderAuthenticationDecisionMadeBy = "UNKNOWN"
)

type TransactionCardholderAuthenticationLiabilityShift 

type TransactionCardholderAuthenticationLiabilityShift string

Indicates whether chargeback liability shift applies to the transaction. Possible enum values:

  • `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
  • `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
  • `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
  • `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated cryptography, possibly recurring. Chargeback liability shift to the issuer applies.
const (
	TransactionCardholderAuthenticationLiabilityShift3DSAuthenticated   TransactionCardholderAuthenticationLiabilityShift = "3DS_AUTHENTICATED"
	TransactionCardholderAuthenticationLiabilityShiftAcquirerExemption  TransactionCardholderAuthenticationLiabilityShift = "ACQUIRER_EXEMPTION"
	TransactionCardholderAuthenticationLiabilityShiftNone               TransactionCardholderAuthenticationLiabilityShift = "NONE"
	TransactionCardholderAuthenticationLiabilityShiftTokenAuthenticated TransactionCardholderAuthenticationLiabilityShift = "TOKEN_AUTHENTICATED"
)

type TransactionCardholderAuthenticationVerificationAttempted 

type TransactionCardholderAuthenticationVerificationAttempted string

Verification attempted values:

  • `APP_LOGIN`: Out-of-band login verification was attempted by the ACS.
  • `BIOMETRIC`: Out-of-band biometric verification was attempted by the ACS.
  • `NONE`: No cardholder verification was attempted by the Access Control Server (e.g. frictionless 3-D Secure flow, no 3-D Secure, or stand-in Risk Based Analysis).
  • `OTHER`: Other method was used by the ACS to verify the cardholder (e.g. Mastercard Identity Check Express, recurring transactions, etc.)
  • `OTP`: One-time password verification was attempted by the ACS.
const (
	TransactionCardholderAuthenticationVerificationAttemptedAppLogin  TransactionCardholderAuthenticationVerificationAttempted = "APP_LOGIN"
	TransactionCardholderAuthenticationVerificationAttemptedBiometric TransactionCardholderAuthenticationVerificationAttempted = "BIOMETRIC"
	TransactionCardholderAuthenticationVerificationAttemptedNone      TransactionCardholderAuthenticationVerificationAttempted = "NONE"
	TransactionCardholderAuthenticationVerificationAttemptedOther     TransactionCardholderAuthenticationVerificationAttempted = "OTHER"
	TransactionCardholderAuthenticationVerificationAttemptedOtp       TransactionCardholderAuthenticationVerificationAttempted = "OTP"
)

type TransactionCardholderAuthenticationVerificationResult 

type TransactionCardholderAuthenticationVerificationResult string

This field partially maps to the `transStatus` field in the [EMVCo 3-D Secure specification](https://www.emvco.com/emv-technologies/3d-secure/) and Mastercard SPA2 AAV leading indicators.

Verification result values:

  • `CANCELLED`: Authentication/Account verification could not be performed, `transStatus = U`.
  • `FAILED`: Transaction was not authenticated. `transStatus = N`, note: the utilization of exemptions could also result in `transStatus = N`, inspect the `acquirer_exemption` field for more information.
  • `FRICTIONLESS`: Attempts processing performed, the transaction was not authenticated, but a proof of attempted authentication/verification is provided. `transStatus = A` and the leading AAV indicator was one of {`kE`, `kF`, `kQ`}.
  • `NOT_ATTEMPTED`: A 3-D Secure flow was not applied to this transaction. Leading AAV indicator was one of {`kN`, `kX`} or no AAV was provided for the transaction.
  • `REJECTED`: Authentication/Account Verification rejected; `transStatus = R`. Issuer is rejecting authentication/verification and requests that authorization not be attempted.
  • `SUCCESS`: Authentication verification successful. `transStatus = Y` and leading AAV indicator for the transaction was one of {`kA`, `kB`, `kC`, `kD`, `kO`, `kP`, `kR`, `kS`}.

Note that the following `transStatus` values are not represented by this field:

- `C`: Challenge Required - `D`: Challenge Required; decoupled authentication confirmed - `I`: Informational only - `S`: Challenge using Secure Payment Confirmation (SPC) 

const (
	TransactionCardholderAuthenticationVerificationResultCancelled    TransactionCardholderAuthenticationVerificationResult = "CANCELLED"
	TransactionCardholderAuthenticationVerificationResultFailed       TransactionCardholderAuthenticationVerificationResult = "FAILED"
	TransactionCardholderAuthenticationVerificationResultFrictionless TransactionCardholderAuthenticationVerificationResult = "FRICTIONLESS"
	TransactionCardholderAuthenticationVerificationResultNotAttempted TransactionCardholderAuthenticationVerificationResult = "NOT_ATTEMPTED"
	TransactionCardholderAuthenticationVerificationResultRejected     TransactionCardholderAuthenticationVerificationResult = "REJECTED"
	TransactionCardholderAuthenticationVerificationResultSuccess      TransactionCardholderAuthenticationVerificationResult = "SUCCESS"
)

type TransactionEvent added in v0.5.0 

type TransactionEvent struct {
	// Globally unique identifier.
	Token string `json:"token,required" format:"uuid"`
	// Amount of the transaction event (in cents), including any acquirer fees.
	Amount int64 `json:"amount,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"`
	// `APPROVED` or decline reason.
	//
	// Result types:
	//
	//   - `ACCOUNT_STATE_TRANSACTION_FAIL` - Contact
	//     [support@lithic.com](mailto:support@lithic.com).
	//   - `APPROVED` - Transaction is approved.
	//   - `BANK_CONNECTION_ERROR` - Please reconnect a funding source.
	//   - `BANK_NOT_VERIFIED` - Please confirm the funding source.
	//   - `CARD_CLOSED` - Card state was closed at the time of authorization.
	//   - `CARD_PAUSED` - Card state was paused at the time of authorization.
	//   - `FRAUD_ADVICE` - Transaction declined due to risk.
	//   - `GLOBAL_TRANSACTION_LIMIT` - Platform spend limit exceeded, contact
	//     [support@lithic.com](mailto:support@lithic.com).
	//   - `GLOBAL_WEEKLY_LIMIT` - Platform spend limit exceeded, contact
	//     [support@lithic.com](mailto:support@lithic.com).
	//   - `GLOBAL_MONTHLY_LIMIT` - Platform spend limit exceeded, contact
	//     [support@lithic.com](mailto:support@lithic.com).
	//   - `INACTIVE_ACCOUNT` - Account is inactive. Contact
	//     [support@lithic.com](mailto:support@lithic.com).
	//   - `INCORRECT_PIN` - PIN verification failed.
	//   - `INVALID_CARD_DETAILS` - Incorrect CVV or expiry date.
	//   - `INSUFFICIENT_FUNDS` - Please ensure the funding source is connected and up to
	//     date.
	//   - `MERCHANT_BLACKLIST` - This merchant is disallowed on the platform.
	//   - `SINGLE_USE_RECHARGED` - Single use card attempted multiple times.
	//   - `SWITCH_INOPERATIVE_ADVICE` - Network error, re-attempt the transaction.
	//   - `UNAUTHORIZED_MERCHANT` - Merchant locked card attempted at different
	//     merchant.
	//   - `UNKNOWN_HOST_TIMEOUT` - Network error, re-attempt the transaction.
	//   - `USER_TRANSACTION_LIMIT` - User-set spend limit exceeded.
	Result TransactionEventsResult `json:"result,required"`
	// Event types:
	//
	//   - `AUTHORIZATION` - Authorize a transaction.
	//   - `AUTHORIZATION_ADVICE` - Advice on a transaction.
	//   - `AUTHORIZATION_EXPIRY` - Authorization has expired and reversed by Lithic.
	//   - `AUTHORIZATION_REVERSAL` - Authorization was reversed by the merchant.
	//   - `BALANCE_INQUIRY` - A balance inquiry (typically a $0 authorization) has
	//     occurred on a card.
	//   - `CLEARING` - Transaction is settled.
	//   - `CORRECTION_DEBIT` - Manual transaction correction (Debit).
	//   - `CORRECTION_CREDIT` - Manual transaction correction (Credit).
	//   - `CREDIT_AUTHORIZATION` - A refund or credit authorization from a merchant.
	//   - `CREDIT_AUTHORIZATION_ADVICE` - A credit authorization was approved on your
	//     behalf by the network.
	//   - `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit funds without
	//     additional clearing.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or
	//     credit funds without additional clearing.
	//   - `RETURN` - A refund has been processed on the transaction.
	//   - `RETURN_REVERSAL` - A refund has been reversed (e.g., when a merchant reverses
	//     an incorrect refund).
	Type TransactionEventsType `json:"type,required"`
	JSON transactionEventJSON  `json:"-"`
}

A single card transaction may include multiple events that affect the transaction state and lifecycle.

func (*TransactionEvent) UnmarshalJSON added in v0.5.0 

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

type TransactionEventsDetailedResult added in v0.19.0 

type TransactionEventsDetailedResult string
const (
	TransactionEventsDetailedResultAccountDailySpendLimitExceeded              TransactionEventsDetailedResult = "ACCOUNT_DAILY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountInactive                             TransactionEventsDetailedResult = "ACCOUNT_INACTIVE"
	TransactionEventsDetailedResultAccountLifetimeSpendLimitExceeded           TransactionEventsDetailedResult = "ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountMonthlySpendLimitExceeded            TransactionEventsDetailedResult = "ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultAccountUnderReview                          TransactionEventsDetailedResult = "ACCOUNT_UNDER_REVIEW"
	TransactionEventsDetailedResultAddressIncorrect                            TransactionEventsDetailedResult = "ADDRESS_INCORRECT"
	TransactionEventsDetailedResultApproved                                    TransactionEventsDetailedResult = "APPROVED"
	TransactionEventsDetailedResultAuthRuleAllowedCountry                      TransactionEventsDetailedResult = "AUTH_RULE_ALLOWED_COUNTRY"
	TransactionEventsDetailedResultAuthRuleAllowedMcc                          TransactionEventsDetailedResult = "AUTH_RULE_ALLOWED_MCC"
	TransactionEventsDetailedResultAuthRuleBlockedCountry                      TransactionEventsDetailedResult = "AUTH_RULE_BLOCKED_COUNTRY"
	TransactionEventsDetailedResultAuthRuleBlockedMcc                          TransactionEventsDetailedResult = "AUTH_RULE_BLOCKED_MCC"
	TransactionEventsDetailedResultCardClosed                                  TransactionEventsDetailedResult = "CARD_CLOSED"
	TransactionEventsDetailedResultCardCryptogramValidationFailure             TransactionEventsDetailedResult = "CARD_CRYPTOGRAM_VALIDATION_FAILURE"
	TransactionEventsDetailedResultCardExpired                                 TransactionEventsDetailedResult = "CARD_EXPIRED"
	TransactionEventsDetailedResultCardExpiryDateIncorrect                     TransactionEventsDetailedResult = "CARD_EXPIRY_DATE_INCORRECT"
	TransactionEventsDetailedResultCardInvalid                                 TransactionEventsDetailedResult = "CARD_INVALID"
	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"
	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"
	TransactionEventsDetailedResultProgramCardSpendLimitExceeded               TransactionEventsDetailedResult = "PROGRAM_CARD_SPEND_LIMIT_EXCEEDED"
	TransactionEventsDetailedResultProgramSuspended                            TransactionEventsDetailedResult = "PROGRAM_SUSPENDED"
	TransactionEventsDetailedResultProgramUsageRestriction                     TransactionEventsDetailedResult = "PROGRAM_USAGE_RESTRICTION"
	TransactionEventsDetailedResultReversalUnmatched                           TransactionEventsDetailedResult = "REVERSAL_UNMATCHED"
	TransactionEventsDetailedResultSecurityViolation                           TransactionEventsDetailedResult = "SECURITY_VIOLATION"
	TransactionEventsDetailedResultSingleUseCardReattempted                    TransactionEventsDetailedResult = "SINGLE_USE_CARD_REATTEMPTED"
	TransactionEventsDetailedResultTransactionInvalid                          TransactionEventsDetailedResult = "TRANSACTION_INVALID"
	TransactionEventsDetailedResultTransactionNotPermittedToAcquirerOrTerminal TransactionEventsDetailedResult = "TRANSACTION_NOT_PERMITTED_TO_ACQUIRER_OR_TERMINAL"
	TransactionEventsDetailedResultTransactionNotPermittedToIssuerOrCardholder TransactionEventsDetailedResult = "TRANSACTION_NOT_PERMITTED_TO_ISSUER_OR_CARDHOLDER"
	TransactionEventsDetailedResultTransactionPreviouslyCompleted              TransactionEventsDetailedResult = "TRANSACTION_PREVIOUSLY_COMPLETED"
	TransactionEventsDetailedResultUnauthorizedMerchant                        TransactionEventsDetailedResult = "UNAUTHORIZED_MERCHANT"
)

type TransactionEventsResult 

type TransactionEventsResult string

`APPROVED` or decline reason.

Result types:

  • `ACCOUNT_STATE_TRANSACTION_FAIL` - Contact [support@lithic.com](mailto:support@lithic.com).
  • `APPROVED` - Transaction is approved.
  • `BANK_CONNECTION_ERROR` - Please reconnect a funding source.
  • `BANK_NOT_VERIFIED` - Please confirm the funding source.
  • `CARD_CLOSED` - Card state was closed at the time of authorization.
  • `CARD_PAUSED` - Card state was paused at the time of authorization.
  • `FRAUD_ADVICE` - Transaction declined due to risk.
  • `GLOBAL_TRANSACTION_LIMIT` - Platform spend limit exceeded, contact [support@lithic.com](mailto:support@lithic.com).
  • `GLOBAL_WEEKLY_LIMIT` - Platform spend limit exceeded, contact [support@lithic.com](mailto:support@lithic.com).
  • `GLOBAL_MONTHLY_LIMIT` - Platform spend limit exceeded, contact [support@lithic.com](mailto:support@lithic.com).
  • `INACTIVE_ACCOUNT` - Account is inactive. Contact [support@lithic.com](mailto:support@lithic.com).
  • `INCORRECT_PIN` - PIN verification failed.
  • `INVALID_CARD_DETAILS` - Incorrect CVV or expiry date.
  • `INSUFFICIENT_FUNDS` - Please ensure the funding source is connected and up to date.
  • `MERCHANT_BLACKLIST` - This merchant is disallowed on the platform.
  • `SINGLE_USE_RECHARGED` - Single use card attempted multiple times.
  • `SWITCH_INOPERATIVE_ADVICE` - Network error, re-attempt the transaction.
  • `UNAUTHORIZED_MERCHANT` - Merchant locked card attempted at different merchant.
  • `UNKNOWN_HOST_TIMEOUT` - Network error, re-attempt the transaction.
  • `USER_TRANSACTION_LIMIT` - User-set spend limit exceeded.
const (
	TransactionEventsResultAccountStateTransaction TransactionEventsResult = "ACCOUNT_STATE_TRANSACTION"
	TransactionEventsResultApproved                TransactionEventsResult = "APPROVED"
	TransactionEventsResultBankConnectionError     TransactionEventsResult = "BANK_CONNECTION_ERROR"
	TransactionEventsResultBankNotVerified         TransactionEventsResult = "BANK_NOT_VERIFIED"
	TransactionEventsResultCardClosed              TransactionEventsResult = "CARD_CLOSED"
	TransactionEventsResultCardPaused              TransactionEventsResult = "CARD_PAUSED"
	TransactionEventsResultFraudAdvice             TransactionEventsResult = "FRAUD_ADVICE"
	TransactionEventsResultGlobalMonthlyLimit      TransactionEventsResult = "GLOBAL_MONTHLY_LIMIT"
	TransactionEventsResultGlobalTransactionLimit  TransactionEventsResult = "GLOBAL_TRANSACTION_LIMIT"
	TransactionEventsResultGlobalWeeklyLimit       TransactionEventsResult = "GLOBAL_WEEKLY_LIMIT"
	TransactionEventsResultInactiveAccount         TransactionEventsResult = "INACTIVE_ACCOUNT"
	TransactionEventsResultIncorrectPin            TransactionEventsResult = "INCORRECT_PIN"
	TransactionEventsResultInsufficientFunds       TransactionEventsResult = "INSUFFICIENT_FUNDS"
	TransactionEventsResultInvalidCardDetails      TransactionEventsResult = "INVALID_CARD_DETAILS"
	TransactionEventsResultMerchantBlacklist       TransactionEventsResult = "MERCHANT_BLACKLIST"
	TransactionEventsResultSingleUseRecharged      TransactionEventsResult = "SINGLE_USE_RECHARGED"
	TransactionEventsResultSwitchInoperativeAdvice TransactionEventsResult = "SWITCH_INOPERATIVE_ADVICE"
	TransactionEventsResultUnauthorizedMerchant    TransactionEventsResult = "UNAUTHORIZED_MERCHANT"
	TransactionEventsResultUnknownHostTimeout      TransactionEventsResult = "UNKNOWN_HOST_TIMEOUT"
	TransactionEventsResultUserTransactionLimit    TransactionEventsResult = "USER_TRANSACTION_LIMIT"
)

type TransactionEventsType 

type TransactionEventsType string

Event types:

  • `AUTHORIZATION` - Authorize a transaction.
  • `AUTHORIZATION_ADVICE` - Advice on a transaction.
  • `AUTHORIZATION_EXPIRY` - Authorization has expired and reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` - Authorization was reversed by the merchant.
  • `BALANCE_INQUIRY` - A balance inquiry (typically a $0 authorization) has occurred on a card.
  • `CLEARING` - Transaction is settled.
  • `CORRECTION_DEBIT` - Manual transaction correction (Debit).
  • `CORRECTION_CREDIT` - Manual transaction correction (Credit).
  • `CREDIT_AUTHORIZATION` - A refund or credit authorization from a merchant.
  • `CREDIT_AUTHORIZATION_ADVICE` - A credit authorization was approved on your behalf by the network.
  • `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit funds without additional clearing.
  • `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or credit funds without additional clearing.
  • `RETURN` - A refund has been processed on the transaction.
  • `RETURN_REVERSAL` - A refund has been reversed (e.g., when a merchant reverses an incorrect refund).
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"
	TransactionEventsTypeVoid                         TransactionEventsType = "VOID"
)

type TransactionListParams 

type TransactionListParams struct {
	// Filters for transactions associated with a specific account.
	AccountToken param.Field[string] `query:"account_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created after the specified time
	// will be included. UTC time zone.
	Begin param.Field[time.Time] `query:"begin" format:"date-time"`
	// Filters for transactions associated with a specific card.
	CardToken param.Field[string] `query:"card_token" format:"uuid"`
	// Date string in RFC 3339 format. Only entries created before the specified time
	// will be included. UTC time zone.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// A cursor representing an item's token before which a page of results should end.
	// Used to retrieve the previous page of results before this item.
	EndingBefore param.Field[string] `query:"ending_before"`
	// Page size (for pagination).
	PageSize param.Field[int64] `query:"page_size"`
	// Filters for transactions using transaction result field. Can filter by
	// `APPROVED`, and `DECLINED`.
	Result param.Field[TransactionListParamsResult] `query:"result"`
	// A cursor representing an item's token after which a page of results should
	// begin. Used to retrieve the next page of results after this item.
	StartingAfter param.Field[string] `query:"starting_after"`
}

func (TransactionListParams) URLQuery 

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

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

type TransactionListParamsResult 

type TransactionListParamsResult string

Filters for transactions using transaction result field. Can filter by `APPROVED`, and `DECLINED`. 

const (
	TransactionListParamsResultApproved TransactionListParamsResult = "APPROVED"
	TransactionListParamsResultDeclined TransactionListParamsResult = "DECLINED"
)

type TransactionMerchant 

type TransactionMerchant struct {
	// Unique identifier to identify the payment card acceptor.
	AcceptorID string `json:"acceptor_id"`
	// City of card acceptor.
	City string `json:"city"`
	// Uppercase country of card acceptor (see ISO 8583 specs).
	Country string `json:"country"`
	// Short description of card acceptor.
	Descriptor string `json:"descriptor"`
	// Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
	// used to classify a business by the types of goods or services it provides.
	Mcc string `json:"mcc"`
	// Geographic state of card acceptor (see ISO 8583 specs).
	State string                  `json:"state"`
	JSON  transactionMerchantJSON `json:"-"`
}

func (*TransactionMerchant) UnmarshalJSON 

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

type TransactionNetwork 

type TransactionNetwork string

Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`, `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider. 

const (
	TransactionNetworkInterlink  TransactionNetwork = "INTERLINK"
	TransactionNetworkMaestro    TransactionNetwork = "MAESTRO"
	TransactionNetworkMastercard TransactionNetwork = "MASTERCARD"
	TransactionNetworkUnknown    TransactionNetwork = "UNKNOWN"
	TransactionNetworkVisa       TransactionNetwork = "VISA"
)

type TransactionResult 

type TransactionResult string

`APPROVED` or decline reason. See Event result types 

const (
	TransactionResultAccountStateTransaction TransactionResult = "ACCOUNT_STATE_TRANSACTION"
	TransactionResultApproved                TransactionResult = "APPROVED"
	TransactionResultBankConnectionError     TransactionResult = "BANK_CONNECTION_ERROR"
	TransactionResultBankNotVerified         TransactionResult = "BANK_NOT_VERIFIED"
	TransactionResultCardClosed              TransactionResult = "CARD_CLOSED"
	TransactionResultCardPaused              TransactionResult = "CARD_PAUSED"
	TransactionResultFraudAdvice             TransactionResult = "FRAUD_ADVICE"
	TransactionResultGlobalMonthlyLimit      TransactionResult = "GLOBAL_MONTHLY_LIMIT"
	TransactionResultGlobalTransactionLimit  TransactionResult = "GLOBAL_TRANSACTION_LIMIT"
	TransactionResultGlobalWeeklyLimit       TransactionResult = "GLOBAL_WEEKLY_LIMIT"
	TransactionResultInactiveAccount         TransactionResult = "INACTIVE_ACCOUNT"
	TransactionResultIncorrectPin            TransactionResult = "INCORRECT_PIN"
	TransactionResultInsufficientFunds       TransactionResult = "INSUFFICIENT_FUNDS"
	TransactionResultInvalidCardDetails      TransactionResult = "INVALID_CARD_DETAILS"
	TransactionResultMerchantBlacklist       TransactionResult = "MERCHANT_BLACKLIST"
	TransactionResultSingleUseRecharged      TransactionResult = "SINGLE_USE_RECHARGED"
	TransactionResultSwitchInoperativeAdvice TransactionResult = "SWITCH_INOPERATIVE_ADVICE"
	TransactionResultUnauthorizedMerchant    TransactionResult = "UNAUTHORIZED_MERCHANT"
	TransactionResultUnknownHostTimeout      TransactionResult = "UNKNOWN_HOST_TIMEOUT"
	TransactionResultUserTransactionLimit    TransactionResult = "USER_TRANSACTION_LIMIT"
)

type TransactionService 

type TransactionService struct {
	Options []option.RequestOption
}

TransactionService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionService method instead.

func NewTransactionService 

func NewTransactionService(opts ...option.RequestOption) (r *TransactionService)

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

func (*TransactionService) Get 

func (r *TransactionService) Get(ctx context.Context, transactionToken string, opts ...option.RequestOption) (res *Transaction, err error)

Get specific card transaction.

func (*TransactionService) List 

func (r *TransactionService) List(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) (res *shared.CursorPage[Transaction], err error)

List card transactions.

func (*TransactionService) ListAutoPaging 

func (r *TransactionService) ListAutoPaging(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) *shared.CursorPageAutoPager[Transaction]

List card transactions.

func (*TransactionService) SimulateAuthorization 

func (r *TransactionService) SimulateAuthorization(ctx context.Context, body TransactionSimulateAuthorizationParams, opts ...option.RequestOption) (res *TransactionSimulateAuthorizationResponse, err error)

Simulates an authorization request from the payment network as if it came from a merchant acquirer. If you're configured for ASA, simulating auths requires your ASA client to be set up properly (respond with a valid JSON to the ASA request). For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. This limit can be modified via the [update account](https://docs.lithic.com/reference/patchaccountbytoken) endpoint.

func (*TransactionService) SimulateAuthorizationAdvice 

func (r *TransactionService) SimulateAuthorizationAdvice(ctx context.Context, body TransactionSimulateAuthorizationAdviceParams, opts ...option.RequestOption) (res *TransactionSimulateAuthorizationAdviceResponse, err error)

Simulates an authorization advice request from the payment network as if it came from a merchant acquirer. An authorization advice request changes the amount of the transaction.

func (*TransactionService) SimulateClearing 

func (r *TransactionService) SimulateClearing(ctx context.Context, body TransactionSimulateClearingParams, opts ...option.RequestOption) (res *TransactionSimulateClearingResponse, err error)

Clears an existing authorization. After this event, the transaction is no longer pending.

If no `amount` is supplied to this endpoint, the amount of the transaction will be captured. Any transaction that has any amount completed at all do not have access to this behavior.

func (*TransactionService) SimulateCreditAuthorization 

func (r *TransactionService) SimulateCreditAuthorization(ctx context.Context, body TransactionSimulateCreditAuthorizationParams, opts ...option.RequestOption) (res *TransactionSimulateCreditAuthorizationResponse, err error)

Simulates a credit authorization advice message from the payment network. This message indicates that a credit authorization was approved on your behalf by the network.

func (*TransactionService) SimulateReturn 

func (r *TransactionService) SimulateReturn(ctx context.Context, body TransactionSimulateReturnParams, opts ...option.RequestOption) (res *TransactionSimulateReturnResponse, err error)

Returns (aka refunds) an amount back to a card. Returns are cleared immediately and do not spend time in a `PENDING` state.

func (*TransactionService) SimulateReturnReversal 

func (r *TransactionService) SimulateReturnReversal(ctx context.Context, body TransactionSimulateReturnReversalParams, opts ...option.RequestOption) (res *TransactionSimulateReturnReversalResponse, err error)

Voids a settled credit transaction – i.e., a transaction with a negative amount and `SETTLED` status. These can be credit authorizations that have already cleared or financial credit authorizations.

func (*TransactionService) SimulateVoid 

func (r *TransactionService) SimulateVoid(ctx context.Context, body TransactionSimulateVoidParams, opts ...option.RequestOption) (res *TransactionSimulateVoidResponse, err error)

Voids an existing, uncleared (aka pending) authorization. If amount is not sent the full amount will be voided. Cannot be used on partially completed transactions, but can be used on partially voided transactions. _Note that simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon._

type TransactionSimulateAuthorizationAdviceParams 

type TransactionSimulateAuthorizationAdviceParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to authorize. This amount will override the transaction's
	// amount that was originally set by /v1/simulate/authorize.
	Amount param.Field[int64] `json:"amount,required"`
}

func (TransactionSimulateAuthorizationAdviceParams) MarshalJSON 

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

type TransactionSimulateAuthorizationAdviceResponse 

type TransactionSimulateAuthorizationAdviceResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                             `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateAuthorizationAdviceResponseJSON `json:"-"`
}

func (*TransactionSimulateAuthorizationAdviceResponse) UnmarshalJSON 

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

type TransactionSimulateAuthorizationParams 

type TransactionSimulateAuthorizationParams struct {
	// Amount (in cents) to authorize. For credit authorizations and financial credit
	// authorizations, any value entered will be converted into a negative amount in
	// the simulated transaction. For example, entering 100 in this field will appear
	// as a -100 amount in the transaction. For balance inquiries, this field must be
	// set to 0.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc"`
	// Unique identifier to identify the payment card acceptor.
	MerchantAcceptorID param.Field[string] `json:"merchant_acceptor_id"`
	// Amount of the transaction to be simulated in currency specified in
	// merchant_currency, including any acquirer fees.
	MerchantAmount param.Field[int64] `json:"merchant_amount"`
	// 3-digit alphabetic ISO 4217 currency code.
	MerchantCurrency param.Field[string] `json:"merchant_currency"`
	// Set to true if the terminal is capable of partial approval otherwise false.
	// Partial approval is when part of a transaction is approved and another payment
	// must be used for the remainder.
	PartialApprovalCapable param.Field[bool] `json:"partial_approval_capable"`
	// Type of event to simulate.
	//
	//   - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
	//     clearing step is required to settle the transaction.
	//   - `BALANCE_INQUIRY` is a $0 authorization that includes a request for the
	//     balance held on the card, and is most typically seen when a cardholder
	//     requests to view a card's balance at an ATM.
	//   - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
	//     a refund or credit, meaning a subsequent clearing step is required to settle
	//     the transaction.
	//   - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
	//     funds immediately (such as an ATM withdrawal), and no subsequent clearing is
	//     required to settle the transaction.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
	//     to credit funds immediately, and no subsequent clearing is required to settle
	//     the transaction.
	Status param.Field[TransactionSimulateAuthorizationParamsStatus] `json:"status"`
}

func (TransactionSimulateAuthorizationParams) MarshalJSON 

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

type TransactionSimulateAuthorizationParamsStatus 

type TransactionSimulateAuthorizationParamsStatus string

Type of event to simulate.

  • `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent clearing step is required to settle the transaction.
  • `BALANCE_INQUIRY` is a $0 authorization that includes a request for the balance held on the card, and is most typically seen when a cardholder requests to view a card's balance at an ATM.
  • `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize a refund or credit, meaning a subsequent clearing step is required to settle the transaction.
  • `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit funds immediately (such as an ATM withdrawal), and no subsequent clearing is required to settle the transaction.
  • `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant to credit funds immediately, and no subsequent clearing is required to settle the transaction.
const (
	TransactionSimulateAuthorizationParamsStatusAuthorization                TransactionSimulateAuthorizationParamsStatus = "AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusBalanceInquiry               TransactionSimulateAuthorizationParamsStatus = "BALANCE_INQUIRY"
	TransactionSimulateAuthorizationParamsStatusCreditAuthorization          TransactionSimulateAuthorizationParamsStatus = "CREDIT_AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusFinancialAuthorization       TransactionSimulateAuthorizationParamsStatus = "FINANCIAL_AUTHORIZATION"
	TransactionSimulateAuthorizationParamsStatusFinancialCreditAuthorization TransactionSimulateAuthorizationParamsStatus = "FINANCIAL_CREDIT_AUTHORIZATION"
)

type TransactionSimulateAuthorizationResponse 

type TransactionSimulateAuthorizationResponse struct {
	// A unique token to reference this transaction with later calls to void or clear
	// the authorization.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                       `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateAuthorizationResponseJSON `json:"-"`
}

func (*TransactionSimulateAuthorizationResponse) UnmarshalJSON 

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

type TransactionSimulateClearingParams 

type TransactionSimulateClearingParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to complete. Typically this will match the original
	// authorization, but may be more or less.
	//
	// If no amount is supplied to this endpoint, the amount of the transaction will be
	// captured. Any transaction that has any amount completed at all do not have
	// access to this behavior.
	Amount param.Field[int64] `json:"amount"`
}

func (TransactionSimulateClearingParams) MarshalJSON 

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

type TransactionSimulateClearingResponse 

type TransactionSimulateClearingResponse struct {
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                  `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateClearingResponseJSON `json:"-"`
}

func (*TransactionSimulateClearingResponse) UnmarshalJSON 

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

type TransactionSimulateCreditAuthorizationParams 

type TransactionSimulateCreditAuthorizationParams struct {
	// Amount (in cents). Any value entered will be converted into a negative amount in
	// the simulated transaction. For example, entering 100 in this field will appear
	// as a -100 amount in the transaction.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
	// Merchant category code for the transaction to be simulated. A four-digit number
	// listed in ISO 18245. Supported merchant category codes can be found
	// [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
	Mcc param.Field[string] `json:"mcc"`
	// Unique identifier to identify the payment card acceptor.
	MerchantAcceptorID param.Field[string] `json:"merchant_acceptor_id"`
}

func (TransactionSimulateCreditAuthorizationParams) MarshalJSON 

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

type TransactionSimulateCreditAuthorizationResponse 

type TransactionSimulateCreditAuthorizationResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                             `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateCreditAuthorizationResponseJSON `json:"-"`
}

func (*TransactionSimulateCreditAuthorizationResponse) UnmarshalJSON 

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

type TransactionSimulateReturnParams 

type TransactionSimulateReturnParams struct {
	// Amount (in cents) to authorize.
	Amount param.Field[int64] `json:"amount,required"`
	// Merchant descriptor.
	Descriptor param.Field[string] `json:"descriptor,required"`
	// Sixteen digit card number.
	Pan param.Field[string] `json:"pan,required"`
}

func (TransactionSimulateReturnParams) MarshalJSON 

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

type TransactionSimulateReturnResponse 

type TransactionSimulateReturnResponse struct {
	// A unique token to reference this transaction.
	Token string `json:"token" format:"uuid"`
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateReturnResponseJSON `json:"-"`
}

func (*TransactionSimulateReturnResponse) UnmarshalJSON 

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

type TransactionSimulateReturnReversalParams 

type TransactionSimulateReturnReversalParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
}

func (TransactionSimulateReturnReversalParams) MarshalJSON 

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

type TransactionSimulateReturnReversalResponse 

type TransactionSimulateReturnReversalResponse struct {
	// Debugging request ID to share with Lithic Support team.
	DebuggingRequestID string                                        `json:"debugging_request_id" format:"uuid"`
	JSON               transactionSimulateReturnReversalResponseJSON `json:"-"`
}

func (*TransactionSimulateReturnReversalResponse) UnmarshalJSON 

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

type TransactionSimulateVoidParams 

type TransactionSimulateVoidParams struct {
	// The transaction token returned from the /v1/simulate/authorize response.
	Token param.Field[string] `json:"token,required" format:"uuid"`
	// Amount (in cents) to void. Typically this will match the original authorization,
	// but may be less.
	Amount param.Field[int64] `json:"amount"`
	// Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
	//
	//   - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
	//     by Lithic.
	//   - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
	Type param.Field[TransactionSimulateVoidParamsType] `json:"type"`
}

func (TransactionSimulateVoidParams) MarshalJSON 

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

type TransactionSimulateVoidParamsType 

type TransactionSimulateVoidParamsType string

Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.

  • `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
const (
	TransactionSimulateVoidParamsTypeAuthorizationExpiry   TransactionSimulateVoidParamsType = "AUTHORIZATION_EXPIRY"
	TransactionSimulateVoidParamsTypeAuthorizationReversal TransactionSimulateVoidParamsType = "AUTHORIZATION_REVERSAL"
)

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 types:

  • `DECLINED` - The transaction was declined.
  • `EXPIRED` - Lithic reversed the authorization as it has passed its expiration time.
  • `PENDING` - Authorization is pending completion from the merchant.
  • `SETTLED` - The transaction is complete.
  • `VOIDED` - The merchant has voided the previously pending authorization.
const (
	TransactionStatusBounced  TransactionStatus = "BOUNCED"
	TransactionStatusDeclined TransactionStatus = "DECLINED"
	TransactionStatusExpired  TransactionStatus = "EXPIRED"
	TransactionStatusPending  TransactionStatus = "PENDING"
	TransactionStatusSettled  TransactionStatus = "SETTLED"
	TransactionStatusVoided   TransactionStatus = "VOIDED"
)

type Transfer 

type Transfer struct {
	// Globally unique identifier for the transfer event.
	Token string `json:"token" format:"uuid"`
	// Status types:
	//
	//   - `TRANSFER` - Internal transfer of funds between financial accounts in your
	//     program.
	Category TransferCategory `json:"category"`
	// Date and time when the transfer occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// 3-digit alphabetic ISO 4217 code for the settling currency of the transaction.
	Currency string `json:"currency"`
	// A string that provides a description of the transfer; may be useful to display
	// to users.
	Descriptor string `json:"descriptor"`
	// A list of all financial events that have modified this trasnfer.
	Events []TransferEvent `json:"events"`
	// The updated balance of the sending financial account.
	FromBalance []Balance `json:"from_balance"`
	// Pending amount of the transaction in the currency's smallest unit (e.g., cents),
	// including any acquirer fees. The value of this field will go to zero over time
	// once the financial transaction is settled.
	PendingAmount int64 `json:"pending_amount"`
	// APPROVED transactions were successful while DECLINED transactions were declined
	// by user, Lithic, or the network.
	Result TransferResult `json:"result"`
	// Amount of the transaction that has been settled in the currency's smallest unit
	// (e.g., cents).
	SettledAmount int64 `json:"settled_amount"`
	// Status types:
	//
	// - `DECLINED` - The transfer was declined.
	// - `EXPIRED` - The transfer was held in pending for too long and expired.
	// - `PENDING` - The transfer is pending release from a hold.
	// - `SETTLED` - The transfer is completed.
	// - `VOIDED` - The transfer was reversed before it settled.
	Status TransferStatus `json:"status"`
	// The updated balance of the receiving financial account.
	ToBalance []Balance `json:"to_balance"`
	// Date and time when the financial transaction was last updated. UTC time zone.
	Updated time.Time    `json:"updated" format:"date-time"`
	JSON    transferJSON `json:"-"`
}

func (*Transfer) UnmarshalJSON 

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

type TransferCategory 

type TransferCategory string

Status types:

  • `TRANSFER` - Internal transfer of funds between financial accounts in your program.
const (
	TransferCategoryTransfer TransferCategory = "TRANSFER"
)

type TransferEvent added in v0.5.0 

type TransferEvent struct {
	// Globally unique identifier.
	Token string `json:"token" format:"uuid"`
	// Amount of the financial event that has been settled in the currency's smallest
	// unit (e.g., cents).
	Amount int64 `json:"amount"`
	// Date and time when the financial event occurred. UTC time zone.
	Created time.Time `json:"created" format:"date-time"`
	// APPROVED financial events were successful while DECLINED financial events were
	// declined by user, Lithic, or the network.
	Result TransferEventsResult `json:"result"`
	// Event types:
	//
	//   - `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to
	//     insufficient balance.
	//   - `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
	//   - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
	//     available balance.
	//   - `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
	//   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
	//     balance.
	//   - `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial
	//     Institution.
	//   - `AUTHORIZATION` - Authorize a card transaction.
	//   - `AUTHORIZATION_ADVICE` - Advice on a card transaction.
	//   - `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by
	//     Lithic.
	//   - `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
	//   - `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has
	//     occurred on a card.
	//   - `CLEARING` - Card Transaction is settled.
	//   - `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
	//   - `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
	//   - `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a
	//     merchant.
	//   - `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on
	//     your behalf by the network.
	//   - `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds
	//     without additional clearing.
	//   - `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or
	//     credit card funds without additional clearing.
	//   - `RETURN` - A card refund has been processed on the transaction.
	//   - `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant
	//     reverses an incorrect refund).
	//   - `TRANSFER` - Successful internal transfer of funds between financial accounts.
	//   - `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to
	//     insufficient balance of the sender.
	Type TransferEventsType `json:"type"`
	JSON transferEventJSON  `json:"-"`
}

func (*TransferEvent) UnmarshalJSON added in v0.5.0 

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

type TransferEventsResult 

type TransferEventsResult string

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

const (
	TransferEventsResultApproved TransferEventsResult = "APPROVED"
	TransferEventsResultDeclined TransferEventsResult = "DECLINED"
)

type TransferEventsType 

type TransferEventsType string

Event types:

  • `ACH_INSUFFICIENT_FUNDS` - Attempted ACH origination declined due to insufficient balance.
  • `ACH_ORIGINATION_PENDING` - ACH origination pending release from an ACH hold.
  • `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.
  • `ACH_RECEIPT_PENDING` - ACH receipt pending release from an ACH holder.
  • `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.
  • `ACH_RETURN` - ACH origination returned by the Receiving Depository Financial Institution.
  • `AUTHORIZATION` - Authorize a card transaction.
  • `AUTHORIZATION_ADVICE` - Advice on a card transaction.
  • `AUTHORIZATION_EXPIRY` - Card Authorization has expired and reversed by Lithic.
  • `AUTHORIZATION_REVERSAL` - Card Authorization was reversed by the merchant.
  • `BALANCE_INQUIRY` - A card balance inquiry (typically a $0 authorization) has occurred on a card.
  • `CLEARING` - Card Transaction is settled.
  • `CORRECTION_DEBIT` - Manual card transaction correction (Debit).
  • `CORRECTION_CREDIT` - Manual card transaction correction (Credit).
  • `CREDIT_AUTHORIZATION` - A refund or credit card authorization from a merchant.
  • `CREDIT_AUTHORIZATION_ADVICE` - A credit card authorization was approved on your behalf by the network.
  • `FINANCIAL_AUTHORIZATION` - A request from a merchant to debit card funds without additional clearing.
  • `FINANCIAL_CREDIT_AUTHORIZATION` - A request from a merchant to refund or credit card funds without additional clearing.
  • `RETURN` - A card refund has been processed on the transaction.
  • `RETURN_REVERSAL` - A card refund has been reversed (e.g., when a merchant reverses an incorrect refund).
  • `TRANSFER` - Successful internal transfer of funds between financial accounts.
  • `TRANSFER_INSUFFICIENT_FUNDS` - Declined internl transfer of funds due to insufficient balance of the sender.
const (
	TransferEventsTypeACHInsufficientFunds         TransferEventsType = "ACH_INSUFFICIENT_FUNDS"
	TransferEventsTypeACHOriginationPending        TransferEventsType = "ACH_ORIGINATION_PENDING"
	TransferEventsTypeACHOriginationReleased       TransferEventsType = "ACH_ORIGINATION_RELEASED"
	TransferEventsTypeACHReceiptPending            TransferEventsType = "ACH_RECEIPT_PENDING"
	TransferEventsTypeACHReceiptReleased           TransferEventsType = "ACH_RECEIPT_RELEASED"
	TransferEventsTypeACHReturn                    TransferEventsType = "ACH_RETURN"
	TransferEventsTypeAuthorization                TransferEventsType = "AUTHORIZATION"
	TransferEventsTypeAuthorizationAdvice          TransferEventsType = "AUTHORIZATION_ADVICE"
	TransferEventsTypeAuthorizationExpiry          TransferEventsType = "AUTHORIZATION_EXPIRY"
	TransferEventsTypeAuthorizationReversal        TransferEventsType = "AUTHORIZATION_REVERSAL"
	TransferEventsTypeBalanceInquiry               TransferEventsType = "BALANCE_INQUIRY"
	TransferEventsTypeClearing                     TransferEventsType = "CLEARING"
	TransferEventsTypeCorrectionCredit             TransferEventsType = "CORRECTION_CREDIT"
	TransferEventsTypeCorrectionDebit              TransferEventsType = "CORRECTION_DEBIT"
	TransferEventsTypeCreditAuthorization          TransferEventsType = "CREDIT_AUTHORIZATION"
	TransferEventsTypeCreditAuthorizationAdvice    TransferEventsType = "CREDIT_AUTHORIZATION_ADVICE"
	TransferEventsTypeFinancialAuthorization       TransferEventsType = "FINANCIAL_AUTHORIZATION"
	TransferEventsTypeFinancialCreditAuthorization TransferEventsType = "FINANCIAL_CREDIT_AUTHORIZATION"
	TransferEventsTypeReturn                       TransferEventsType = "RETURN"
	TransferEventsTypeReturnReversal               TransferEventsType = "RETURN_REVERSAL"
	TransferEventsTypeTransfer                     TransferEventsType = "TRANSFER"
	TransferEventsTypeTransferInsufficientFunds    TransferEventsType = "TRANSFER_INSUFFICIENT_FUNDS"
)

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 TransferNewResponse added in v0.5.0 

type TransferNewResponse struct {
	Data Transfer                `json:"data"`
	JSON transferNewResponseJSON `json:"-"`
}

func (*TransferNewResponse) UnmarshalJSON added in v0.5.0 

func (r *TransferNewResponse) UnmarshalJSON(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"
)

type TransferService 

type TransferService struct {
	Options []option.RequestOption
}

TransferService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransferService method instead.

func NewTransferService 

func NewTransferService(opts ...option.RequestOption) (r *TransferService)

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

func (*TransferService) New 

func (r *TransferService) New(ctx context.Context, body TransferNewParams, opts ...option.RequestOption) (res *TransferNewResponse, err error)

Transfer funds between two financial accounts or between a financial account and card

type TransferStatus 

type TransferStatus string

Status types:

- `DECLINED` - The transfer was declined. - `EXPIRED` - The transfer was held in pending for too long and expired. - `PENDING` - The transfer is pending release from a hold. - `SETTLED` - The transfer is completed. - `VOIDED` - The transfer was reversed before it settled. 

const (
	TransferStatusDeclined TransferStatus = "DECLINED"
	TransferStatusExpired  TransferStatus = "EXPIRED"
	TransferStatusPending  TransferStatus = "PENDING"
	TransferStatusSettled  TransferStatus = "SETTLED"
	TransferStatusVoided   TransferStatus = "VOIDED"
)

type VerificationMethod added in v0.6.5 

type VerificationMethod string
const (
	VerificationMethodManual       VerificationMethod = "MANUAL"
	VerificationMethodMicroDeposit VerificationMethod = "MICRO_DEPOSIT"
	VerificationMethodPlaid        VerificationMethod = "PLAID"
)

type WebhookService 

type WebhookService struct {
	Options []option.RequestOption
}

WebhookService contains methods and other services that help with interacting with the lithic API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWebhookService method instead.

func NewWebhookService 

func NewWebhookService(opts ...option.RequestOption) (r *WebhookService)

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

func (*WebhookService) VerifySignature 

func (r *WebhookService) VerifySignature(payload []byte, headers http.Header, secret string, now time.Time) (err error)

Validates whether or not the webhook payload was sent by Lithic.

An error will be raised if the webhook payload was not sent by Lithic.

type WebhookVerifySignatureParams added in v0.3.1 

type WebhookVerifySignatureParams struct {
}

Source Files

View all Source files

Directories

Path Synopsis
examples
card_embed_html
dispute_upload
union
apierror
apiform
apijson
apiquery
param
requestconfig
shared
testutil

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.