Module: Checkbook

Defined in:
lib/checkbook/version.rb,
lib/checkbook.rb,
lib/checkbook/api/vcc.rb,
lib/checkbook/api/bank.rb,
lib/checkbook/api/card.rb,
lib/checkbook/api/user.rb,
lib/checkbook/api/wire.rb,
lib/checkbook/api/venmo.rb,
lib/checkbook/api_error.rb,
lib/checkbook/api/paypal.rb,
lib/checkbook/api/wallet.rb,
lib/checkbook/api_client.rb,
lib/checkbook/models/pin.rb,
lib/checkbook/models/vcc.rb,
lib/checkbook/api/interac.rb,
lib/checkbook/api/invoice.rb,
lib/checkbook/api/mailbox.rb,
lib/checkbook/api/payment.rb,
lib/checkbook/models/bank.rb,
lib/checkbook/models/card.rb,
lib/checkbook/models/user.rb,
lib/checkbook/api/approval.rb,
lib/checkbook/models/brand.rb,
lib/checkbook/models/check.rb,
lib/checkbook/models/color.rb,
lib/checkbook/models/error.rb,
lib/checkbook/api/checkbook.rb,
lib/checkbook/api/directory.rb,
lib/checkbook/configuration.rb,
lib/checkbook/models/button.rb,
lib/checkbook/models/number.rb,
lib/checkbook/models/wallet.rb,
lib/checkbook/api_model_base.rb,
lib/checkbook/models/address.rb,
lib/checkbook/models/numbers.rb,
lib/checkbook/models/options.rb,
lib/checkbook/models/payment.rb,
lib/checkbook/models/approval.rb,
lib/checkbook/models/file_row.rb,
lib/checkbook/models/merchant.rb,
lib/checkbook/api/subscription.rb,
lib/checkbook/models/developer.rb,
lib/checkbook/models/attachment.rb,
lib/checkbook/models/mfa_option.rb,
lib/checkbook/models/iav_account.rb,
lib/checkbook/models/institution.rb,
lib/checkbook/models/login_field.rb,
lib/checkbook/models/vcc_address.rb,
lib/checkbook/models/card_address.rb,
lib/checkbook/models/counterparty.rb,
lib/checkbook/models/bank_settings.rb,
lib/checkbook/models/check_address.rb,
lib/checkbook/models/iavmfa_schema.rb,
lib/checkbook/models/mail_response.rb,
lib/checkbook/models/plaid_account.rb,
lib/checkbook/models/user_response.rb,
lib/checkbook/models/brand_response.rb,
lib/checkbook/models/check_response.rb,
lib/checkbook/models/check_settings.rb,
lib/checkbook/models/multi_file_row.rb,
lib/checkbook/models/parsed_address.rb,
lib/checkbook/models/tracking_event.rb,
lib/checkbook/models/approval_number.rb,
lib/checkbook/models/mailbox_address.rb,
lib/checkbook/models/multi_recipient.rb,
lib/checkbook/models/tracking_number.rb,
lib/checkbook/models/vcc_transaction.rb,
lib/checkbook/models/address_response.rb,
lib/checkbook/models/api_key_response.rb,
lib/checkbook/models/get_vcc_response.rb,
lib/checkbook/models/iav_login_schema.rb,
lib/checkbook/models/invoice_file_row.rb,
lib/checkbook/models/checkbook_address.rb,
lib/checkbook/models/csv_check_request.rb,
lib/checkbook/models/digital_recipient.rb,
lib/checkbook/models/directory_account.rb,
lib/checkbook/models/directory_address.rb,
lib/checkbook/models/get_mail_response.rb,
lib/checkbook/models/get_user_response.rb,
lib/checkbook/models/get_wire_response.rb,
lib/checkbook/models/iav_plaid_request.rb,
lib/checkbook/models/merchant_response.rb,
lib/checkbook/models/remittance_advice.rb,
lib/checkbook/models/signature_request.rb,
lib/checkbook/models/approval_recipient.rb,
lib/checkbook/models/create_card_intent.rb,
lib/checkbook/models/create_vcc_request.rb,
lib/checkbook/models/csv_check_response.rb,
lib/checkbook/models/get_banks_response.rb,
lib/checkbook/models/get_cards_response.rb,
lib/checkbook/models/get_check_response.rb,
lib/checkbook/models/get_venmo_response.rb,
lib/checkbook/models/iav_login_response.rb,
lib/checkbook/models/iav_plaid_response.rb,
lib/checkbook/models/inline_response200.rb,
lib/checkbook/models/invoice_attachment.rb,
lib/checkbook/models/mfa_response_field.rb,
lib/checkbook/models/update_vcc_request.rb,
lib/checkbook/models/vcc_query_response.rb,
lib/checkbook/models/bank_verify_request.rb,
lib/checkbook/models/create_bank_request.rb,
lib/checkbook/models/create_card_request.rb,
lib/checkbook/models/create_user_request.rb,
lib/checkbook/models/create_vcc_response.rb,
lib/checkbook/models/create_wire_request.rb,
lib/checkbook/models/csv_invoice_request.rb,
lib/checkbook/models/get_checks_response.rb,
lib/checkbook/models/get_paypal_response.rb,
lib/checkbook/models/mfa_selection_field.rb,
lib/checkbook/models/new_api_key_request.rb,
lib/checkbook/models/pay_invoice_request.rb,
lib/checkbook/models/update_bank_request.rb,
lib/checkbook/models/update_card_request.rb,
lib/checkbook/models/update_user_request.rb,
lib/checkbook/models/update_wire_request.rb,
lib/checkbook/models/user_query_response.rb,
lib/checkbook/models/user_response_query.rb,
lib/checkbook/models/verify_user_request.rb,
lib/checkbook/models/bank_release_request.rb,
lib/checkbook/models/create_bank_response.rb,
lib/checkbook/models/create_card_response.rb,
lib/checkbook/models/create_user_response.rb,
lib/checkbook/models/create_venmo_request.rb,
lib/checkbook/models/csv_invoice_response.rb,
lib/checkbook/models/get_api_key_response.rb,
lib/checkbook/models/get_interac_response.rb,
lib/checkbook/models/get_invoice_response.rb,
lib/checkbook/models/get_wallets_response.rb,
lib/checkbook/models/new_api_key_response.rb,
lib/checkbook/models/pay_invoice_response.rb,
lib/checkbook/models/subscription_address.rb,
lib/checkbook/models/update_check_request.rb,
lib/checkbook/models/update_venmo_request.rb,
lib/checkbook/models/verify_check_request.rb,
lib/checkbook/models/api_key_list_response.rb,
lib/checkbook/models/convert_check_request.rb,
lib/checkbook/models/create_paypal_request.rb,
lib/checkbook/models/create_wallet_request.rb,
lib/checkbook/models/csv_approval_response.rb,
lib/checkbook/models/deposit_check_request.rb,
lib/checkbook/models/endorse_check_request.rb,
lib/checkbook/models/get_approval_response.rb,
lib/checkbook/models/get_invoices_response.rb,
lib/checkbook/models/number140416527981344.rb,
lib/checkbook/models/post_bank_iav_request.rb,
lib/checkbook/models/preview_check_request.rb,
lib/checkbook/models/provision_vcc_request.rb,
lib/checkbook/models/register_user_request.rb,
lib/checkbook/models/release_check_request.rb,
lib/checkbook/models/update_paypal_request.rb,
lib/checkbook/models/update_wallet_request.rb,
lib/checkbook/models/verify_check_response.rb,
lib/checkbook/models/wire_account_response.rb,
lib/checkbook/models/base_checkbook_request.rb,
lib/checkbook/models/create_interac_request.rb,
lib/checkbook/models/create_invoice_request.rb,
lib/checkbook/models/create_wallet_response.rb,
lib/checkbook/models/get_approvals_response.rb,
lib/checkbook/models/get_checkbook_response.rb,
lib/checkbook/models/get_mailboxes_response.rb,
lib/checkbook/models/numbers140416527982288.rb,
lib/checkbook/models/parsed_address_address.rb,
lib/checkbook/models/preview_check_response.rb,
lib/checkbook/models/provision_vcc_response.rb,
lib/checkbook/models/update_interac_request.rb,
lib/checkbook/models/venmo_account_response.rb,
lib/checkbook/models/create_invoice_response.rb,
lib/checkbook/models/create_mailbox_response.rb,
lib/checkbook/models/csv_multi_check_request.rb,
lib/checkbook/models/get_checkbooks_response.rb,
lib/checkbook/models/paypal_account_response.rb,
lib/checkbook/models/trigger_webhook_request.rb,
lib/checkbook/models/update_approval_request.rb,
lib/checkbook/models/update_merchant_address.rb,
lib/checkbook/models/create_directory_request.rb,
lib/checkbook/models/get_directories_response.rb,
lib/checkbook/models/interac_account_response.rb,
lib/checkbook/models/physical_check_recipient.rb,
lib/checkbook/models/update_directory_address.rb,
lib/checkbook/models/update_directory_request.rb,
lib/checkbook/models/update_principal_address.rb,
lib/checkbook/models/validate_address_request.rb,
lib/checkbook/models/create_directory_response.rb,
lib/checkbook/models/directory_request_address.rb,
lib/checkbook/models/get_check_failed_response.rb,
lib/checkbook/models/get_institutions_response.rb,
lib/checkbook/models/get_subscription_response.rb,
lib/checkbook/models/merchant_response_address.rb,
lib/checkbook/models/validate_address_response.rb,
lib/checkbook/models/vcc_transactions_response.rb,
lib/checkbook/models/create_multi_check_request.rb,
lib/checkbook/models/get_subscriptions_response.rb,
lib/checkbook/models/create_card_intent_response.rb,
lib/checkbook/models/create_direct_check_request.rb,
lib/checkbook/models/update_subscription_request.rb,
lib/checkbook/models/create_digital_check_request.rb,
lib/checkbook/models/create_instant_check_request.rb,
lib/checkbook/models/create_subscription_response.rb,
lib/checkbook/models/get_check_deposited_response.rb,
lib/checkbook/models/preview_check_request_number.rb,
lib/checkbook/models/trigger_user_webhook_request.rb,
lib/checkbook/models/create_directory_bank_request.rb,
lib/checkbook/models/create_directory_card_request.rb,
lib/checkbook/models/create_physical_check_request.rb,
lib/checkbook/models/create_directory_bank_response.rb,
lib/checkbook/models/create_directory_card_response.rb,
lib/checkbook/models/create_check_subscription_request.rb,
lib/checkbook/models/create_invoice_request_attachment.rb,
lib/checkbook/models/create_direct_check_request_number.rb,
lib/checkbook/models/create_digital_check_request_number.rb,
lib/checkbook/models/create_invoice_subscription_request.rb,
lib/checkbook/models/get_check_tracking_response_express.rb,
lib/checkbook/models/create_physical_check_request_number.rb,
lib/checkbook/models/create_digital_check_request_recipient.rb,
lib/checkbook/models/create_subscription_response_recipient.rb,
lib/checkbook/models/create_digital_check_request_attachment.rb,
lib/checkbook/models/get_check_tracking_response_first_class.rb,
lib/checkbook/models/get_checkbook_tracking_response_express.rb,
lib/checkbook/models/create_check_subscription_request_recipient.rb,
lib/checkbook/models/get_checkbook_tracking_response_first_class.rb,
lib/checkbook/models/create_physical_check_request_remittance_advice.rb

