Go API client for coreapi

Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 3.0.11
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import coreapi "github.com/tendant/marqeta-client/coreapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), coreapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), coreapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), coreapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), coreapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to /v3

Class	Method	HTTP request	Description
BusinessTransitionsAPI	GetBusinesstransitionsBusinessBusinesstoken	Get /businesstransitions/business/{business_token}	List business transitions
BusinessTransitionsAPI	GetBusinesstransitionsToken	Get /businesstransitions/{token}	Retrieve business transition
BusinessTransitionsAPI	PostBusinesstransitions	Post /businesstransitions	Create business transition
BusinessesAPI	GetBusinesses	Get /businesses	List businesses
BusinessesAPI	GetBusinessesParenttokenChildren	Get /businesses/{parent_token}/children	List business children
BusinessesAPI	GetBusinessesToken	Get /businesses/{token}	Retrieve business
BusinessesAPI	GetBusinessesTokenSsn	Get /businesses/{token}/ssn	Retrieve business identification number
BusinessesAPI	PostBusinesses	Post /businesses	Create business
BusinessesAPI	PostBusinessesLookup	Post /businesses/lookup	Search businesses
BusinessesAPI	PutBusinessesToken	Put /businesses/{token}	Update business
CardTransitionsAPI	GetCardtransitionsCardToken	Get /cardtransitions/card/{token}	List transitions for card
CardTransitionsAPI	GetCardtransitionsToken	Get /cardtransitions/{token}	Retrieve card transition
CardTransitionsAPI	PostCardtransitions	Post /cardtransitions	Create card transition
CardsAPI	GetCards	Get /cards	List cards by last 4 digits of PAN
CardsAPI	GetCardsBarcodeBarcode	Get /cards/barcode/{barcode}	Retrieve card by barcode
CardsAPI	GetCardsToken	Get /cards/{token}	Retrieve card
CardsAPI	GetCardsTokenShowpan	Get /cards/{token}/showpan	Show card PAN
CardsAPI	GetCardsUserToken	Get /cards/user/{token}	List cards for user
CardsAPI	PostCards	Post /cards	Create card
CardsAPI	PostCardsGetbypan	Post /cards/getbypan	Retrieve card by PAN
CardsAPI	PutCardsToken	Put /cards/{token}	Update card
DigitalWalletsManagementAPI	GenerateApplePayWPPJWT	Post /digitalwallets/wpp/applePayJWT	Create request for Apple Wallet web push provisioning
DigitalWalletsManagementAPI	GetDigitalwallettokens	Get /digitalwallettokens	List digital wallet tokens
DigitalWalletsManagementAPI	GetDigitalwallettokensCardCardtoken	Get /digitalwallettokens/card/{card_token}	List digital wallet tokens for card
DigitalWalletsManagementAPI	GetDigitalwallettokensToken	Get /digitalwallettokens/{token}	Retrieve digital wallet token
DigitalWalletsManagementAPI	GetDigitalwallettokensTokenShowtokenpan	Get /digitalwallettokens/{token}/showtokenpan	Retrieve digital wallet token PAN
DigitalWalletsManagementAPI	GetDigitalwallettokentransitionsDigitalwallettokenToken	Get /digitalwallettokentransitions/digitalwallettoken/{token}	List transitions for digital wallet token
DigitalWalletsManagementAPI	GetDigitalwallettokentransitionsToken	Get /digitalwallettokentransitions/{token}	Retrieve digital wallet token transition
DigitalWalletsManagementAPI	PostDigitalwalletprovisionrequestsAndroidpay	Post /digitalwalletprovisionrequests/androidpay	Create digital wallet token provisioning request for Google Wallet
DigitalWalletsManagementAPI	PostDigitalwalletprovisionrequestsApplepay	Post /digitalwalletprovisionrequests/applepay	Create digital wallet token provisioning request for Apple Wallet
DigitalWalletsManagementAPI	PostDigitalwalletprovisionrequestsSamsungpay	Post /digitalwalletprovisionrequests/samsungpay	Create digital wallet token provisioning request for Samsung Wallet
DigitalWalletsManagementAPI	PostDigitalwalletprovisionrequestsXPay	Post /digitalwalletprovisionrequests/xpay	Create digital wallet token provisioning request for XPay
DigitalWalletsManagementAPI	PostDigitalwallettokentransitions	Post /digitalwallettokentransitions	Create digital wallet token transition
DigitalWalletsManagementAPI	SendOPCDataToGooglePay	Post /digitalwallets/wpp/googlePayPushProvisioningNotification	Create request for Google Wallet web push provisioning
FeeChargesAPI	GetFeeChargeToken	Get /feecharges/{token}	Retrieve fee charge
FeeChargesAPI	PostFeeCharge	Post /feecharges	Create fee charge
FeeRefundsAPI	PostFeeRefunds	Post /feerefunds	Create fee refund
FeesAPI	GetFees	Get /fees	List fees
FeesAPI	GetFeesToken	Get /fees/{token}	Retrieve fee
FeesAPI	PostFees	Post /fees	Create fee
FeesAPI	PutFeesToken	Put /fees/{token}	Update fee
PingAPI	GetPing	Get /ping	Returns a heartbeat to the consumer
PingAPI	PostPing	Post /ping	Echo test for sending payload to server
SimulationsCardTransactionsAPI	AccountFundingAuthPlusCaptureEvent	Post /simulations/cardtransactions/account.funding.auth_plus_capture	Simulate AFT authorization and capture
SimulationsCardTransactionsAPI	AccountFundingAuthPlusCaptureReversalEvent	Post /simulations/cardtransactions/account.funding.auth_plus_capture.reversal	Simulate AFT authorization and capture reversal
SimulationsCardTransactionsAPI	AccountFundingAuthorizationClearingEvent	Post /simulations/cardtransactions/account.funding.authorization.clearing	Simulate AFT authorization clearing
SimulationsCardTransactionsAPI	AccountFundingAuthorizationEvent	Post /simulations/cardtransactions/account.funding.authorization	Simulate AFT authorization
SimulationsCardTransactionsAPI	AccountFundingAuthorizationReversalEvent	Post /simulations/cardtransactions/account.funding.authorization.reversal	Simulate AFT authorization reversal
SimulationsCardTransactionsAPI	AuthorizationAdviceEvent	Post /simulations/cardtransactions/authorization.advice	Simulate authorization advice
SimulationsCardTransactionsAPI	AuthorizationAtmWithdrawalEvent	Post /simulations/cardtransactions/authorization.atm.withdrawal	Simulate ATM withdrawal authorization
SimulationsCardTransactionsAPI	AuthorizationCashbackEvent	Post /simulations/cardtransactions/authorization.cashback	Simulate authorization cash back
SimulationsCardTransactionsAPI	AuthorizationClearingAtmWithdrawalEvent	Post /simulations/cardtransactions/authorization.clearing.atm.withdrawal	Simulate ATM withdrawal authorization clearing
SimulationsCardTransactionsAPI	AuthorizationClearingEvent	Post /simulations/cardtransactions/authorization.clearing	Simulate authorization clearing
SimulationsCardTransactionsAPI	AuthorizationClearingQuasiCashEvent	Post /simulations/cardtransactions/authorization.clearing.quasi.cash	Simulate quasi-cash authorization clearing
SimulationsCardTransactionsAPI	AuthorizationEvent	Post /simulations/cardtransactions/authorization	Simulate authorization
SimulationsCardTransactionsAPI	AuthorizationIncrementalEvent	Post /simulations/cardtransactions/authorization.incremental	Simulate incremental authorization
SimulationsCardTransactionsAPI	AuthorizationQuasiCashEvent	Post /simulations/cardtransactions/authorization.quasi.cash	Simulate quasi-cash authorization
SimulationsCardTransactionsAPI	AuthorizationReversalEvent	Post /simulations/cardtransactions/authorization.reversal	Simulate authorization reversal
SimulationsCardTransactionsAPI	RefundAuthorizationClearingEvent	Post /simulations/cardtransactions/refund.authorization.clearing	Simulate refund authorization clearing
SimulationsCardTransactionsAPI	RefundAuthorizationEvent	Post /simulations/cardtransactions/refund.authorization	Simulate refund authorization
SimulationsCardTransactionsAPI	RefundAuthorizationReversalEvent	Post /simulations/cardtransactions/refund.authorization.reversal	Simulate refund authorization reversal
SimulationsCardTransactionsAPI	RefundEvent	Post /simulations/cardtransactions/refund	Simulate refund
TransactionsAPI	GetTransactions	Get /transactions	List transactions
TransactionsAPI	GetTransactionsFundingsourceFundingsourcetoken	Get /transactions/fundingsource/{funding_source_token}	List transactions for a funding account
TransactionsAPI	GetTransactionsToken	Get /transactions/{token}	Retrieve transaction
TransactionsAPI	GetTransactionsTokenRelated	Get /transactions/{token}/related	List related transactions
UserTransitionsAPI	GetUsertransitionsToken	Get /usertransitions/{token}	Retrieve user transition
UserTransitionsAPI	GetUsertransitionsUserUsertoken	Get /usertransitions/user/{user_token}	List transitions for user
UserTransitionsAPI	PostUsertransitions	Post /usertransitions	Create user transition
UsersAPI	GetUsers	Get /users	List users
UsersAPI	GetUsersAuthClientaccesstokenToken	Get /users/auth/clientaccesstoken/{token}	Retrieve client access token
UsersAPI	GetUsersParenttokenChildren	Get /users/{parent_token}/children	List user child accounts
UsersAPI	GetUsersToken	Get /users/{token}	Retrieve user
UsersAPI	GetUsersTokenSsn	Get /users/{token}/ssn	Retrieve user identification number
UsersAPI	PostUsers	Post /users	Create user
UsersAPI	PostUsersAuthChangepassword	Post /users/auth/changepassword	Update user password
UsersAPI	PostUsersAuthClientaccesstoken	Post /users/auth/clientaccesstoken	Create client access token
UsersAPI	PostUsersAuthLogin	Post /users/auth/login	Log in user
UsersAPI	PostUsersAuthLogout	Post /users/auth/logout	Log out user
UsersAPI	PostUsersAuthOnetime	Post /users/auth/onetime	Create single-use token
UsersAPI	PostUsersAuthResetpassword	Post /users/auth/resetpassword	Request user password reset token
UsersAPI	PostUsersAuthResetpasswordToken	Post /users/auth/resetpassword/{token}	Reset user password
UsersAPI	PostUsersAuthVerifyemail	Post /users/auth/verifyemail	Request email verification token
UsersAPI	PostUsersAuthVerifyemailToken	Post /users/auth/verifyemail/{token}	Verify email address
UsersAPI	PostUsersLookup	Post /users/lookup	Search users
UsersAPI	PutUsersToken	Put /users/{token}	Update user
WebhooksAPI	GetWebhooks	Get /webhooks	List webhooks
WebhooksAPI	GetWebhooksToken	Get /webhooks/{token}	Retrieve webhook
WebhooksAPI	PostWebhooks	Post /webhooks	Create webhook
WebhooksAPI	PostWebhooksTokenEventtypeEventtoken	Post /webhooks/{token}/{event_type}/{event_token}	Resend event notification
WebhooksAPI	PostWebhooksTokenPing	Post /webhooks/{token}/ping	Ping webhook
WebhooksAPI	PutWebhooksCustomHeadersToken	Put /webhooks/customheaders/{token}	Update webhook custom headers
WebhooksAPI	PutWebhooksToken	Put /webhooks/{token}	Update webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

mqAppAndAccessToken

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

# README