gocardless

type Client struct {
	// AccessToken is the bearer token used to authenticate requests to the GoCardless API
	AccessToken string
	// RemoteURL is the address of the GoCardless API
	RemoteURL string
	// contains filtered or unexported fields
}

type Cursor struct {
	// Before ID of the object immediately following the array of objects to be returned
	Before string `json:"before"`
	// After ID of the object immediately preceding the array of objects to be returned
	After string `json:"after"`
}

type Customer struct {
	// ID is a unique identifier, beginning with “CU”.
	ID string `json:"id,omitempty"`
	// AddressLine1 is the first line of the customer’s address.
	AddressLine1 string `json:"address_line1"`
	// AddressLine2 is the first line of the customer’s address.
	AddressLine2 string `json:"address_line2"`
	// AddressLine3 is the first line of the customer’s address.
	AddressLine3 string `json:"address_line3"`
	// City is the city of the customer’s address.
	City string `json:"city"`
	// CompanyName is the customer’s company name. Required unless a given_name and family_name are provided.
	CompanyName string `json:"company_name"`
	// CountryCode is the ISO 3166-1 alpha-2 code.
	CountryCode string `json:"country_code"`
	// CreatedAt is a fixed timestamp, recording when the customer was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Email is the customer's email address
	Email string `json:"email,omitempty"`
	// FamilyName is the customer's surname. Required unless a CompanyName is provided
	FamilyName string `json:"family_name"`
	// GivenName is the customer's first name. Required unless a CompanyName is provided
	GivenName string `json:"given_name"`
	// Language is a ISO 639-1 code. Used as the language for notification emails sent by GoCardless if your
	// organisation does not send its own (see compliance requirements). Currently only “en”, “fr”, “de”, “pt”,
	// “es”, “it”, “nl”, “sv” are supported. If this is not provided, the language will be chosen based on the
	// country_code (if supplied) or default to “en”.
	Language string `json:"language,omitempty"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// PostalCode is the customers postal code
	PostalCode string `json:"postal_code"`
	// Region is the customer's address region, county or department
	Region string `json:"region"`
	// SwedishIdentityNumber is for Swedish customers only. The civic/company number (personnummer,
	// samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer’s bank
	// account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
	SwedishIdentityNumber string `json:"swedish_identity_number,omitempty"`
}

type CustomerBankAccount struct {
	// ID is a unique identifier, beginning with "BA".
	ID string `json:"id,omitempty"`
	// AccountHolderName Name of the account holder, as known by the bank.
	// Usually this matches the name of the linked customer.
	// This field will be transliterated, upcased and truncated to 18 characters.
	AccountHolderName string `json:"account_holder_name"`
	// AccountNumber Bank account number. Alternatively you can provide an iban
	AccountNumber string `json:"account_number"`
	// BankCode Bank code
	BankCode string `json:"bank_code,omitempty"`
	// BankCode Bank code
	BranchCode string `json:"branch_code"`
	// AccountNumberEnding Last two digits of account number
	AccountNumberEnding string `json:"account_number_ending,omitempty"`
	// BankName Name of bank, taken from the bank details
	BankName string `json:"bank_name,omitempty"`
	// CountryCode is the ISO 3166-1 alpha-2 code.
	CountryCode string `json:"country_code"`
	// Currency currency code, defaults to national currency of country_code
	Currency string `json:"currency,omitempty"`
	// IBAN International Bank Account Number
	IBAN string `json:"iban,omitempty"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Links links constains customers id
	Links customerLinks `json:"links"`
	// Enabled indicates if bank account is disabled
	Enabled bool `json:"enabled,omitempty"`
}

type CustomerBankAccountListResponse struct {
	CustomerBankAccounts []*CustomerBankAccount `json:"customer_bank_accounts"`
	Meta                 Meta                   `json:"meta,omitempty"`
}

type CustomerListResponse struct {
	Customers []*Customer `json:"customers"`
	Meta      Meta        `json:"meta,omitempty"`
}

type Date struct {
	Time time.Time
}

type Environment string

