Version: v0.0.0-...-60d39f3 Latest Latest

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

Go to latest
Published: Oct 4, 2022 License: MIT Imports: 20 Imported by: 0




This section is empty.


View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")


func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.


type APIClient

type APIClient struct {
	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields

APIClient manages communication with the GMO Aozora Net Bank Open API API v1.1.10 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Account

type Account struct {
	// 入金口座ID 半角数字 入金先の口座を識別するID
	RaId string `json:"raId"`
	// 入金口座 支店コード 半角数字
	RaBranchCode string `json:"raBranchCode"`
	// 半角文字
	RaBranchNameKana string `json:"raBranchNameKana"`
	// 半角数字
	RaAccountNumber string `json:"raAccountNumber"`
	// 全角文字
	RaHolderName string `json:"raHolderName"`
	// 基準日 半角文字 応答日付、もしくは入金明細の基準日を示す。 YYYY-MM-DD形式
	BaseDate string `json:"baseDate"`
	// 基準時刻 半角文字 応答時刻、もしくは入金明細の基準時刻を示す。  ISO8601 時差(offset)も表記 HH:MM:SS+09:00形式
	BaseTime string `json:"baseTime"`


type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type ErrorResponse

type ErrorResponse struct {
	// エラーコード 半角英数文字
	ErrorCode string `json:"errorCode"`
	// エラーメッセージ 全半角英数記号文字
	ErrorMessage string `json:"errorMessage"`

type EventType

type EventType struct {
	// イベント種別 半角英数記号文字 va-deposit-transaction = 振込入金口座への入金明細通知
	EventType string `json:"eventType"`

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type SubscribeRequestBody

type SubscribeRequestBody struct {
	// 配信状態 半角数字 0=配信停止要求 1=配信開始要求
	SubscribeStatus string `json:"subscribeStatus"`
	// イベント種別のリスト
	EventTypes []EventType `json:"eventTypes"`

type VaDepositTransactionMessage

type VaDepositTransactionMessage struct {
	// メッセージID 半角英数字 メッセージを一意に識別するID
	MessageId string `json:"messageId"`
	// イベント生成日時 半角文字 ISO8601 時差(offset)も表記 YYYY-MM-DDTHH:MM:SS+09:00形式
	Timestamp     string         `json:"timestamp"`
	Account       *Account       `json:"account"`
	VaTransaction *VaTransaction `json:"vaTransaction"`

type VaDepositTransactionUnsentResponse

type VaDepositTransactionUnsentResponse struct {
	Messages []VaDepositTransactionMessage `json:"messages"`

type VaTransaction

type VaTransaction struct {
	// 振込入金口座ID 半角数字 振込入金口座を識別するID
	VaId string `json:"vaId"`
	// 取引日 半角文字 YYYY-MM-DD形式
	TransactionDate string `json:"transactionDate"`
	// 起算日 半角文字 YYYY-MM-DD形式
	ValueDate string `json:"valueDate"`
	// 支店コード 半角数字
	VaBranchCode string `json:"vaBranchCode"`
	// 支店名カナ 半角文字
	VaBranchNameKana string `json:"vaBranchNameKana"`
	// 口座番号 半角数字
	VaAccountNumber string `json:"vaAccountNumber"`
	// 口座名義カナ 半角文字
	VaAccountNameKana string `json:"vaAccountNameKana"`
	// 入金金額 半角数字
	DepositAmount string `json:"depositAmount"`
	// 振込依頼人名カナ 半角文字
	RemitterNameKana string `json:"remitterNameKana"`
	// 仕向金融機関名カナ 半角文字
	PaymentBankName string `json:"paymentBankName"`
	// 仕向支店名カナ 半角文字
	PaymentBranchName string `json:"paymentBranchName"`
	// サービス企業名 全角文字 振込入金口座契約サービス企業名
	PartnerName string `json:"partnerName"`
	// 摘要内容 全半角文字 該当データがない場合は項目自体を設定しません
	Remarks string `json:"remarks,omitempty"`
	// 明細キー 半角数字 口座ID毎に設定される明細キー(明細データtimestamp(μs))
	ItemKey string `json:"itemKey"`


type WebhooksApiService

type WebhooksApiService service

func (*WebhooksApiService) AccountsUsing

func (a *WebhooksApiService) AccountsUsing(ctx context.Context, authorization string, body SubscribeRequestBody) (*http.Response, error)

WebhooksApiService 通知配信制御 指定したイベント通知に対応するイベント通知(WebHook)の配信開始、配信停止をコントロールします

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authorization 認証情報 銀行システムが配信先システムに発行した、クライアントIDとクライアントシーレットを\":\"(コロン)で連結し、Base64エンコードした値を設定 minLength: ‐ maxLength: ‐
  • @param body HTTPリクエストボディ

func (*WebhooksApiService) AccountsUsingGET

func (a *WebhooksApiService) AccountsUsingGET(ctx context.Context, authorization string) (VaDepositTransactionUnsentResponse, *http.Response, error)

WebhooksApiService 振込入金口座未送信明細取得 配信停止状態となっている場合、本APIを利用することで未送信または送信エラーとなっている、振込入金口座の入金明細を一括で取得することができます 通常、未送信または送信エラーとなっている明細は配信再開後に通知されますが、本APIで取得された明細は配信済みとなるため、配信再開後には通知されません 未送信または送信エラーとなっている明細が無い場合は404 Not Foundを返却します <p><font color=\"red\">※法人口座および個人事業主口座のみ対象となり、個人口座は対象外となります</font></p> <h4 style='margin-top:30px; border-left: solid 4px #1B2F48; padding: 0.1em 0.5em; color:#1B2F48;'>詳細説明</h4> <div style='margin:10px;'> <p style='font-weight:bold; color:#616161;'>取得上限件数</p> <p style='padding-left:20px;'>500件</p> <p style='padding-left:20px;'>取得できる明細数が500に満たないときは取得できる明細のみを返却します</p> <p style='padding-left:20px;'>取得できた明細数が500件の場合、まだ取得できる明細が残っている可能性がありますので、</p> <p style='padding-left:20px;'>「404:Not Found」が返却されるまで、リクエストを繰り返してください。</p> </div>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authorization 認証情報 銀行システムが配信先システムに発行した、クライアントIDとクライアントシーレットを\":\"(コロン)で連結し、Base64エンコードした値を設定 minLength: ‐ maxLength: ‐

@return VaDepositTransactionUnsentResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL