Modules
An idiomatic Elixir client for the Increase API, covering every resource: accounts, transfers (ACH, wire, check, RTP, FedNow, Swift), cards, entities, webhooks, and the sandbox simulation endpoints used for testing.
ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
The ACHPrenotificationNotificationsOfChange object.
If your prenotification is returned, this will contain details of the return.
ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
Additional information that will be sent to the recipient.
Unstructured payment_related_information passed through with the transfer.
The ACHTransferAddendaFreeformEntry object.
Structured ASC X12 820 remittance advice records. Please reach out to support@increase.com for more information.
The ACHTransferAddendaPaymentOrderRemittanceAdviceInvoice object.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.
The ACHTransferNotificationsOfChange object.
Configuration for how the effective date of the transfer will be set. This
determines same-day vs future-dated settlement timing. If not set, defaults
to a settlement_schedule of same_day. If set, exactly one of the child
attributes must be set.
If your transfer is returned, this will contain details of the return.
A subhash containing information about when and how the transfer settled at the Federal Reserve.
After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their posted schedule.
Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
Properties related to how this Account Number handles inbound ACH transfers.
Properties related to how this Account Number should handle inbound check withdrawals.
Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
The loan balances.
Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).
Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
The Account's loan-related information, if the Account is a loan account.
Represents a request to lookup the balance of an Account at a given point in time.
The loan balances for the Account.
Functions for working with BeneficialOwners via the Increase API.
Beneficial owners are the individuals who control or own 25% or more of a
corporation entity. Beneficial owners are always people, and never
organizations. Generally, you will need to submit between 1 and 5 beneficial
owners for every corporation entity. You should update and archive
beneficial owners for a corporation entity as their details change.
Personal details for the beneficial owner.
The person's address.
A means of verifying the person's identity.
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.
If the Card Dispute's status is lost, this will contain details of the
lost dispute.
If the Card Dispute has been rejected, this will contain details of the rejection.
Card Dispute information for card payments processed over Visa's network.
This field will be present in the JSON response if and only if network is
equal to visa.
The CardDisputeVisaUserSubmission object.
The CardDisputeVisaUserSubmissionsAttachmentFile object.
A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object.
This field will be present in the JSON response if and only if category is
equal to merchant_prearbitration_decline. Contains the details specific to
a merchant prearbitration decline Visa Card Dispute User Submission.
A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object.
This field will be present in the JSON response if and only if category is
equal to user_prearbitration. Contains the details specific to a
user-initiated pre-arbitration Visa Card Dispute User Submission.
Category change details for the pre-arbitration request, if requested.
If the Card Dispute's status is won, this will contain details of the won
dispute.
If the Card Dispute has been withdrawn, this will contain details of the withdrawal.
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
The summarized state of this card payment.
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
Invoice-level information about the payment.
The CardPurchaseSupplementLineItem object.
Shipping information for the purchase.
Card Push Transfers send funds to a recipient's payment card in real-time.
Card Push Transfers send funds to a recipient's payment card in real-time.
If the transfer is accepted by the recipient bank, this will contain supplemental details.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
If the transfer is rejected by the card network or the destination financial institution, this will contain supplemental details.
The amount that was transferred. The receiving bank will have converted this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.
After the transfer is submitted to the card network, this will contain supplemental details.
Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.
Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.
The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range.
The CardTokenCapabilitiesRoute object.
Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.
Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.
If the validation is accepted by the recipient bank, this will contain supplemental details.
What object created the validation, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
If the validation is rejected by the card network or the destination financial institution, this will contain supplemental details.
After the validation is submitted to the card network, this will contain supplemental details.
Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
Controls that restrict how this card can be used.
Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations on this card.
The CardAuthorizationControlsMerchantAcceptorIdentifierAllowed object.
The CardAuthorizationControlsMerchantAcceptorIdentifierBlocked object.
Restricts which Merchant Category Codes are allowed or blocked for authorizations on this card.
The CardAuthorizationControlsMerchantCategoryCodeAllowed object.
The CardAuthorizationControlsMerchantCategoryCodeBlocked object.
Restricts which merchant countries are allowed or blocked for authorizations on this card.
The CardAuthorizationControlsMerchantCountryAllowed object.
The CardAuthorizationControlsMerchantCountryBlocked object.
Controls how many times this card can be used.
Controls for multi-use cards. Required if and only if category is
multi_use.
The CardAuthorizationControlsUsageMultiUseSpendingLimit object.
The CardAuthorizationControlsUsageMultiUseSpendingLimitsMerchantCategoryCode object.
Controls for single-use cards. Required if and only if category is
single_use.
The settlement amount constraint for this single-use card.
The Card's billing address.
The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
An object containing the sensitive details (card number, CVC, PIN, etc) for a Card. These details are not included in the Card object. If you'd prefer to never access these details directly, you can use the [embedded iframe] to display the information to your users.
An object containing the iframe URL for a Card.
Check Deposits allow you to deposit images of paper checks into your account.
Check Deposits allow you to deposit images of paper checks into your account.
Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
The CheckDepositDepositAdjustment object.
If your deposit is rejected by Increase, this will contain details as to why it was rejected.
If your deposit is returned, this will contain details as to why it was returned.
After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.
Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.
Check Transfers move funds from your Increase account by mailing a physical check.
Check Transfers move funds from your Increase account by mailing a physical check.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
If the check has been mailed by Increase, this will contain details of the shipment.
Details relating to the physical check that Increase will print and mail.
Will be present if and only if fulfillment_method is equal to
physical_check.
Details for where Increase will mail the check.
The CheckTransferPhysicalCheckPayer object.
The return address to be printed on the check.
The signature that will appear on the check.
The CheckTransferPhysicalCheckTrackingUpdate object.
After a stop-payment is requested on the check, this will contain supplemental details.
After the transfer is submitted, this will contain supplemental details.
The address we submitted to the printer. This is what is physically printed on the check.
Details relating to the custom fulfillment you will perform. Will be present
if and only if fulfillment_method is equal to third_party.
The low-level HTTP client used by every resource module to talk to the
Increase API. You normally don't need to use this module directly --
resource modules like Increase.Accounts build the right client for you
from configuration -- but it's available if you want full control over
how requests are made.
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
Shared decoding helpers used by every generated Increase.* struct's
decode/1 function. Not meant to be called directly in application
code -- see the individual resource struct modules (e.g.
Increase.Accounts.Account) instead.
This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on digital card artwork.
This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on digital card artwork.
The Card's text color, specified as an RGB triple.
A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
The cardholder information given when the Digital Wallet Token was created.
If the Digital Wallet Token was declined during provisioning, details about the decline.
The device that was used to create the Digital Wallet Token.
The redacted Dynamic Primary Account Number.
The DigitalWalletTokenUpdate object.
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities].
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities].
Details of the corporation entity. Will be present if structure is equal
to corporation.
The corporation's address.
The EntityCorporationBeneficialOwner object.
Personal details for the beneficial owner.
The person's address.
A means of verifying the person's identity.
The legal identifier of the corporation.
Details of the government authority entity. Will be present if structure
is equal to government_authority.
The government authority's address.
The EntityGovernmentAuthorityAuthorizedPerson object.
Details of the joint entity. Will be present if structure is equal to
joint.
The EntityJointIndividual object.
The person's address.
A means of verifying the person's identity.
Details of the natural person entity. Will be present if structure is
equal to natural_person.
The person's address.
A means of verifying the person's identity.
An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
The EntityTermsAgreement object.
If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
Details of the trust entity. Will be present if structure is equal to
trust.
The trust's address.
The grantor of the trust. Will be present if the category is revocable.
The person's address.
A means of verifying the person's identity.
The EntityTrustTrustee object.
The individual trustee of the trust. Will be present if the trustee's
structure is equal to individual.
The person's address.
A means of verifying the person's identity.
The validation results for the entity. Learn more about [validations]
The EntityValidationIssue object.
Details when the issue is with a beneficial owner's address.
Details when the issue is with a beneficial owner's identity verification.
Details when the issue is with the entity's address.
Details when the issue is with the entity's tax ID.
Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding].
Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding].
Represents an error returned by the Increase API, or a transport-level failure (timeout, connection refused, etc).
Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.
Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.
The EventSubscriptionSelectedEventCategory object.
Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our webhooks guide.
Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our webhooks guide.
Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our Exports documentation.
Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our Exports documentation.
Details of the account statement BAI2 export. This field will be present
when the category is equal to account_statement_bai2.
Details of the account statement OFX export. This field will be present when
the category is equal to account_statement_ofx.
Filter transactions by their created date.
Details of the account verification letter export. This field will be
present when the category is equal to account_verification_letter.
Details of the balance CSV export. This field will be present when the
category is equal to balance_csv.
Filter balances by their created date.
Details of the bookkeeping account balance CSV export. This field will be
present when the category is equal to bookkeeping_account_balance_csv.
Details of the daily account balance CSV export. This field will be present
when the category is equal to daily_account_balance_csv.
Details of the dashboard table CSV export. This field will be present when
the category is equal to dashboard_table_csv.
Details of the entity CSV export. This field will be present when the
category is equal to entity_csv.
Details of the fee CSV export. This field will be present when the
category is equal to fee_csv.
Filter fees by their created date. The time range must not include any fees that are part of an open fee statement.
Details of the Form 1099-INT export. This field will be present when the
category is equal to form_1099_int.
Details of the Form 1099-MISC export. This field will be present when the
category is equal to form_1099_misc.
Details of the funding instructions export. This field will be present when
the category is equal to funding_instructions.
The result of the Export. This will be present when the Export's status
transitions to complete.
Details of the transaction CSV export. This field will be present when the
category is equal to transaction_csv.
Filter transactions by their created date.
Details of the vendor CSV export. This field will be present when the
category is equal to vendor_csv.
Details of the voided check export. This field will be present when the
category is equal to voided_check.
The ExportVoidedCheckPayer object.
External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.
FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.
If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
The creditor's address.
The debtor's address.
If the transfer is rejected by FedNow or the destination financial institution, this will contain supplemental details.
After the transfer is submitted to FedNow, this will contain supplemental details.
File Links let you generate a URL that can be used to download a File.
File Links let you generate a URL that can be used to download a File.
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.
Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth here.
Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth here.
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
If your transfer is accepted, this will contain details of the acceptance.
Additional information sent from the originator.
Unstructured payment_related_information passed through by the originator.
The InboundACHTransferAddendaFreeformEntry object.
If your transfer is declined, this will contain details of the decline.
If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.
If you initiate a notification of change in response to the transfer, this will contain its details.
A subhash containing information about when and how the transfer settled at the Federal Reserve.
If your transfer is returned, this will contain details of the return.
Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.
Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.
The InboundCheckDepositAdjustment object.
If you requested a return of this deposit, this will contain details of the return.
An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.
An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.
If your transfer is confirmed, this will contain details of the confirmation.
If your transfer is declined, this will contain details of the decline.
Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.
Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.
Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.
An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.
If your transfer is confirmed, this will contain details of the confirmation.
If your transfer is declined, this will contain details of the decline.
Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation].
Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation].
An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.
An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.
If the transfer is accepted, this will contain details of the acceptance.
If the transfer is reversed, this will contain details of the reversal.
IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.
IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.
When using IntraFi, each account's balance over the standard FDIC insurance amount is swept to various other institutions. Funds are rebalanced across banks as needed once per business day.
When using IntraFi, each account's balance over the standard FDIC insurance amount is swept to various other institutions. Funds are rebalanced across banks as needed once per business day.
The IntrafiBalanceBalance object.
The primary location of the bank.
Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.
Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.
Lockbox Addresses are physical locations that can receive mail containing paper checks.
Lockbox Addresses are physical locations that can receive mail containing paper checks.
The mailing address for the Lockbox Address. It will be present after Increase generates it.
Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.
Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.
An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth here.
An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth here.
When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.
When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.
A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth [here].
A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth [here].
Represents a single page of results from a list endpoint, along with enough information to fetch subsequent pages.
Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers].
Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers].
This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.
This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.
Text printed on the front of the card. Reach out to support@increase.com for more information.
Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile]. The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact support@increase.com for pricing!
Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile]. The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact support@increase.com for pricing!
Details about the cardholder, as it appears on the printed card.
The details used to ship this physical card.
The location to where the card's packing label is addressed.
Tracking details for the shipment.
The PhysicalCardShipmentTrackingUpdate object.
Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
The lending details for the program.
Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our Real-Time Decisions guide.
Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our Real-Time Decisions guide.
Fields related to a 3DS authentication attempt.
The device channel of the card authentication attempt.
Fields specific to the browser device channel.
Fields specific to merchant initiated transactions.
The message category of the card authentication attempt.
Fields specific to non-payment authentication attempts.
Fields specific to payment authentication attempts.
Fields related to a 3DS authentication attempt.
Fields related to a card authorization.
Additional amounts associated with the card authorization, such as ATM
surcharges fees. These are usually a subset of the amount field and are
used to provide more detailed information about the transaction.
The part of this transaction amount that was for clinic-related services.
The part of this transaction amount that was for dental-related services.
The original pre-authorized amount.
The part of this transaction amount that was for healthcare prescriptions.
The surcharge amount charged for this transaction by the merchant.
The total amount of a series of incremental authorizations, optionally provided.
The total amount of healthcare-related additional amounts.
The part of this transaction amount that was for transit-related services.
An unknown additional amount.
The part of this transaction amount that was for vision-related services.
Present if and only if decision is approve. Contains information related
to the approval of the authorization.
Present if and only if decision is decline. Contains information related
to the reason the authorization was declined.
The healthcare-related fields for this authorization. Only present for specific programs.
Fields specific to the network.
Fields specific to the pulse network.
Fields specific to the visa network.
Network-specific identifiers for a specific request or transaction.
Fields specific to the type of request, such as an incremental authorization.
Fields specific to the category incremental_authorization.
Fields specific to the category initial_authorization.
Fields related to verification of cardholder-provided values.
Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.
Cardholder address provided in the authorization request and the address on file we verified it against.
Cardholder name provided in the authorization request.
Fields related to a card balance inquiry.
Additional amounts associated with the card authorization, such as ATM
surcharges fees. These are usually a subset of the amount field and are
used to provide more detailed information about the transaction.
The part of this transaction amount that was for clinic-related services.
The part of this transaction amount that was for dental-related services.
The original pre-authorized amount.
The part of this transaction amount that was for healthcare prescriptions.
The surcharge amount charged for this transaction by the merchant.
The total amount of a series of incremental authorizations, optionally provided.
The total amount of healthcare-related additional amounts.
The part of this transaction amount that was for transit-related services.
An unknown additional amount.
The part of this transaction amount that was for vision-related services.
Present if and only if decision is approve. Contains information related
to the approval of the balance inquiry.
Fields specific to the network.
Fields specific to the pulse network.
Fields specific to the visa network.
Network-specific identifiers for a specific request or transaction.
Fields related to verification of cardholder-provided values.
Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.
Cardholder address provided in the authorization request and the address on file we verified it against.
Cardholder name provided in the authorization request.
Fields related to a digital wallet authentication attempt.
Fields related to a digital wallet token provisioning attempt.
Device that is being used to provision the digital wallet token.
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
Functions for working with RoutingNumbers via the Increase API.
Routing numbers are used to identify your bank in a financial transaction.
Sandbox-only endpoints for simulating events that would otherwise take hours or days to occur in production -- settling a card authorization, receiving an inbound wire, having the Federal Reserve acknowledge an ACH transfer, and so on.
Sandbox-only simulations related to ACH Transfer.
Sandbox-only simulations related to Account Revenue Payment.
Sandbox-only simulations related to Account Statement.
Sandbox-only simulations related to Card Authentication.
Sandbox-only simulations related to Card Authorization Expiration.
Sandbox-only simulations related to Card Authorization.
The results of a Card Authorization simulation.
Sandbox-only simulations related to Card Balance Inquiry.
Sandbox-only simulations related to Card Dispute.
Sandbox-only simulations related to Card Fuel Confirmation.
Sandbox-only simulations related to Card Increment.
Sandbox-only simulations related to Card Purchase Supplement.
Sandbox-only simulations related to Card Refund.
Sandbox-only simulations related to Card Reversal.
Sandbox-only simulations related to Card Settlement.
Sandbox-only simulations related to Card Token.
Sandbox-only simulations related to Check Deposit.
Sandbox-only simulations related to Check Transfer.
Sandbox-only simulations related to Digital Wallet Token Request.
The results of a Digital Wallet Token simulation.
Sandbox-only simulations related to Entity.
Sandbox-only simulations related to Entity Onboarding Session.
Sandbox-only simulations related to Export.
Sandbox-only simulations related to Inbound ACH Transfer.
Sandbox-only simulations related to Inbound Check Deposit.
Sandbox-only simulations related to Inbound Fednow Transfer.
Sandbox-only simulations related to Inbound Mail Item.
Sandbox-only simulations related to Inbound Real Time Payments Transfer.
Sandbox-only simulations related to Inbound Wire Drawdown Request.
Sandbox-only simulations related to Inbound Wire Transfer.
Sandbox-only simulations related to Interest Payment.
Sandbox-only simulations related to Pending Transaction.
Sandbox-only simulations related to Physical Card.
Sandbox-only simulations related to Program.
Sandbox-only simulations related to Real Time Payments Transfer.
Sandbox-only simulations related to Wire Drawdown Request.
Sandbox-only simulations related to Wire Transfer.
Functions for working with SupplementalDocuments via the Increase API.
Supplemental Documents are uploaded files connected to an Entity during onboarding.
Swift Transfers send funds internationally.
Swift Transfers send funds internationally.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
The creditor's address.
The debtor's address.
Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers]
Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers].
Verifies the authenticity of incoming webhook requests from Increase.
Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation].
Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation].
The creditor's address.
The debtor's address.
After the drawdown request is submitted to Fedwire, this will contain supplemental details.
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
What object created the transfer, either via the API or the dashboard.
If present, details about the API key that created the transfer.
If present, details about the OAuth Application that created the transfer.
If present, details about the User that created the transfer.
The person or business that is receiving the funds from the transfer.
The person or business's address.
Unstructured address lines.
The person or business whose funds are being transferred.
The person or business's address.
Unstructured address lines.
Remittance information sent with the wire transfer.
Internal Revenue Service (IRS) tax repayment information. Required if
category is equal to tax.
Unstructured remittance information. Required if category is equal to
unstructured.
If your transfer is reversed, this will contain details of the reversal.
After the transfer is submitted to Fedwire, this will contain supplemental details.