type Error struct {
	DocumentationURL string         `json:"documentation_url"`
	Message          string         `json:"message"`
	RequestID        string         `json:"request_id"`
	Details          []*ErrorDetail `json:"errors"`
	Type             string         `json:"type"`
	Code             int            `json:"code"`
}

type ErrorDetail struct {
	Message        string `json:"message"`
	Field          string `json:"field"`
	RequestPointer string `json:"request_pointer"`
}

type Event struct {
	// ID is a unique identifier, beginning with "PM".
	ID string `json:"id,omitempty"`
	// CreatedAt is a fixed timestamp, recording when the payment was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// ResourceType of the event is associated with
	ResourceType string `json:"resource_type,omitempty"`
	// Action performed on the resource type
	Action string `json:"action,omitempty"`
	// Links to cusomer and payment
	Links eventLinks `json:"links"`
	//
	Details struct {
		// source of event i.e. API
		Origin string `json:"origin,omitempty"`
		// description code
		Cause string `json:"cause,omitempty"`
		// long form description of the detail
		Description string `json:"description,omitempty"`
		// payment scheme
		Scheme string `json:"scheme,omitempty"`
		// scheme specfic event code
		ReasonCode string `json:"reason_code,omitempty"`
	} `json:"details"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type EventList struct {
	Events []*Event `json:"events"`
}

type InvalidEnvironment error

type Mandate struct {
	// ID is a unique identifier, beginning with “MD”.
	ID string `json:"id,omitempty"`
	// CreatedAt is a fixed timestamp, recording when the mandate was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// NextPossibleChargeDate The earliest date a newly created payment for this mandate could be charged
	NextPossibleChargeDate *Date `json:"next_possible_charge_date,omitempty"`
	// PaymentRequireApproval Boolean value showing whether payments and
	// subscriptions under this mandate require approval via an automated email before being processed
	PaymentRequireApproval bool `json:"payments_require_approval,omitempty"`
	// Reference Unique reference
	// Different schemes have different length and character set requirements
	// GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank
	Reference string `json:"reference,omitempty"`
	// Scheme Direct Debit scheme to which this mandate and associated payments are submitted
	Scheme string `json:"scheme,omitempty"`
	// Status status of mandate.
	Status string `json:"status,omitempty"`
	// Links links to cusomer and bank accounts
	Links mandateLinks `json:"links"`
}

type MandateListResponse struct {
	Mandates []*Mandate `json:"mandates"`
	Meta     Meta       `json:"meta,omitempty"`
}

type Meta struct {
	Cursors Cursor `json:"cursors"`
	// Limit Upper bound for the number of objects to be returned. Defaults to 50. Maximum of 500
	Limit int `json:"limit"`
}

type Payment struct {
	// ID is a unique identifier, beginning with "PM".
	ID string `json:"id,omitempty"`
	// Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
	// e.g 1000 is 10 GBP in pence
	Amount int `json:"amount"`
	// AmountRefunded is amount refunded in pence/cents/öre/øre.
	AmountRefunded int `json:"amount_refunded,omitempty"`
	// ChargeDate A future date on which the payment should be collected.
	// If not specified, the payment will be collected as soon as possible
	ChargeDate *Date `json:"charge_date,omitempty"`
	// CreatedAt is a fixed timestamp, recording when the payment was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Currency currency code, defaults to national currency of country_code
	Currency string `json:"currency"`
	// Description A human-readable description of the payment
	Description string `json:"description,omitempty"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Reference An optional payment reference that will appear on your customer’s bank statement
	Reference string `json:"reference,omitempty"`
	// Status status of payment.
	Status string `json:"status,omitempty"`
	// Links to cusomer and payment
	Links paymentLinks `json:"links"`
	// AppFee The amount to be deducted from the payment as the OAuth app’s fee, in pence/cents/öre/øre
	AppFee int `json:"app_fee,omitempty"`
}

type PaymentListResponse struct {
	Payments []*Payment `json:"payments"`
	Meta     Meta       `json:"meta,omitempty"`
}