Overview

#Checkbook API

#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.

The version of the OpenAPI document: 3.0.0 Contact: support@checkbook.io Generated by: openapi-generator.tech Generator version: 7.16.0

Defined Under Namespace

Modules: ApprovalNumber, ApprovalRecipient, CreateCheckSubscriptionRequestRecipient, CreateDigitalCheckRequestAttachment, CreateDigitalCheckRequestNumber, CreateDigitalCheckRequestRecipient, CreateDirectCheckRequestNumber, CreateInvoiceRequestAttachment, CreatePhysicalCheckRequestNumber, CreatePhysicalCheckRequestRemittanceAdvice, CreateSubscriptionResponseRecipient, ParsedAddressAddress, PostBankIavRequest, PreviewCheckRequestNumber Classes: APIKeyListResponse, APIKeyResponse, Address, AddressResponse, ApiClient, ApiError, ApiModelBase, Approval, Attachment, Bank, BankReleaseRequest, BankSettings, BankVerifyRequest, BaseCheckbookRequest, Brand, BrandResponse, Button, Card, CardAddress, Check, CheckAddress, CheckResponse, CheckSettings, Checkbook, CheckbookAddress, Color, Configuration, ConvertCheckRequest, Counterparty, CreateBankRequest, CreateBankResponse, CreateCardIntent, CreateCardIntentResponse, CreateCardRequest, CreateCardResponse, CreateCheckSubscriptionRequest, CreateDigitalCheckRequest, CreateDirectCheckRequest, CreateDirectoryBankRequest, CreateDirectoryBankResponse, CreateDirectoryCardRequest, CreateDirectoryCardResponse, CreateDirectoryRequest, CreateDirectoryResponse, CreateInstantCheckRequest, CreateInteracRequest, CreateInvoiceRequest, CreateInvoiceResponse, CreateInvoiceSubscriptionRequest, CreateMailboxResponse, CreateMultiCheckRequest, CreatePaypalRequest, CreatePhysicalCheckRequest, CreateSubscriptionResponse, CreateUserRequest, CreateUserResponse, CreateVccRequest, CreateVccResponse, CreateVenmoRequest, CreateWalletRequest, CreateWalletResponse, CreateWireRequest, CsvApprovalResponse, CsvCheckRequest, CsvCheckResponse, CsvInvoiceRequest, CsvInvoiceResponse, CsvMultiCheckRequest, DepositCheckRequest, Developer, DigitalRecipient, Directory, DirectoryAccount, DirectoryAddress, DirectoryRequestAddress, EndorseCheckRequest, Error, FileRow, GetApiKeyResponse, GetApprovalResponse, GetApprovalsResponse, GetBanksResponse, GetCardsResponse, GetCheckDepositedResponse, GetCheckFailedResponse, GetCheckResponse, GetCheckTrackingResponseExpress, GetCheckTrackingResponseFirstClass, GetCheckbookResponse, GetCheckbookTrackingResponseExpress, GetCheckbookTrackingResponseFirstClass, GetCheckbooksResponse, GetChecksResponse, GetDirectoriesResponse, GetInstitutionsResponse, GetInteracResponse, GetInvoiceResponse, GetInvoicesResponse, GetMailResponse, GetMailboxesResponse, GetPaypalResponse, GetSubscriptionResponse, GetSubscriptionsResponse, GetUserResponse, GetVccResponse, GetVenmoResponse, GetWalletsResponse, GetWireResponse, IAVAccount, IAVLoginResponse, IAVLoginSchema, IAVMFASchema, IAVPlaidRequest, IAVPlaidResponse, InlineResponse200, Institution, Interac, InteracAccountResponse, Invoice, InvoiceAttachment, InvoiceFileRow, LoginField, MFAOption, MailResponse, Mailbox, MailboxAddress, Merchant, MerchantResponse, MerchantResponseAddress, MfaResponseField, MfaSelectionField, MultiFileRow, MultiRecipient, NewApiKeyRequest, NewApiKeyResponse, Number, Number140416527981344, Numbers, Numbers140416527982288, Options, ParsedAddress, PayInvoiceRequest, PayInvoiceResponse, Payment, Paypal, PaypalAccountResponse, PhysicalCheckRecipient, Pin, PlaidAccount, PreviewCheckRequest, PreviewCheckResponse, ProvisionVccRequest, ProvisionVccResponse, RegisterUserRequest, ReleaseCheckRequest, RemittanceAdvice, SignatureRequest, Subscription, SubscriptionAddress, TrackingEvent, TrackingNumber, TriggerUserWebhookRequest, TriggerWebhookRequest, UpdateApprovalRequest, UpdateBankRequest, UpdateCardRequest, UpdateCheckRequest, UpdateDirectoryAddress, UpdateDirectoryRequest, UpdateInteracRequest, UpdateMerchantAddress, UpdatePaypalRequest, UpdatePrincipalAddress, UpdateSubscriptionRequest, UpdateUserRequest, UpdateVccRequest, UpdateVenmoRequest, UpdateWalletRequest, UpdateWireRequest, User, UserQueryResponse, UserResponse, UserResponseQuery, ValidateAddressRequest, ValidateAddressResponse, Vcc, VccAddress, VccQueryResponse, VccTransaction, VccTransactionsResponse, Venmo, VenmoAccountResponse, VerifyCheckRequest, VerifyCheckResponse, VerifyUserRequest, Wallet, Wire, WireAccountResponse

Constant Summary collapse

VERSION = 
'1.0.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Checkbook.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



247
248
249
250
251
252
253
 
# File 'lib/checkbook.rb', line 247

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end