shared

package
v0.67.0 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

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

func (*Address) UnmarshalJSON 

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

type AddressParam 

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

func (AddressParam) MarshalJSON 

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

type CarrierParam 

type CarrierParam struct {
	// QR code url to display on the card carrier
	QrCodeURL param.Field[string] `json:"qr_code_url"`
}

func (CarrierParam) MarshalJSON 

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

type Currency added in v0.50.0 

type Currency string

ISO 4217 currency. Its enumerants are ISO 4217 currencies except for some special currencies like `XXX`. Enumerants names are lowercase currency code e.g. `EUR`, `USD`. 

const (
	CurrencyAed Currency = "AED"
	CurrencyAfn Currency = "AFN"
	CurrencyAll Currency = "ALL"
	CurrencyAmd Currency = "AMD"
	CurrencyAng Currency = "ANG"
	CurrencyAoa Currency = "AOA"
	CurrencyArs Currency = "ARS"
	CurrencyAud Currency = "AUD"
	CurrencyAwg Currency = "AWG"
	CurrencyAzn Currency = "AZN"
	CurrencyBam Currency = "BAM"
	CurrencyBbd Currency = "BBD"
	CurrencyBdt Currency = "BDT"
	CurrencyBgn Currency = "BGN"
	CurrencyBhd Currency = "BHD"
	CurrencyBif Currency = "BIF"
	CurrencyBmd Currency = "BMD"
	CurrencyBnd Currency = "BND"
	CurrencyBob Currency = "BOB"
	CurrencyBov Currency = "BOV"
	CurrencyBrl Currency = "BRL"
	CurrencyBsd Currency = "BSD"
	CurrencyBtn Currency = "BTN"
	CurrencyBwp Currency = "BWP"
	CurrencyByn Currency = "BYN"
	CurrencyBzd Currency = "BZD"
	CurrencyCad Currency = "CAD"
	CurrencyCdf Currency = "CDF"
	CurrencyChe Currency = "CHE"
	CurrencyChf Currency = "CHF"
	CurrencyChw Currency = "CHW"
	CurrencyClf Currency = "CLF"
	CurrencyClp Currency = "CLP"
	CurrencyCny Currency = "CNY"
	CurrencyCop Currency = "COP"
	CurrencyCou Currency = "COU"
	CurrencyCrc Currency = "CRC"
	CurrencyCuc Currency = "CUC"
	CurrencyCup Currency = "CUP"
	CurrencyCve Currency = "CVE"
	CurrencyCzk Currency = "CZK"
	CurrencyDjf Currency = "DJF"
	CurrencyDkk Currency = "DKK"
	CurrencyDop Currency = "DOP"
	CurrencyDzd Currency = "DZD"
	CurrencyEgp Currency = "EGP"
	CurrencyErn Currency = "ERN"
	CurrencyEtb Currency = "ETB"
	CurrencyEur Currency = "EUR"
	CurrencyFjd Currency = "FJD"
	CurrencyFkp Currency = "FKP"
	CurrencyGbp Currency = "GBP"
	CurrencyGel Currency = "GEL"
	CurrencyGhs Currency = "GHS"
	CurrencyGip Currency = "GIP"
	CurrencyGmd Currency = "GMD"
	CurrencyGnf Currency = "GNF"
	CurrencyGtq Currency = "GTQ"
	CurrencyGyd Currency = "GYD"
	CurrencyHkd Currency = "HKD"
	CurrencyHnl Currency = "HNL"
	CurrencyHrk Currency = "HRK"
	CurrencyHtg Currency = "HTG"
	CurrencyHuf Currency = "HUF"
	CurrencyIdr Currency = "IDR"
	CurrencyIls Currency = "ILS"
	CurrencyInr Currency = "INR"
	CurrencyIqd Currency = "IQD"
	CurrencyIrr Currency = "IRR"
	CurrencyIsk Currency = "ISK"
	CurrencyJmd Currency = "JMD"
	CurrencyJod Currency = "JOD"
	CurrencyJpy Currency = "JPY"
	CurrencyKes Currency = "KES"
	CurrencyKgs Currency = "KGS"
	CurrencyKhr Currency = "KHR"
	CurrencyKmf Currency = "KMF"
	CurrencyKpw Currency = "KPW"
	CurrencyKrw Currency = "KRW"
	CurrencyKwd Currency = "KWD"
	CurrencyKyd Currency = "KYD"
	CurrencyKzt Currency = "KZT"
	CurrencyLak Currency = "LAK"
	CurrencyLbp Currency = "LBP"
	CurrencyLkr Currency = "LKR"
	CurrencyLrd Currency = "LRD"
	CurrencyLsl Currency = "LSL"
	CurrencyLyd Currency = "LYD"
	CurrencyMad Currency = "MAD"
	CurrencyMdl Currency = "MDL"
	CurrencyMga Currency = "MGA"
	CurrencyMkd Currency = "MKD"
	CurrencyMmk Currency = "MMK"
	CurrencyMnt Currency = "MNT"
	CurrencyMop Currency = "MOP"
	CurrencyMru Currency = "MRU"
	CurrencyMur Currency = "MUR"
	CurrencyMvr Currency = "MVR"
	CurrencyMwk Currency = "MWK"
	CurrencyMxn Currency = "MXN"
	CurrencyMxv Currency = "MXV"
	CurrencyMyr Currency = "MYR"
	CurrencyMzn Currency = "MZN"
	CurrencyNad Currency = "NAD"
	CurrencyNgn Currency = "NGN"
	CurrencyNio Currency = "NIO"
	CurrencyNok Currency = "NOK"
	CurrencyNpr Currency = "NPR"
	CurrencyNzd Currency = "NZD"
	CurrencyOmr Currency = "OMR"
	CurrencyPab Currency = "PAB"
	CurrencyPen Currency = "PEN"
	CurrencyPgk Currency = "PGK"
	CurrencyPhp Currency = "PHP"
	CurrencyPkr Currency = "PKR"
	CurrencyPln Currency = "PLN"
	CurrencyPyg Currency = "PYG"
	CurrencyQar Currency = "QAR"
	CurrencyRon Currency = "RON"
	CurrencyRsd Currency = "RSD"
	CurrencyRub Currency = "RUB"
	CurrencyRwf Currency = "RWF"
	CurrencySar Currency = "SAR"
	CurrencySbd Currency = "SBD"
	CurrencyScr Currency = "SCR"
	CurrencySdg Currency = "SDG"
	CurrencySek Currency = "SEK"
	CurrencySgd Currency = "SGD"
	CurrencyShp Currency = "SHP"
	CurrencySle Currency = "SLE"
	CurrencySll Currency = "SLL"
	CurrencySos Currency = "SOS"
	CurrencySrd Currency = "SRD"
	CurrencySsp Currency = "SSP"
	CurrencyStn Currency = "STN"
	CurrencySvc Currency = "SVC"
	CurrencySyp Currency = "SYP"
	CurrencySzl Currency = "SZL"
	CurrencyThb Currency = "THB"
	CurrencyTjs Currency = "TJS"
	CurrencyTmt Currency = "TMT"
	CurrencyTnd Currency = "TND"
	CurrencyTop Currency = "TOP"
	CurrencyTry Currency = "TRY"
	CurrencyTtd Currency = "TTD"
	CurrencyTwd Currency = "TWD"
	CurrencyTzs Currency = "TZS"
	CurrencyUah Currency = "UAH"
	CurrencyUgx Currency = "UGX"
	CurrencyUsd Currency = "USD"
	CurrencyUsn Currency = "USN"
	CurrencyUyi Currency = "UYI"
	CurrencyUyu Currency = "UYU"
	CurrencyUyw Currency = "UYW"
	CurrencyUzs Currency = "UZS"
	CurrencyVed Currency = "VED"
	CurrencyVes Currency = "VES"
	CurrencyVnd Currency = "VND"
	CurrencyVuv Currency = "VUV"
	CurrencyWst Currency = "WST"
	CurrencyXaf Currency = "XAF"
	CurrencyXag Currency = "XAG"
	CurrencyXau Currency = "XAU"
	CurrencyXba Currency = "XBA"
	CurrencyXbb Currency = "XBB"
	CurrencyXbc Currency = "XBC"
	CurrencyXbd Currency = "XBD"
	CurrencyXcd Currency = "XCD"
	CurrencyXdr Currency = "XDR"
	CurrencyXof Currency = "XOF"
	CurrencyXpd Currency = "XPD"
	CurrencyXpf Currency = "XPF"
	CurrencyXpt Currency = "XPT"
	CurrencyXsu Currency = "XSU"
	CurrencyXts Currency = "XTS"
	CurrencyXua Currency = "XUA"
	CurrencyXxx Currency = "XXX"
	CurrencyYer Currency = "YER"
	CurrencyZar Currency = "ZAR"
	CurrencyZmw Currency = "ZMW"
	CurrencyZwl Currency = "ZWL"
)