type Payout struct {
	// ID is a unique identifier, beginning with "PO".
	ID string `json:"id,omitempty"`
	// Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
	// e.g 1000 is 10 GBP in pence
	Amount int `json:"amount"`
	// ArrivalDate Date the payout is due to arrive in the creditor’s bank account.
	// If not specified, the payout will be collected as soon as possible
	ArrivalDate *Date `json:"arrival_date,omitempty"`
	// Fees that have already been deducted from the payout amount in minor unit
	// e.g 1000 is 10 GBP in pence
	DeductedFees int `json:"deducted_fees"`
	// Currency currency code, defaults to national currency of country_code
	Currency string `json:"currency"`
	// CreatedAt is a fixed timestamp, recording when the payout was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Whether a payout contains merchant revenue or partner fees.
	PayoutType string `json:"payout_type,omitempty"`
	// Reference An optional payout reference that will appear on your customer’s bank statement
	Reference string `json:"reference,omitempty"`
	// Status status of payout.
	Status string `json:"status,omitempty"`
	// foreign exchange info
	FX fxInfo `json:"fx"`
	// ISO 4217 code for the currency in which tax is paid out to the tax authorities of your tax jurisdiction.
	TaxCurrency string `json:"tax_currency"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Links to cusomer and payout
	Links payoutLinks `json:"links"`
}

type PayoutListResponse struct {
	Payouts []*Payout `json:"payouts"`
	Meta    Meta      `json:"meta,omitempty"`
}

type RateLimitedExceededError struct {
}

type Redirect struct {
	// ID is a unique identifier, beginning with "RE".
	ID string `json:"id,omitempty"`
	// customer’s session token which must be provided when the redirect flow is completed.
	SessionToken string `json:"session_token"`
	// The URL to redirect to upon successful mandate setup.
	SuccessRedirectURL string `json:"success_redirect_url"`
	// The URL to redirect a customer to enter payment details.
	RedirectURL string `json:"redirect_url,omitempty"`
	// Description of the item the customer is paying for
	Description string `json:"description,omitempty"`
	// payment scheme
	Scheme string `json:"scheme,omitempty"`
	// CreatedAt is a fixed timestamp, recording when the redrect was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// prefill the details of a customer
	Customer Customer `json:"prefilled_customer"`
	// Links links to cusomer and bank accounts
	Links redirectLinks `json:"links"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Response struct {
	*http.Response
}

type Subscription struct {
	// ID is a unique identifier, beginning with "SB".
	ID string `json:"id,omitempty"`
	// CreatedAt is a fixed timestamp, recording when the subscription was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).
	// e.g 1000 is 10 GBP in pence
	Amount int `json:"amount"`
	// Currency currency code, defaults to national currency of country_code
	Currency string `json:"currency"`
	// Status status of subscription.
	Status string `json:"status,omitempty"`
	// Name of subscription.
	Name string `json:"name,omitempty"`
	// StartDate A future date on which the subscription should start.
	StartDate *Date `json:"start_date,omitempty"`
	// Number of interval_units between customer charge dates.
	Interval int `json:"interval,omitempty"`
	// The total number of payments that should be taken by this subscription.
	Count int `json:"count,omitempty"`
	// The unit of time between customer charge dates. One of weekly, monthly or yearly.
	IntervalUnit string `json:"interval_unit"`
	// As per RFC 2445. The day of the month to charge customers on. 1-28 or -1 to indicate the last day of the month.
	DayOfMonth int `json:"day_of_month,omitempty"`
	// Name of the month on which to charge a customer. Must be lowercase. Only applies when the interval_unit is yearly
	Month int `json:"month,omitempty"`
	//An optional payment reference.
	PaymentReference int `json:"payment_reference,omitempty"`
	// The amount to be deducted from each payment as an app fee
	AppFee int `json:"app_fee,omitempty"`
	//
	UpcomingPayments []subscriptionPayment `json:"upcoming_payments,omitempty"`
	// Metadata is a key-value store of custom data. Up to 3 keys are permitted, with key names up to 50
	// characters and values up to 500 characters.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Links to cusomer and payment
	Links subscriptionLinks `json:"links"`
	// On failure, automatically retry payments using intelligent retries
	Retry bool `json:"retry_if_possible,omitempty"`
}

type SubscriptionListResponse struct {
	Subscriptions []*Subscription `json:"subscriptions"`
	Meta          Meta            `json:"meta,omitempty"`
}