Go API client for openapi

Let's build something great.

Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.

We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.

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: 0.5.0
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/oauth2
go get golang.org/x/net/context

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

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), openapi.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(), openapi.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(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.synctera.com/v0

Class	Method	HTTP request	Description
ACHApi	AddTransactionOut	Post /ach	Send an ACH
ACHApi	GetTransactionOut	Get /ach/{transaction_id}	Get a sent ACH transaction
ACHApi	ListTransactionsOut	Get /ach	List sent ACH transactions
ACHApi	PatchTransactionOut	Patch /ach/{transaction_id}	Update a sent ACH transaction
AccountsApi	CreateAccount	Post /accounts	Create an account
AccountsApi	CreateAccountRelationship	Post /accounts/{account_id}/relationships	Create account relationship
AccountsApi	CreateAccountResourceProduct	Post /accounts/products	Create an account product
AccountsApi	CreateAccountTemplate	Post /accounts/templates	Create an account template
AccountsApi	DeleteAccountRelationship	Delete /accounts/{account_id}/relationships/{relationship_id}	Delete account relationship
AccountsApi	DeleteAccountTemplate	Delete /accounts/templates/{template_id}	Delete account template
AccountsApi	GetAccount	Get /accounts/{account_id}	Get account
AccountsApi	GetAccountRelationship	Get /accounts/{account_id}/relationships/{relationship_id}	Get account relationship
AccountsApi	GetAccountTemplate	Get /accounts/templates/{template_id}	Get account template
AccountsApi	ListAccountRelationship	Get /accounts/{account_id}/relationships	List account relationships
AccountsApi	ListAccountResourceProducts	Get /accounts/products	List account products
AccountsApi	ListAccountTemplates	Get /accounts/templates	List account templates
AccountsApi	ListAccounts	Get /accounts	List accounts
AccountsApi	PatchAccount	Patch /accounts/{account_id}	Patch account
AccountsApi	PatchAccountProduct	Patch /accounts/products/{product_id}	Patch account product
AccountsApi	UpdateAccount	Put /accounts/{account_id}	Update account
AccountsApi	UpdateAccountRelationship	Put /accounts/{account_id}/relationships/{relationship_id}	Update account relationship
AccountsApi	UpdateAccountTemplate	Put /accounts/templates/{template_id}	Update account template
BusinessesApi	CreateBusiness	Post /businesses	Create a business
BusinessesApi	GetBusiness	Get /businesses/{business_id}	Get business
BusinessesApi	ListBusinesses	Get /businesses	List business
BusinessesApi	UpdateBusiness	Patch /businesses/{business_id}	Patch business
CardTransactionSimulationsApi	SimulateAuthorization	Post /cards/transaction_simulations/authorization	Simulate authorization
CardTransactionSimulationsApi	SimulateAuthorizationAdvice	Post /cards/transaction_simulations/authorization/advice	Simulate authorization advice
CardTransactionSimulationsApi	SimulateBalanceInquiry	Post /cards/transaction_simulations/financial/balance_inquiry	Simulate balance inquiry
CardTransactionSimulationsApi	SimulateClearing	Post /cards/transaction_simulations/clearing	Simulate clearing or refund
CardTransactionSimulationsApi	SimulateFinancial	Post /cards/transaction_simulations/financial	Simulate financial
CardTransactionSimulationsApi	SimulateFinancialAdvice	Post /cards/transaction_simulations/financial/advice	Simulate financial advice
CardTransactionSimulationsApi	SimulateOriginalCredit	Post /cards/transaction_simulations/financial/original_credit	Simulate OCT
CardTransactionSimulationsApi	SimulateReversal	Post /cards/transaction_simulations/reversal	Simulate reversal
CardTransactionSimulationsApi	SimulateWithdrawal	Post /cards/transaction_simulations/financial/withdrawal	Simulate ATM withdrawal
CardWebhookSimulationsApi	SimulateCardFulfillmentEvent	Post /cards/{card_id}/webhook_simulations/fulfillment	Simulate Card Fulfillment Event
CardsApi	ActivateCard	Post /cards/activate	Activate a card
CardsApi	CreateCardImage	Post /cards/images	Create Card Image
CardsApi	CreateGateway	Post /cards/gateways	Create Gateway
CardsApi	GetCard	Get /cards/{card_id}	Get Card
CardsApi	GetCardBarcode	Get /cards/{card_id}/barcodes	Get Card Barcode
CardsApi	GetCardImageData	Get /cards/images/{card_image_id}/data	Get Card Image Data
CardsApi	GetCardImageDetails	Get /cards/images/{card_image_id}	Get Card Image Details
CardsApi	GetCardWidgetURL	Get /cards/card_widget_url	Get card widget URL
CardsApi	GetClientAccessToken	Post /cards/{card_id}/client_token	Get a client token
CardsApi	GetClientSingleUseToken	Post /cards/single_use_token	Get single-use token
CardsApi	GetGateway	Get /cards/gateways/{gateway_id}	Get Gateway
CardsApi	IssueCard	Post /cards	Issue a Card
CardsApi	ListCardImageDetails	Get /cards/images	List Card Image Details
CardsApi	ListCardProducts	Get /cards/products	List Card Products
CardsApi	ListCards	Get /cards	List Cards
CardsApi	ListChanges	Get /cards/{card_id}/changes	List Card Changes
CardsApi	ListGateways	Get /cards/gateways	List Gateways
CardsApi	UpdateCard	Patch /cards/{card_id}	Update Card
CardsApi	UpdateCardImageDetails	Patch /cards/images/{card_image_id}	Update Card Image Details
CardsApi	UpdateGateway	Patch /cards/gateways/{gateway_id}	Update Gateway
CardsApi	UploadCardImageData	Post /cards/images/{card_image_id}/data	Upload Card Image
CashPickupsAlphaApi	CreateCashPickup	Post /cash_pickups	Create a cash pickup
CashPickupsAlphaApi	GetCashPickup	Get /cash_pickups/{cash_pickup_id}	Get a cash pickup
CashPickupsAlphaApi	ListCashPickups	Get /cash_pickups	List cash pickups
CashPickupsAlphaApi	PatchCashPickup	Patch /cash_pickups/{cash_pickup_id}	Update a cash pickup
CustomersApi	CreateCustomer	Post /customers	Create a Customer
CustomersApi	CreateCustomerEmployment	Post /customers/{customer_id}/employment	Create employment record
CustomersApi	CreateCustomerRiskRating	Post /customers/{customer_id}/risk_ratings	Create customer risk rating
CustomersApi	GetAllCustomerEmployment	Get /customers/{customer_id}/employment	List customer employment records
CustomersApi	GetAllCustomerRiskRatings	Get /customers/{customer_id}/risk_ratings	List customer risk ratings
CustomersApi	GetCustomer	Get /customers/{customer_id}	Get Customer
CustomersApi	GetCustomerRiskRating	Get /customers/{customer_id}/risk_ratings/{risk_rating_id}	Get customer risk rating
CustomersApi	GetPartyEmployment	Get /customers/{customer_id}/employment/{employment_id}	Get customer employment record
CustomersApi	ListCustomers	Get /customers	List Customers
CustomersApi	PatchCustomer	Patch /customers/{customer_id}	Patch Customer
CustomersApi	PrefillCustomer	Post /customers/{customer_id}/prefill	Prefill customer
CustomersApi	UpdateCustomer	Put /customers/{customer_id}	Update Customer
CustomersApi	UpdatePartyEmployment	Put /customers/{customer_id}/employment/{employment_id}	Update customer employment record
DigitalWalletTokensApi	CreateDigitalWalletApple	Post /cards/{card_id}/digital_wallet_tokens/applepay	Create digital wallet token provision request for Apple Pay
DigitalWalletTokensApi	CreateDigitalWalletGoogle	Post /cards/{card_id}/digital_wallet_tokens/googlepay	Create digital wallet token provision request for Google Pay
DigitalWalletTokensApi	GetDigitalWalletToken	Get /cards/digital_wallet_tokens/{digital_wallet_token_id}	Get Digital Wallet Token
DigitalWalletTokensApi	ListDigitalWalletTokens	Get /cards/digital_wallet_tokens	List Digital Wallet Tokens
DigitalWalletTokensApi	UpdateDigitalWalletTokenStatus	Patch /cards/digital_wallet_tokens/{digital_wallet_token_id}	Update Digital Wallet Token's life cycle status
DisclosuresApi	CreateDisclosure	Post /disclosures	Create disclosure record
DisclosuresApi	GetDisclosure	Get /disclosures/{disclosure_id}	Get disclosure
DisclosuresApi	ListDisclosures	Get /disclosures	List disclosures
DisclosuresDeprecatedApi	CreateDisclosure1	Post /customers/{customer_id}/disclosures	Create a Disclosure
DisclosuresDeprecatedApi	ListDisclosures1	Get /customers/{customer_id}/disclosures	List Disclosures
DocumentsAlphaApi	CreateDocument	Post /documents	Create a document
DocumentsAlphaApi	GetDocument	Get /documents/{document_id}	Get a document
DocumentsAlphaApi	GetDocumentContents	Get /documents/{document_id}/contents	Get document contents
DocumentsAlphaApi	ListDocuments	Get /documents	List documents
DocumentsAlphaApi	UpdateDocument	Patch /documents/{document_id}	Update a document
ExternalAccountsApi	AddExternalAccounts	Post /external_accounts	Add an external account
ExternalAccountsApi	AddVendorExternalAccounts	Post /external_accounts/add_vendor_accounts	Add external accounts through a vendor, such as Plaid.
ExternalAccountsApi	CreateAccessToken	Post /external_accounts/access_tokens	Create a permanent access token for an external account
ExternalAccountsApi	CreateVerificationLinkToken	Post /external_accounts/link_tokens	Create a link token to verify an external account
ExternalAccountsApi	DeleteExternalAccount	Delete /external_accounts/{external_account_id}	Delete an external account
ExternalAccountsApi	GetExternalAccount	Get /external_accounts/{external_account_id}	Get an external account
ExternalAccountsApi	GetExternalAccountBalance	Get /external_accounts/{external_account_id}/balance	Get an external account balance
ExternalAccountsApi	GetExternalAccountTransactions	Get /external_accounts/{external_account_id}/transactions	List transactions of a given external account
ExternalAccountsApi	ListExternalAccounts	Get /external_accounts	List external accounts
ExternalAccountsApi	SyncVendorExternalAccounts	Post /external_accounts/sync_vendor_accounts	Sync external accounts through a vendor, such as Plaid.
ExternalAccountsApi	UpdateExternalAccount	Patch /external_accounts/{external_account_id}	Patch an external account
ExternalCardsAlphaApi	CreateExternalCardFromToken	Post /external_cards/tokens	Create external card from token
ExternalCardsAlphaApi	CreateExternalCardTransfer	Post /external_cards/transfers	Create external card transfer
ExternalCardsAlphaApi	CreateExternalCardTransferReversal	Post /external_cards/transfers/{transfer_id}/reversals	Reverse an external card transfer
ExternalCardsAlphaApi	GetExternalCard	Get /external_cards/{external_card_id}	Get a external card
ExternalCardsAlphaApi	GetExternalCardTransfer	Get /external_cards/transfers/{transfer_id}	Get an external card transfer
ExternalCardsAlphaApi	ListExternalCardTransfers	Get /external_cards/transfers	List external transfers
ExternalCardsAlphaApi	ListExternalCards	Get /external_cards	List external cards
InternalAccountsApi	AddInternalAccounts	Post /internal_accounts	Add internal accounts
InternalAccountsApi	ListInternalAccounts	Get /internal_accounts	List internal accounts
InternalAccountsApi	PatchInternalAccount	Patch /internal_accounts/{internal_account_id}	Patch internal account
InternalTransferApi	CreateInternalTransfer	Post /transactions/internal_transfer	Create an internal transfer
InternalTransferApi	GetInternalTransferByID	Get /transactions/internal_transfer/{id}	Get an internal transfer
InternalTransferApi	UpdateInternalTransferByID	Patch /transactions/internal_transfer/{id}	Update an internal transfer
KYCKYBVerificationsApi	CreateVerification	Post /verifications	Create a verification
KYCKYBVerificationsApi	GetVerification1	Get /verifications/{verification_id}	Get verification
KYCKYBVerificationsApi	ListVerifications1	Get /verifications	List verifications
KYCKYBVerificationsApi	Verify	Post /verifications/verify	Verify a customer's identity
KYCKYBVerificationsApi	VerifyAdHoc	Post /verifications/adhoc	Check if an individual is on any watchlists
KYCVerificationDeprecatedApi	CreateCustomerVerificationResult	Post /customers/{customer_id}/verifications	Create a customer verification result
KYCVerificationDeprecatedApi	GetVerification	Get /customers/{customer_id}/verifications/{verification_id}	Get verification result
KYCVerificationDeprecatedApi	ListVerifications	Get /customers/{customer_id}/verifications	List verification results
KYCVerificationDeprecatedApi	VerifyCustomer	Post /customers/{customer_id}/verify	Verify a customer's identity
MonitoringApi	CreateSubscription	Post /monitoring/subscriptions	Subscribe a customer or business to monitoring
MonitoringApi	DeleteSubscription	Delete /monitoring/subscriptions/{subscription_id}	Delete monitoring subscription
MonitoringApi	GetAlert	Get /monitoring/alerts/{alert_id}	Retrieve a monitoring alert
MonitoringApi	GetSubscription	Get /monitoring/subscriptions/{subscription_id}	Retrieve monitoring subscription
MonitoringApi	ListAlerts	Get /monitoring/alerts	List monitoring alerts
MonitoringApi	ListSubscriptions	Get /monitoring/subscriptions	List monitoring subscriptions
MonitoringApi	UpdateAlert	Patch /monitoring/alerts/{alert_id}	Update a monitoring alert
PaymentSchedulesApi	CreatePaymentSchedule	Post /payment_schedules	Create a payment schedule
PaymentSchedulesApi	ListPaymentSchedules	Get /payment_schedules	List payment schedules
PaymentSchedulesApi	ListPayments	Get /payment_schedules/payments	List payments
PaymentSchedulesApi	PatchPaymentSchedule	Patch /payment_schedules/{payment_schedule_id}	Update a payment schedule
PersonsApi	CreatePerson	Post /persons	Create a person
PersonsApi	GetPerson	Get /persons/{person_id}	Get person
PersonsApi	ListPersons	Get /persons	List persons
PersonsApi	PrefillPerson	Post /persons/{person_id}/prefill	Prefill person
PersonsApi	UpdatePerson	Patch /persons/{person_id}	Update person
ReconciliationsApi	CreateReconciliation	Post /reconciliations	Create a reconciliation
ReconciliationsApi	GetReconciliation	Get /reconciliations/{reconciliation_id}	Get reconciliation
ReconciliationsApi	ListReconciliations	Get /reconciliations	List reconciliations
RelationshipsApi	CreateRelationship	Post /relationships	Create a relationship
RelationshipsApi	DeleteRelationship	Delete /relationships/{relationship_id}	Delete relationship
RelationshipsApi	GetRelationship	Get /relationships/{relationship_id}	Get relationship
RelationshipsApi	ListRelationships	Get /relationships	List relationships
RelationshipsApi	UpdateRelationship	Patch /relationships/{relationship_id}	Update relationship
RemoteCheckDepositBetaApi	CreateRdcDeposit	Post /rdc/deposits	Create a Remote Check Deposit
RemoteCheckDepositBetaApi	GetRdcDeposit	Get /rdc/deposits/{deposit_id}	Get Remote Check Deposit
RemoteCheckDepositBetaApi	ListRdcDeposits	Get /rdc/deposits	List Remote Check Deposits
SandboxWipeAlphaApi	WipeWorkspace	Post /wipe	Delete data
StatementsApi	GetStatement	Get /statements/{statement_id}	Get a statement
StatementsApi	ListStatements	Get /statements	List statements
TransactionsApi	GetPendingTransactionByID	Get /transactions/pending/{id}	Get a pending transaction
TransactionsApi	GetPostedTransactionByID	Get /transactions/posted/{id}	Get a posted transaction
TransactionsApi	ListPendingTransactions	Get /transactions/pending	List pending transactions
TransactionsApi	ListPostedTransactions	Get /transactions/posted	List posted transactions
WatchlistDeprecatedApi	GetWatchlistAlert	Get /customers/{customer_id}/watchlists/alerts/{alert_id}	Retrieve watchlist monitoring alert
WatchlistDeprecatedApi	GetWatchlistSubscription	Get /customers/{customer_id}/watchlists/subscriptions/{subscription_id}	Retrieve watchlist monitoring subscription
WatchlistDeprecatedApi	ListWatchlistAlerts	Get /customers/{customer_id}/watchlists/alerts	List watchlist monitoring alerts for a customer
WatchlistDeprecatedApi	ListWatchlistSubscriptions	Get /customers/{customer_id}/watchlists/subscriptions	List watchlist monitoring subscriptions for a customer
WatchlistDeprecatedApi	SuppressWatchlistEntityAlert	Post /customers/{customer_id}/watchlists/suppressions	Suppress entity alert
WatchlistDeprecatedApi	UpdateWatchlistAlert	Put /customers/{customer_id}/watchlists/alerts/{alert_id}	Update watchlist alert
WatchlistDeprecatedApi	UpdateWatchlistSubscription	Put /customers/{customer_id}/watchlists/subscriptions/{subscription_id}	Update watchlist monitoring subscription
WatchlistDeprecatedApi	WatchlistSubscribe	Post /customers/{customer_id}/watchlists/subscriptions	Subscribe a customer to watchlist monitoring
WebhooksApi	CreateWebhook1	Post /webhooks	Create a webhook
WebhooksApi	DeleteWebhook	Delete /webhooks/{webhook_id}	Delete a webhook
WebhooksApi	GetEvent	Get /webhooks/{webhook_id}/events/{event_id}	Get webhook event
WebhooksApi	GetWebhook1	Get /webhooks/{webhook_id}	Get a webhook
WebhooksApi	ListEvents	Get /webhooks/{webhook_id}/events	List webhook events
WebhooksApi	ListWebhooks1	Get /webhooks	List webhooks
WebhooksApi	ResendEvent	Post /webhooks/{webhook_id}/events/{event_id}/resend	Resend an event
WebhooksApi	TriggerEvent	Post /webhooks/trigger	Trigger an event
WebhooksApi	UpdateWebhook	Put /webhooks/{webhook_id}	Update a webhook
WiresAlphaApi	CancelWire	Patch /wires/{wire_id}	Cancel an outgoing wire
WiresAlphaApi	CreateWire	Post /wires	Send a wire
WiresAlphaApi	GetWire	Get /wires/{wire_id}	Get a wire by id
WiresAlphaApi	ListWires	Get /wires	List wires

Documentation For Models

Documentation For Authorization

bearerAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
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

# README