func (Currency) IsKnown added in v0.50.0 

func (r Currency) IsKnown() bool

type Document added in v0.48.0 

type Document struct {
	// Globally unique identifier for the document.
	Token string `json:"token,required" format:"uuid"`
	// Globally unique identifier for the account holder.
	AccountHolderToken string `json:"account_holder_token,required" format:"uuid"`
	// Type of documentation to be submitted for verification of an account holder
	DocumentType DocumentDocumentType `json:"document_type,required"`
	// Globally unique identifier for an entity.
	EntityToken string `json:"entity_token,required" format:"uuid"`
	// Represents a single image of the document to upload.
	RequiredDocumentUploads []DocumentRequiredDocumentUpload `json:"required_document_uploads,required"`
	JSON                    documentJSON                     `json:"-"`
}

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

func (*Document) UnmarshalJSON added in v0.48.0 

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

type DocumentDocumentType added in v0.48.0 

type DocumentDocumentType string

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

const (
	DocumentDocumentTypeDriversLicense            DocumentDocumentType = "DRIVERS_LICENSE"
	DocumentDocumentTypePassport                  DocumentDocumentType = "PASSPORT"
	DocumentDocumentTypePassportCard              DocumentDocumentType = "PASSPORT_CARD"
	DocumentDocumentTypeEinLetter                 DocumentDocumentType = "EIN_LETTER"
	DocumentDocumentTypeTaxReturn                 DocumentDocumentType = "TAX_RETURN"
	DocumentDocumentTypeOperatingAgreement        DocumentDocumentType = "OPERATING_AGREEMENT"
	DocumentDocumentTypeCertificateOfFormation    DocumentDocumentType = "CERTIFICATE_OF_FORMATION"
	DocumentDocumentTypeCertificateOfGoodStanding DocumentDocumentType = "CERTIFICATE_OF_GOOD_STANDING"
	DocumentDocumentTypeArticlesOfIncorporation   DocumentDocumentType = "ARTICLES_OF_INCORPORATION"
	DocumentDocumentTypeArticlesOfOrganization    DocumentDocumentType = "ARTICLES_OF_ORGANIZATION"
	DocumentDocumentTypeBylaws                    DocumentDocumentType = "BYLAWS"
	DocumentDocumentTypeGovernmentBusinessLicense DocumentDocumentType = "GOVERNMENT_BUSINESS_LICENSE"
	DocumentDocumentTypePartnershipAgreement      DocumentDocumentType = "PARTNERSHIP_AGREEMENT"
	DocumentDocumentTypeSs4Form                   DocumentDocumentType = "SS4_FORM"
	DocumentDocumentTypeBankStatement             DocumentDocumentType = "BANK_STATEMENT"
	DocumentDocumentTypeUtilityBillStatement      DocumentDocumentType = "UTILITY_BILL_STATEMENT"
	DocumentDocumentTypeSsnCard                   DocumentDocumentType = "SSN_CARD"
	DocumentDocumentTypeItinLetter                DocumentDocumentType = "ITIN_LETTER"
	DocumentDocumentTypeFincenBoiReport           DocumentDocumentType = "FINCEN_BOI_REPORT"
)

