sam

package module
v2.0.0-beta.1 Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

README

Sam Go API Library

Go Reference

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

Installation

import (
	"github.com/DefinitelyATestOrg/sam-go/v2" // imported as sam
)

Or to pin the version:

go get -u 'github.com/DefinitelyATestOrg/sam-go/v2@v2.0.0-beta.1'

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/DefinitelyATestOrg/sam-go/v2"
)

func main() {
	client := sam.NewClient()
	customerAccountGetResponse, err := client.Customers.Accounts.Get(
		context.TODO(),
		"REPLACE_ME",
		"REPLACE_ME",
		sam.CustomerAccountGetParams{
			UserID: sam.F("36a22460-ebc8-4ffe-a213-1683c5a420c5"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", customerAccountGetResponse.Account)
}
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: sam.F("hello"),

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

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

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: sam.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 := sam.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

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

See the full list of request options.

Pagination

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

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

// TODO

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

// TODO
Errors

When the API returns a non-success status code, we return an error with type *sam.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.Customers.Accounts.Get(
	context.TODO(),
	"REPLACE_ME",
	"REPLACE_ME",
	sam.CustomerAccountGetParams{
		UserID: sam.F("36a22460-ebc8-4ffe-a213-1683c5a420c5"),
	},
)
if err != nil {
	var apierr *sam.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
	}
	panic(err.Error()) // GET "/v1/customers/{customerId}/accounts/{accountId}": 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.Customers.Accounts.Get(
	ctx,
	"REPLACE_ME",
	"REPLACE_ME",
	sam.CustomerAccountGetParams{
		UserID: sam.F("36a22460-ebc8-4ffe-a213-1683c5a420c5"),
	},
	// 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 := sam.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Customers.Accounts.Get(
	context.TODO(),
	"REPLACE_ME",
	"REPLACE_ME",
	sam.CustomerAccountGetParams{
		UserID: sam.F("36a22460-ebc8-4ffe-a213-1683c5a420c5"),
	},
	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 := sam.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 

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 Client 

type Client struct {
	Options   []option.RequestOption
	Customers *CustomerService
}

Client creates a struct with services and top level methods that help with interacting with the sam 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 (). 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.

type CustomerAccountCloseParams 

type CustomerAccountCloseParams struct {
	IdempotencyKey param.Field[string] `header:"idempotencyKey"`
}

type CustomerAccountGetParams 

type CustomerAccountGetParams struct {
	UserID param.Field[string] `header:"userId,required"`
}

type CustomerAccountGetResponse 

type CustomerAccountGetResponse struct {
	Account CustomerAccountGetResponseAccount `json:"account"`
	JSON    customerAccountGetResponseJSON    `json:"-"`
}

func (*CustomerAccountGetResponse) UnmarshalJSON 

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

type CustomerAccountGetResponseAccount 

type CustomerAccountGetResponseAccount struct {
	// ISO 4217 Alpha 3 currency code.
	Currency   string `json:"currency,required"`
	ResourceID string `json:"resourceId,required"`
	// Account status. The value is one of the following:
	//
	// - "enabled": account is available
	// - "deleted": account is terminated
	// - "blocked": account is blocked e.g. for legal reasons
	Status CustomerAccountGetResponseAccountStatus `json:"status,required"`
	// A list of balances regarding this account, e.g. the current balance, the last
	// booked balance. The list might be restricted to the current balance.
	Balances []CustomerAccountGetResponseAccountBalance `json:"balances"`
	// Basic Bank Account Number (BBAN) Identifier.
	Bban string `json:"bban"`
	// BICFI
	Bic string `json:"bic"`
	// ExternalCashAccountType1Code from ISO 20022.
	CashAccountType CustomerAccountGetResponseAccountCashAccountType `json:"cashAccountType"`
	// Additional information on the account.
	Details string `json:"details"`
	// Name of the account as defined by the user within online channels.
	DisplayName string `json:"displayName"`
	// IBAN of an account.
	Iban string `json:"iban"`
	// Mobile phone number.
	Msisdn string `json:"msisdn"`
	// Name of the account.
	Name string `json:"name"`
	// Name of the legal account owner. If there is more than one owner, then e.g. two
	// names might be noted here. For a corporate account, the corporate name is used
	// for this attribute.
	OwnerName string `json:"ownerName"`
	// List of owner names.
	OwnerNames []CustomerAccountGetResponseAccountOwnerName `json:"ownerNames"`
	// Product name of the bank for this account, proprietary definition.
	Product string `json:"product"`
	// Name of the user. In case of a corporate account, this might be the person
	// acting on behalf of the corporate.
	PsuName string `json:"psuName"`
	// Specifies the usage of the account:
	//
	// - PRIV: private personal account
	// - ORGA: professional account
	Usage CustomerAccountGetResponseAccountUsage `json:"usage"`
	JSON  customerAccountGetResponseAccountJSON  `json:"-"`
}

func (*CustomerAccountGetResponseAccount) UnmarshalJSON 

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

type CustomerAccountGetResponseAccountBalance 

type CustomerAccountGetResponseAccountBalance struct {
	BalanceAmount CustomerAccountGetResponseAccountBalancesBalanceAmount `json:"balanceAmount,required"`
	// The following balance types are defined:
	//
	//   - "closingBooked": Balance of the account at the end of the pre-agreed account
	//     reporting period. It is the sum of the opening booked balance at the beginning
	//     of the period and all entries booked to the account during the pre-agreed
	//     account reporting period.
	//   - "openingBooked": Book balance of the account at the beginning of the account
	//     reporting period. It always equals the closing book balance from the previous
	//     report.
	//   - "interimAvailable": Available balance calculated in the course of the account
	//     ?servicer?s business day, at the time specified, and subject to further
	//     changes during the business day. The interim balance is calculated on the
	//     basis of booked credit and debit items during the calculation time/period
	//     specified.
	//   - "interimBooked": Balance calculated in the course of the account servicer's
	//     business day, at the time specified, and subject to further changes during the
	//     business day. The interim balance is calculated on the basis of booked credit
	//     and debit items during the calculation time/period specified.
	BalanceType CustomerAccountGetResponseAccountBalancesBalanceType `json:"balanceType,required"`
	// A flag indicating if the credit limit of the corresponding account is included
	// in the calculation of the balance, where applicable.
	CreditLimitIncluded bool `json:"creditLimitIncluded"`
	// Indicates the date and time of the balance.
	LastRetrievedDateTime time.Time                                    `json:"lastRetrievedDateTime" format:"date-time"`
	JSON                  customerAccountGetResponseAccountBalanceJSON `json:"-"`
}

A single balance element.

func (*CustomerAccountGetResponseAccountBalance) UnmarshalJSON 

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

type CustomerAccountGetResponseAccountBalancesBalanceAmount 

type CustomerAccountGetResponseAccountBalancesBalanceAmount struct {
	// The amount given with fractional digits, where fractions must be compliant to
	// the currency definition. Up to 14 significant figures. Negative amounts are
	// signed by minus. The decimal separator is a dot.
	//
	// **Example:** Valid representations for EUR with up to two decimals are:
	//
	// - 1056
	// - 5768.2
	// - -1.50
	// - 5877.78
	Amount string `json:"amount,required"`
	// ISO 4217 Alpha 3 currency code.
	Currency string                                                     `json:"currency,required"`
	JSON     customerAccountGetResponseAccountBalancesBalanceAmountJSON `json:"-"`
}

func (*CustomerAccountGetResponseAccountBalancesBalanceAmount) UnmarshalJSON 

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

type CustomerAccountGetResponseAccountBalancesBalanceType 

type CustomerAccountGetResponseAccountBalancesBalanceType string

The following balance types are defined:

  • "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
  • "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
  • "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
  • "interimBooked": Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
const (
	CustomerAccountGetResponseAccountBalancesBalanceTypeClosingBooked    CustomerAccountGetResponseAccountBalancesBalanceType = "closingBooked"
	CustomerAccountGetResponseAccountBalancesBalanceTypeOpeningBooked    CustomerAccountGetResponseAccountBalancesBalanceType = "openingBooked"
	CustomerAccountGetResponseAccountBalancesBalanceTypeInterimAvailable CustomerAccountGetResponseAccountBalancesBalanceType = "interimAvailable"
	CustomerAccountGetResponseAccountBalancesBalanceTypeInterimBooked    CustomerAccountGetResponseAccountBalancesBalanceType = "interimBooked"
)

type CustomerAccountGetResponseAccountCashAccountType 

type CustomerAccountGetResponseAccountCashAccountType string

ExternalCashAccountType1Code from ISO 20022. 

const (
	CustomerAccountGetResponseAccountCashAccountTypeCacc CustomerAccountGetResponseAccountCashAccountType = "CACC"
	CustomerAccountGetResponseAccountCashAccountTypeCard CustomerAccountGetResponseAccountCashAccountType = "CARD"
	CustomerAccountGetResponseAccountCashAccountTypeCash CustomerAccountGetResponseAccountCashAccountType = "CASH"
	CustomerAccountGetResponseAccountCashAccountTypeChar CustomerAccountGetResponseAccountCashAccountType = "CHAR"
	CustomerAccountGetResponseAccountCashAccountTypeCish CustomerAccountGetResponseAccountCashAccountType = "CISH"
	CustomerAccountGetResponseAccountCashAccountTypeComm CustomerAccountGetResponseAccountCashAccountType = "COMM"
	CustomerAccountGetResponseAccountCashAccountTypeCpac CustomerAccountGetResponseAccountCashAccountType = "CPAC"
	CustomerAccountGetResponseAccountCashAccountTypeLlsv CustomerAccountGetResponseAccountCashAccountType = "LLSV"
	CustomerAccountGetResponseAccountCashAccountTypeLoan CustomerAccountGetResponseAccountCashAccountType = "LOAN"
	CustomerAccountGetResponseAccountCashAccountTypeMgld CustomerAccountGetResponseAccountCashAccountType = "MGLD"
	CustomerAccountGetResponseAccountCashAccountTypeMoma CustomerAccountGetResponseAccountCashAccountType = "MOMA"
	CustomerAccountGetResponseAccountCashAccountTypeNrex CustomerAccountGetResponseAccountCashAccountType = "NREX"
	CustomerAccountGetResponseAccountCashAccountTypeOdft CustomerAccountGetResponseAccountCashAccountType = "ODFT"
	CustomerAccountGetResponseAccountCashAccountTypeOndp CustomerAccountGetResponseAccountCashAccountType = "ONDP"
	CustomerAccountGetResponseAccountCashAccountTypeOthr CustomerAccountGetResponseAccountCashAccountType = "OTHR"
	CustomerAccountGetResponseAccountCashAccountTypeSacc CustomerAccountGetResponseAccountCashAccountType = "SACC"
	CustomerAccountGetResponseAccountCashAccountTypeSlry CustomerAccountGetResponseAccountCashAccountType = "SLRY"
	CustomerAccountGetResponseAccountCashAccountTypeSvgs CustomerAccountGetResponseAccountCashAccountType = "SVGS"
	CustomerAccountGetResponseAccountCashAccountTypeTaxe CustomerAccountGetResponseAccountCashAccountType = "TAXE"
	CustomerAccountGetResponseAccountCashAccountTypeTran CustomerAccountGetResponseAccountCashAccountType = "TRAN"
	CustomerAccountGetResponseAccountCashAccountTypeTras CustomerAccountGetResponseAccountCashAccountType = "TRAS"
	CustomerAccountGetResponseAccountCashAccountTypeVacc CustomerAccountGetResponseAccountCashAccountType = "VACC"
	CustomerAccountGetResponseAccountCashAccountTypeNfca CustomerAccountGetResponseAccountCashAccountType = "NFCA"
)

type CustomerAccountGetResponseAccountOwnerName 

type CustomerAccountGetResponseAccountOwnerName struct {
	// Account owner name
	Name string `json:"name,required"`
	// The following proprietary codes are used:
	//
	// - "owner",
	// - "legalRepresentative",
	// - "authorisedUser"
	Role string                                         `json:"role"`
	JSON customerAccountGetResponseAccountOwnerNameJSON `json:"-"`
}

Identifies a Person that acts as an account owner

func (*CustomerAccountGetResponseAccountOwnerName) UnmarshalJSON 

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

type CustomerAccountGetResponseAccountStatus 

type CustomerAccountGetResponseAccountStatus string

Account status. The value is one of the following:

- "enabled": account is available - "deleted": account is terminated - "blocked": account is blocked e.g. for legal reasons 

const (
	CustomerAccountGetResponseAccountStatusEnabled CustomerAccountGetResponseAccountStatus = "enabled"
	CustomerAccountGetResponseAccountStatusDeleted CustomerAccountGetResponseAccountStatus = "deleted"
	CustomerAccountGetResponseAccountStatusBlocked CustomerAccountGetResponseAccountStatus = "blocked"
)

type CustomerAccountGetResponseAccountUsage 

type CustomerAccountGetResponseAccountUsage string

Specifies the usage of the account:

- PRIV: private personal account - ORGA: professional account 

const (
	CustomerAccountGetResponseAccountUsagePriv CustomerAccountGetResponseAccountUsage = "PRIV"
	CustomerAccountGetResponseAccountUsageOrga CustomerAccountGetResponseAccountUsage = "ORGA"
)

type CustomerAccountListParams 

type CustomerAccountListParams struct {
	UserID param.Field[string] `header:"userId,required"`
	// A filter on the list based on the cashAccountType field. The value must be a 4
	// characters string as defined in ISO 20022
	CashAccountType param.Field[[]CustomerAccountListParamsCashAccountType] `query:"cashAccountType"`
	// A filter on the list based on the account status field. Available values:
	//
	// - enabled - account is available
	// - deleted - account is terminated
	// - blocked - account is blocked e.g. for legal reasons
	Status param.Field[[]CustomerAccountListParamsStatus] `query:"status"`
}

func (CustomerAccountListParams) URLQuery 

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

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

type CustomerAccountListParamsCashAccountType 

type CustomerAccountListParamsCashAccountType string

ExternalCashAccountType1Code from ISO 20022. 

const (
	CustomerAccountListParamsCashAccountTypeCacc CustomerAccountListParamsCashAccountType = "CACC"
	CustomerAccountListParamsCashAccountTypeCard CustomerAccountListParamsCashAccountType = "CARD"
	CustomerAccountListParamsCashAccountTypeCash CustomerAccountListParamsCashAccountType = "CASH"
	CustomerAccountListParamsCashAccountTypeChar CustomerAccountListParamsCashAccountType = "CHAR"
	CustomerAccountListParamsCashAccountTypeCish CustomerAccountListParamsCashAccountType = "CISH"
	CustomerAccountListParamsCashAccountTypeComm CustomerAccountListParamsCashAccountType = "COMM"
	CustomerAccountListParamsCashAccountTypeCpac CustomerAccountListParamsCashAccountType = "CPAC"
	CustomerAccountListParamsCashAccountTypeLlsv CustomerAccountListParamsCashAccountType = "LLSV"
	CustomerAccountListParamsCashAccountTypeLoan CustomerAccountListParamsCashAccountType = "LOAN"
	CustomerAccountListParamsCashAccountTypeMgld CustomerAccountListParamsCashAccountType = "MGLD"
	CustomerAccountListParamsCashAccountTypeMoma CustomerAccountListParamsCashAccountType = "MOMA"
	CustomerAccountListParamsCashAccountTypeNrex CustomerAccountListParamsCashAccountType = "NREX"
	CustomerAccountListParamsCashAccountTypeOdft CustomerAccountListParamsCashAccountType = "ODFT"
	CustomerAccountListParamsCashAccountTypeOndp CustomerAccountListParamsCashAccountType = "ONDP"
	CustomerAccountListParamsCashAccountTypeOthr CustomerAccountListParamsCashAccountType = "OTHR"
	CustomerAccountListParamsCashAccountTypeSacc CustomerAccountListParamsCashAccountType = "SACC"
	CustomerAccountListParamsCashAccountTypeSlry CustomerAccountListParamsCashAccountType = "SLRY"
	CustomerAccountListParamsCashAccountTypeSvgs CustomerAccountListParamsCashAccountType = "SVGS"
	CustomerAccountListParamsCashAccountTypeTaxe CustomerAccountListParamsCashAccountType = "TAXE"
	CustomerAccountListParamsCashAccountTypeTran CustomerAccountListParamsCashAccountType = "TRAN"
	CustomerAccountListParamsCashAccountTypeTras CustomerAccountListParamsCashAccountType = "TRAS"
	CustomerAccountListParamsCashAccountTypeVacc CustomerAccountListParamsCashAccountType = "VACC"
	CustomerAccountListParamsCashAccountTypeNfca CustomerAccountListParamsCashAccountType = "NFCA"
)

type CustomerAccountListParamsStatus 

type CustomerAccountListParamsStatus string

Account status. The value is one of the following:

- "enabled": account is available - "deleted": account is terminated - "blocked": account is blocked e.g. for legal reasons 

const (
	CustomerAccountListParamsStatusEnabled CustomerAccountListParamsStatus = "enabled"
	CustomerAccountListParamsStatusDeleted CustomerAccountListParamsStatus = "deleted"
	CustomerAccountListParamsStatusBlocked CustomerAccountListParamsStatus = "blocked"
)

type CustomerAccountListResponse 

type CustomerAccountListResponse struct {
	Accounts []CustomerAccountListResponseAccount `json:"accounts"`
	JSON     customerAccountListResponseJSON      `json:"-"`
}

func (*CustomerAccountListResponse) UnmarshalJSON 

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

type CustomerAccountListResponseAccount 

type CustomerAccountListResponseAccount struct {
	// ISO 4217 Alpha 3 currency code.
	Currency   string `json:"currency,required"`
	ResourceID string `json:"resourceId,required"`
	// Account status. The value is one of the following:
	//
	// - "enabled": account is available
	// - "deleted": account is terminated
	// - "blocked": account is blocked e.g. for legal reasons
	Status CustomerAccountListResponseAccountsStatus `json:"status,required"`
	// A list of balances regarding this account, e.g. the current balance, the last
	// booked balance. The list might be restricted to the current balance.
	Balances []CustomerAccountListResponseAccountsBalance `json:"balances"`
	// Basic Bank Account Number (BBAN) Identifier.
	Bban string `json:"bban"`
	// BICFI
	Bic string `json:"bic"`
	// ExternalCashAccountType1Code from ISO 20022.
	CashAccountType CustomerAccountListResponseAccountsCashAccountType `json:"cashAccountType"`
	// Additional information on the account.
	Details string `json:"details"`
	// Name of the account as defined by the user within online channels.
	DisplayName string `json:"displayName"`
	// IBAN of an account.
	Iban string `json:"iban"`
	// Mobile phone number.
	Msisdn string `json:"msisdn"`
	// Name of the account.
	Name string `json:"name"`
	// Name of the legal account owner. If there is more than one owner, then e.g. two
	// names might be noted here. For a corporate account, the corporate name is used
	// for this attribute.
	OwnerName string `json:"ownerName"`
	// List of owner names.
	OwnerNames []CustomerAccountListResponseAccountsOwnerName `json:"ownerNames"`
	// Product name of the bank for this account, proprietary definition.
	Product string `json:"product"`
	// Name of the user. In case of a corporate account, this might be the person
	// acting on behalf of the corporate.
	PsuName string `json:"psuName"`
	// Specifies the usage of the account:
	//
	// - PRIV: private personal account
	// - ORGA: professional account
	Usage CustomerAccountListResponseAccountsUsage `json:"usage"`
	JSON  customerAccountListResponseAccountJSON   `json:"-"`
}

func (*CustomerAccountListResponseAccount) UnmarshalJSON 

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

type CustomerAccountListResponseAccountsBalance 

type CustomerAccountListResponseAccountsBalance struct {
	BalanceAmount CustomerAccountListResponseAccountsBalancesBalanceAmount `json:"balanceAmount,required"`
	// The following balance types are defined:
	//
	//   - "closingBooked": Balance of the account at the end of the pre-agreed account
	//     reporting period. It is the sum of the opening booked balance at the beginning
	//     of the period and all entries booked to the account during the pre-agreed
	//     account reporting period.
	//   - "openingBooked": Book balance of the account at the beginning of the account
	//     reporting period. It always equals the closing book balance from the previous
	//     report.
	//   - "interimAvailable": Available balance calculated in the course of the account
	//     ?servicer?s business day, at the time specified, and subject to further
	//     changes during the business day. The interim balance is calculated on the
	//     basis of booked credit and debit items during the calculation time/period
	//     specified.
	//   - "interimBooked": Balance calculated in the course of the account servicer's
	//     business day, at the time specified, and subject to further changes during the
	//     business day. The interim balance is calculated on the basis of booked credit
	//     and debit items during the calculation time/period specified.
	BalanceType CustomerAccountListResponseAccountsBalancesBalanceType `json:"balanceType,required"`
	// A flag indicating if the credit limit of the corresponding account is included
	// in the calculation of the balance, where applicable.
	CreditLimitIncluded bool `json:"creditLimitIncluded"`
	// Indicates the date and time of the balance.
	LastRetrievedDateTime time.Time                                      `json:"lastRetrievedDateTime" format:"date-time"`
	JSON                  customerAccountListResponseAccountsBalanceJSON `json:"-"`
}

A single balance element.

func (*CustomerAccountListResponseAccountsBalance) UnmarshalJSON 

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

type CustomerAccountListResponseAccountsBalancesBalanceAmount 

type CustomerAccountListResponseAccountsBalancesBalanceAmount struct {
	// The amount given with fractional digits, where fractions must be compliant to
	// the currency definition. Up to 14 significant figures. Negative amounts are
	// signed by minus. The decimal separator is a dot.
	//
	// **Example:** Valid representations for EUR with up to two decimals are:
	//
	// - 1056
	// - 5768.2
	// - -1.50
	// - 5877.78
	Amount string `json:"amount,required"`
	// ISO 4217 Alpha 3 currency code.
	Currency string                                                       `json:"currency,required"`
	JSON     customerAccountListResponseAccountsBalancesBalanceAmountJSON `json:"-"`
}

func (*CustomerAccountListResponseAccountsBalancesBalanceAmount) UnmarshalJSON 

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

type CustomerAccountListResponseAccountsBalancesBalanceType 

type CustomerAccountListResponseAccountsBalancesBalanceType string

The following balance types are defined:

  • "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
  • "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
  • "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
  • "interimBooked": Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
const (
	CustomerAccountListResponseAccountsBalancesBalanceTypeClosingBooked    CustomerAccountListResponseAccountsBalancesBalanceType = "closingBooked"
	CustomerAccountListResponseAccountsBalancesBalanceTypeOpeningBooked    CustomerAccountListResponseAccountsBalancesBalanceType = "openingBooked"
	CustomerAccountListResponseAccountsBalancesBalanceTypeInterimAvailable CustomerAccountListResponseAccountsBalancesBalanceType = "interimAvailable"
	CustomerAccountListResponseAccountsBalancesBalanceTypeInterimBooked    CustomerAccountListResponseAccountsBalancesBalanceType = "interimBooked"
)

type CustomerAccountListResponseAccountsCashAccountType 

type CustomerAccountListResponseAccountsCashAccountType string

ExternalCashAccountType1Code from ISO 20022. 

const (
	CustomerAccountListResponseAccountsCashAccountTypeCacc CustomerAccountListResponseAccountsCashAccountType = "CACC"
	CustomerAccountListResponseAccountsCashAccountTypeCard CustomerAccountListResponseAccountsCashAccountType = "CARD"
	CustomerAccountListResponseAccountsCashAccountTypeCash CustomerAccountListResponseAccountsCashAccountType = "CASH"
	CustomerAccountListResponseAccountsCashAccountTypeChar CustomerAccountListResponseAccountsCashAccountType = "CHAR"
	CustomerAccountListResponseAccountsCashAccountTypeCish CustomerAccountListResponseAccountsCashAccountType = "CISH"
	CustomerAccountListResponseAccountsCashAccountTypeComm CustomerAccountListResponseAccountsCashAccountType = "COMM"
	CustomerAccountListResponseAccountsCashAccountTypeCpac CustomerAccountListResponseAccountsCashAccountType = "CPAC"
	CustomerAccountListResponseAccountsCashAccountTypeLlsv CustomerAccountListResponseAccountsCashAccountType = "LLSV"
	CustomerAccountListResponseAccountsCashAccountTypeLoan CustomerAccountListResponseAccountsCashAccountType = "LOAN"
	CustomerAccountListResponseAccountsCashAccountTypeMgld CustomerAccountListResponseAccountsCashAccountType = "MGLD"
	CustomerAccountListResponseAccountsCashAccountTypeMoma CustomerAccountListResponseAccountsCashAccountType = "MOMA"
	CustomerAccountListResponseAccountsCashAccountTypeNrex CustomerAccountListResponseAccountsCashAccountType = "NREX"
	CustomerAccountListResponseAccountsCashAccountTypeOdft CustomerAccountListResponseAccountsCashAccountType = "ODFT"
	CustomerAccountListResponseAccountsCashAccountTypeOndp CustomerAccountListResponseAccountsCashAccountType = "ONDP"
	CustomerAccountListResponseAccountsCashAccountTypeOthr CustomerAccountListResponseAccountsCashAccountType = "OTHR"
	CustomerAccountListResponseAccountsCashAccountTypeSacc CustomerAccountListResponseAccountsCashAccountType = "SACC"
	CustomerAccountListResponseAccountsCashAccountTypeSlry CustomerAccountListResponseAccountsCashAccountType = "SLRY"
	CustomerAccountListResponseAccountsCashAccountTypeSvgs CustomerAccountListResponseAccountsCashAccountType = "SVGS"
	CustomerAccountListResponseAccountsCashAccountTypeTaxe CustomerAccountListResponseAccountsCashAccountType = "TAXE"
	CustomerAccountListResponseAccountsCashAccountTypeTran CustomerAccountListResponseAccountsCashAccountType = "TRAN"
	CustomerAccountListResponseAccountsCashAccountTypeTras CustomerAccountListResponseAccountsCashAccountType = "TRAS"
	CustomerAccountListResponseAccountsCashAccountTypeVacc CustomerAccountListResponseAccountsCashAccountType = "VACC"
	CustomerAccountListResponseAccountsCashAccountTypeNfca CustomerAccountListResponseAccountsCashAccountType = "NFCA"
)

type CustomerAccountListResponseAccountsOwnerName 

type CustomerAccountListResponseAccountsOwnerName struct {
	// Account owner name
	Name string `json:"name,required"`
	// The following proprietary codes are used:
	//
	// - "owner",
	// - "legalRepresentative",
	// - "authorisedUser"
	Role string                                           `json:"role"`
	JSON customerAccountListResponseAccountsOwnerNameJSON `json:"-"`
}

Identifies a Person that acts as an account owner

func (*CustomerAccountListResponseAccountsOwnerName) UnmarshalJSON 

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

type CustomerAccountListResponseAccountsStatus 

type CustomerAccountListResponseAccountsStatus string

Account status. The value is one of the following:

- "enabled": account is available - "deleted": account is terminated - "blocked": account is blocked e.g. for legal reasons 

const (
	CustomerAccountListResponseAccountsStatusEnabled CustomerAccountListResponseAccountsStatus = "enabled"
	CustomerAccountListResponseAccountsStatusDeleted CustomerAccountListResponseAccountsStatus = "deleted"
	CustomerAccountListResponseAccountsStatusBlocked CustomerAccountListResponseAccountsStatus = "blocked"
)

type CustomerAccountListResponseAccountsUsage 

type CustomerAccountListResponseAccountsUsage string

Specifies the usage of the account:

- PRIV: private personal account - ORGA: professional account 

const (
	CustomerAccountListResponseAccountsUsagePriv CustomerAccountListResponseAccountsUsage = "PRIV"
	CustomerAccountListResponseAccountsUsageOrga CustomerAccountListResponseAccountsUsage = "ORGA"
)

type CustomerAccountService 

type CustomerAccountService struct {
	Options []option.RequestOption
}

CustomerAccountService contains methods and other services that help with interacting with the sam 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 NewCustomerAccountService method instead.

func NewCustomerAccountService 

func NewCustomerAccountService(opts ...option.RequestOption) (r *CustomerAccountService)

NewCustomerAccountService 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 (*CustomerAccountService) Close 

func (r *CustomerAccountService) Close(ctx context.Context, customerID string, accountID string, body CustomerAccountCloseParams, opts ...option.RequestOption) (err error)

Allows closure of a single account.

func (*CustomerAccountService) Get 

func (r *CustomerAccountService) Get(ctx context.Context, customerID string, accountID string, query CustomerAccountGetParams, opts ...option.RequestOption) (res *CustomerAccountGetResponse, err error)

Allows retrieval of a single account, fetched by its id.

func (*CustomerAccountService) List 

func (r *CustomerAccountService) List(ctx context.Context, customerID string, params CustomerAccountListParams, opts ...option.RequestOption) (res *CustomerAccountListResponse, err error)

Allows retrieval of accounts associated with the current authorised user. It's possible to filter the accounts list by status or by cashAccountType.

type CustomerService 

type CustomerService struct {
	Options  []option.RequestOption
	Accounts *CustomerAccountService
}

CustomerService contains methods and other services that help with interacting with the sam 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 NewCustomerService method instead.

func NewCustomerService 

func NewCustomerService(opts ...option.RequestOption) (r *CustomerService)

NewCustomerService 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 Error 

type Error = apierror.Error

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
param
requestconfig
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.