func (DocumentDocumentType) IsKnown added in v0.48.0 

func (r DocumentDocumentType) IsKnown() bool

type DocumentRequiredDocumentUpload added in v0.48.0 

type DocumentRequiredDocumentUpload struct {
	// Globally unique identifier for the document upload.
	Token string `json:"token,required" format:"uuid"`
	// A list of status reasons associated with a KYB account holder that have been
	// satisfied by the document upload
	AcceptedEntityStatusReasons []string `json:"accepted_entity_status_reasons,required"`
	// When the document upload was created
	Created time.Time `json:"created,required" format:"date-time"`
	// Type of image to upload.
	ImageType DocumentRequiredDocumentUploadsImageType `json:"image_type,required"`
	// A list of status reasons associated with a KYB account holder that have not been
	// satisfied by the document upload
	RejectedEntityStatusReasons []string `json:"rejected_entity_status_reasons,required"`
	// Status of an account holder's document upload.
	Status DocumentRequiredDocumentUploadsStatus `json:"status,required"`
	// Reasons for document image upload status.
	StatusReasons []DocumentRequiredDocumentUploadsStatusReason `json:"status_reasons,required"`
	// When the document upload was last updated
	Updated time.Time `json:"updated,required" format:"date-time"`
	// 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,required"`
	JSON      documentRequiredDocumentUploadJSON `json:"-"`
}

Represents a single image of the document to upload.

func (*DocumentRequiredDocumentUpload) UnmarshalJSON added in v0.48.0 

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

type DocumentRequiredDocumentUploadsImageType added in v0.48.0 

type DocumentRequiredDocumentUploadsImageType string

Type of image to upload. 

const (
	DocumentRequiredDocumentUploadsImageTypeFront DocumentRequiredDocumentUploadsImageType = "FRONT"
	DocumentRequiredDocumentUploadsImageTypeBack  DocumentRequiredDocumentUploadsImageType = "BACK"
)

func (DocumentRequiredDocumentUploadsImageType) IsKnown added in v0.48.0 

func (r DocumentRequiredDocumentUploadsImageType) IsKnown() bool

type DocumentRequiredDocumentUploadsStatus added in v0.48.0 

type DocumentRequiredDocumentUploadsStatus string

Status of an account holder's document upload. 

const (
	DocumentRequiredDocumentUploadsStatusAccepted        DocumentRequiredDocumentUploadsStatus = "ACCEPTED"
	DocumentRequiredDocumentUploadsStatusRejected        DocumentRequiredDocumentUploadsStatus = "REJECTED"
	DocumentRequiredDocumentUploadsStatusPendingUpload   DocumentRequiredDocumentUploadsStatus = "PENDING_UPLOAD"
	DocumentRequiredDocumentUploadsStatusUploaded        DocumentRequiredDocumentUploadsStatus = "UPLOADED"
	DocumentRequiredDocumentUploadsStatusPartialApproval DocumentRequiredDocumentUploadsStatus = "PARTIAL_APPROVAL"
)

func (DocumentRequiredDocumentUploadsStatus) IsKnown added in v0.48.0 

func (r DocumentRequiredDocumentUploadsStatus) IsKnown() bool

type DocumentRequiredDocumentUploadsStatusReason added in v0.48.0 

type DocumentRequiredDocumentUploadsStatusReason string

The status reasons for an account holder document upload that is not ACCEPTED 

const (
	DocumentRequiredDocumentUploadsStatusReasonDocumentMissingRequiredData     DocumentRequiredDocumentUploadsStatusReason = "DOCUMENT_MISSING_REQUIRED_DATA"
	DocumentRequiredDocumentUploadsStatusReasonDocumentUploadTooBlurry         DocumentRequiredDocumentUploadsStatusReason = "DOCUMENT_UPLOAD_TOO_BLURRY"
	DocumentRequiredDocumentUploadsStatusReasonFileSizeTooLarge                DocumentRequiredDocumentUploadsStatusReason = "FILE_SIZE_TOO_LARGE"
	DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentType             DocumentRequiredDocumentUploadsStatusReason = "INVALID_DOCUMENT_TYPE"
	DocumentRequiredDocumentUploadsStatusReasonInvalidDocumentUpload           DocumentRequiredDocumentUploadsStatusReason = "INVALID_DOCUMENT_UPLOAD"
	DocumentRequiredDocumentUploadsStatusReasonInvalidEntity                   DocumentRequiredDocumentUploadsStatusReason = "INVALID_ENTITY"
	DocumentRequiredDocumentUploadsStatusReasonDocumentExpired                 DocumentRequiredDocumentUploadsStatusReason = "DOCUMENT_EXPIRED"
	DocumentRequiredDocumentUploadsStatusReasonDocumentIssuedGreaterThan30Days DocumentRequiredDocumentUploadsStatusReason = "DOCUMENT_ISSUED_GREATER_THAN_30_DAYS"
	DocumentRequiredDocumentUploadsStatusReasonDocumentTypeNotSupported        DocumentRequiredDocumentUploadsStatusReason = "DOCUMENT_TYPE_NOT_SUPPORTED"
	DocumentRequiredDocumentUploadsStatusReasonUnknownFailureReason            DocumentRequiredDocumentUploadsStatusReason = "UNKNOWN_FAILURE_REASON"
	DocumentRequiredDocumentUploadsStatusReasonUnknownError                    DocumentRequiredDocumentUploadsStatusReason = "UNKNOWN_ERROR"
)

func (DocumentRequiredDocumentUploadsStatusReason) IsKnown added in v0.48.0 

func (r DocumentRequiredDocumentUploadsStatusReason) IsKnown() bool

type ShippingAddressParam 

type ShippingAddressParam struct {
	// Valid USPS routable address.
	Address1 param.Field[string] `json:"address1,required"`
	// City
	City param.Field[string] `json:"city,required"`
	// Uppercase ISO 3166-1 alpha-3 three character abbreviation.
	Country param.Field[string] `json:"country,required"`
	// Customer's first name. This will be the first name printed on the physical card.
	// The combined length of `first_name` and `last_name` may not exceed 25
	// characters.
	FirstName param.Field[string] `json:"first_name,required"`
	// Customer's surname (family name). This will be the last name printed on the
	// physical card. The combined length of `first_name` and `last_name` may not
	// exceed 25 characters.
	LastName param.Field[string] `json:"last_name,required"`
	// Postal code (formerly zipcode). For US addresses, either five-digit postal code
	// or nine-digit postal code (ZIP+4) using the format 12345-1234.
	PostalCode param.Field[string] `json:"postal_code,required"`
	// Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a
	// limit of 24 characters for other countries.
	State param.Field[string] `json:"state,required"`
	// Unit number (if applicable).
	Address2 param.Field[string] `json:"address2"`
	// Email address to be contacted for expedited shipping process purposes. Required
	// if `shipping_method` is `EXPEDITED`.
	Email param.Field[string] `json:"email"`
	// Text to be printed on line two of the physical card. Use of this field requires
	// additional permissions.
	Line2Text param.Field[string] `json:"line2_text"`
	// Cardholder's phone number in E.164 format to be contacted for expedited shipping
	// process purposes. Required if `shipping_method` is `EXPEDITED`.
	PhoneNumber param.Field[string] `json:"phone_number"`
}

func (ShippingAddressParam) MarshalJSON 

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

type UnionInt added in v0.64.0 

type UnionInt int64

func (UnionInt) ImplementsAuthRuleConditionValueUnion added in v0.64.0 

func (UnionInt) ImplementsAuthRuleConditionValueUnion()

func (UnionInt) ImplementsAuthRuleConditionValueUnionParam added in v0.64.0 

func (UnionInt) ImplementsAuthRuleConditionValueUnionParam()

func (UnionInt) ImplementsVelocityLimitParamsPeriodUnion added in v0.64.0 

func (UnionInt) ImplementsVelocityLimitParamsPeriodUnion()

type UnionString added in v0.51.0 

type UnionString string

func (UnionString) ImplementsAuthRuleConditionValueUnion added in v0.64.0 

func (UnionString) ImplementsAuthRuleConditionValueUnion()

func (UnionString) ImplementsAuthRuleConditionValueUnionParam added in v0.64.0 

func (UnionString) ImplementsAuthRuleConditionValueUnionParam()

Source Files

View all Source files

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.