{"note":"OpenAPI conversion -- returning structured metadata","name":"increase-com","description":"Increase API","version":"0.0.1","base_url":"https://api.increase.com","endpoints":236,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Increase API\n@base https://api.increase.com\n@version 0.0.1\n@auth Bearer bearer\n@endpoints 236\n@hint download_for_search\n@toc account_numbers(4), account_statements(2), account_transfers(5), accounts(7), ach_prenotifications(3), ach_transfers(5), bookkeeping_accounts(4), bookkeeping_entries(2), bookkeeping_entry_sets(3), card_disputes(5), card_payments(2), card_purchase_supplements(2), card_push_transfers(5), card_tokens(3), card_validations(3), cards(7), check_deposits(3), check_transfers(6), declined_transactions(2), digital_card_profiles(5), digital_wallet_tokens(2), entities(5), entity_beneficial_owners(5), entity_supplemental_documents(2), event_subscriptions(4), events(2), exports(3), external_accounts(4), fednow_transfers(5), file_links(1), files(3), groups(1), inbound_ach_transfers(5), inbound_check_deposits(4), inbound_fednow_transfers(2), inbound_mail_items(3), inbound_real_time_payments_transfers(2), inbound_wire_drawdown_requests(2), inbound_wire_transfers(3), intrafi_account_enrollments(4), intrafi_exclusions(4), lockboxes(4), oauth(1), oauth_applications(2), oauth_connections(2), pending_transactions(4), physical_card_profiles(5), physical_cards(4), programs(2), real_time_decisions(2), real_time_payments_transfers(5), routing_numbers(1), simulations(45), swift_transfers(5), transactions(2), wire_drawdown_requests(3), wire_transfers(5)\n\n@group account_numbers\n@endpoint GET /account_numbers\n@desc List Account Numbers\n@optional {cursor: str, limit: int, status.in: [str], ach_debit_status.in: [str], account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Account Number List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /account_numbers\n@desc Create an Account Number\n@required {account_id: str # The Account the Account Number should belong to., name: str # The name you choose for the Account Number.}\n@optional {inbound_ach: map{debit_status!: str} # Options related to how this Account Number should handle inbound ACH transfers., inbound_checks: map{status!: str} # Options related to how this Account Number should handle inbound check withdrawals.}\n@returns(200) {account_id: str, account_number: str, created_at: str(date-time), id: str, idempotency_key: any, inbound_ach: map{debit_status: str}, inbound_checks: map{status: str}, name: str, routing_number: str, status: str, type: str} # Account Number\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /account_numbers/{account_number_id}\n@desc Retrieve an Account Number\n@required {account_number_id: str}\n@returns(200) {account_id: str, account_number: str, created_at: str(date-time), id: str, idempotency_key: any, inbound_ach: map{debit_status: str}, inbound_checks: map{status: str}, name: str, routing_number: str, status: str, type: str} # Account Number\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /account_numbers/{account_number_id}\n@desc Update an Account Number\n@required {account_number_id: str}\n@optional {inbound_ach: map{debit_status: str} # Options related to how this Account Number handles inbound ACH transfers., inbound_checks: map{status!: str} # Options related to how this Account Number should handle inbound check withdrawals., name: str # The name you choose for the Account Number., status: str(active/disabled/canceled) # This indicates if transfers can be made to the Account Number.}\n@returns(200) {account_id: str, account_number: str, created_at: str(date-time), id: str, idempotency_key: any, inbound_ach: map{debit_status: str}, inbound_checks: map{status: str}, name: str, routing_number: str, status: str, type: str} # Account Number\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group account_statements\n@endpoint GET /account_statements\n@desc List Account Statements\n@optional {cursor: str, limit: int, account_id: str, statement_period_start.after: str(date-time), statement_period_start.before: str(date-time), statement_period_start.on_or_after: str(date-time), statement_period_start.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Account Statement List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /account_statements/{account_statement_id}\n@desc Retrieve an Account Statement\n@required {account_statement_id: str}\n@returns(200) {account_id: str, created_at: str(date-time), ending_balance: int, file_id: str, id: str, loan: any, starting_balance: int, statement_period_end: str(date-time), statement_period_start: str(date-time), type: str} # Account Statement\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group account_transfers\n@endpoint GET /account_transfers\n@desc List Account Transfers\n@optional {cursor: str, limit: int, account_id: str, idempotency_key: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Account Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /account_transfers\n@desc Create an Account Transfer\n@required {account_id: str # The identifier for the originating Account that will send the transfer., amount: int # The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents., description: str # An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions., destination_account_id: str # The identifier for the destination Account that will receive the transfer.}\n@optional {require_approval: bool # Whether the transfer should require explicit approval via the dashboard or API. For more information, see [Transfer Approvals](/documentation/transfer-approvals).}\n@returns(200) {account_id: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, currency: str, description: str, destination_account_id: str, destination_transaction_id: any, id: str, idempotency_key: any, pending_transaction_id: any, status: str, transaction_id: any, type: str} # Account Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /account_transfers/{account_transfer_id}\n@desc Retrieve an Account Transfer\n@required {account_transfer_id: str}\n@returns(200) {account_id: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, currency: str, description: str, destination_account_id: str, destination_transaction_id: any, id: str, idempotency_key: any, pending_transaction_id: any, status: str, transaction_id: any, type: str} # Account Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /account_transfers/{account_transfer_id}/approve\n@desc Approve an Account Transfer\n@required {account_transfer_id: str}\n@returns(200) {account_id: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, currency: str, description: str, destination_account_id: str, destination_transaction_id: any, id: str, idempotency_key: any, pending_transaction_id: any, status: str, transaction_id: any, type: str} # Account Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /account_transfers/{account_transfer_id}/cancel\n@desc Cancel an Account Transfer\n@required {account_transfer_id: str}\n@returns(200) {account_id: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, currency: str, description: str, destination_account_id: str, destination_transaction_id: any, id: str, idempotency_key: any, pending_transaction_id: any, status: str, transaction_id: any, type: str} # Account Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group accounts\n@endpoint GET /accounts\n@desc List Accounts\n@optional {cursor: str, limit: int, entity_id: str, informational_entity_id: str, program_id: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Account List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /accounts\n@desc Create an Account\n@required {name: str # The name you choose for the Account.}\n@optional {entity_id: str # The identifier for the Entity that will own the Account., funding: str(loan/deposits) # Whether the Account is funded by a loan or by deposits., informational_entity_id: str # The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds., loan: map{credit_limit!: int, grace_period_days!: int, maturity_date: str(date), statement_day_of_month!: int, statement_payment_type!: str} # The loan details for the account., program_id: str # The identifier for the Program that this Account falls under. Required if you operate more than one Program.}\n@returns(200) {account_revenue_rate: any, bank: str, closed_at: any, created_at: str(date-time), currency: str, entity_id: str, funding: str, id: str, idempotency_key: any, informational_entity_id: any, interest_rate: str, loan: any, name: str, program_id: str, status: str, type: str} # Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /accounts/{account_id}\n@desc Retrieve an Account\n@required {account_id: str}\n@returns(200) {account_revenue_rate: any, bank: str, closed_at: any, created_at: str(date-time), currency: str, entity_id: str, funding: str, id: str, idempotency_key: any, informational_entity_id: any, interest_rate: str, loan: any, name: str, program_id: str, status: str, type: str} # Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /accounts/{account_id}\n@desc Update an Account\n@required {account_id: str}\n@optional {loan: map{credit_limit!: int} # The loan details for the account., name: str # The new name of the Account.}\n@returns(200) {account_revenue_rate: any, bank: str, closed_at: any, created_at: str(date-time), currency: str, entity_id: str, funding: str, id: str, idempotency_key: any, informational_entity_id: any, interest_rate: str, loan: any, name: str, program_id: str, status: str, type: str} # Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /accounts/{account_id}/balance\n@desc Retrieve an Account Balance\n@required {account_id: str}\n@optional {at_time: str(date-time)}\n@returns(200) {account_id: str, available_balance: int, current_balance: int, loan: any, type: str} # Balance Lookup\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /accounts/{account_id}/close\n@desc Close an Account\n@required {account_id: str}\n@returns(200) {account_revenue_rate: any, bank: str, closed_at: any, created_at: str(date-time), currency: str, entity_id: str, funding: str, id: str, idempotency_key: any, informational_entity_id: any, interest_rate: str, loan: any, name: str, program_id: str, status: str, type: str} # Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /accounts/{account_id}/intrafi_balance\n@desc Get IntraFi balance\n@required {account_id: str}\n@returns(200) {balances: [map], currency: str, effective_date: str(date), total_balance: int, type: str} # IntraFi Balance\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group ach_prenotifications\n@endpoint GET /ach_prenotifications\n@desc List ACH Prenotifications\n@optional {cursor: str, limit: int, idempotency_key: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # ACH Prenotification List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /ach_prenotifications\n@desc Create an ACH Prenotification\n@required {account_id: str # The Increase identifier for the account that will send the ACH Prenotification., account_number: str # The account number for the destination account., routing_number: str # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.}\n@optional {addendum: str # Additional information that will be sent to the recipient., company_descriptive_date: str # The description of the date of the ACH Prenotification., company_discretionary_data: str # The data you choose to associate with the ACH Prenotification., company_entry_description: str # The description you wish to be shown to the recipient., company_name: str # The name by which the recipient knows you., credit_debit_indicator: str(credit/debit) # Whether the Prenotification is for a future debit or credit., effective_date: str(date) # The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format., individual_id: str # Your identifier for the recipient., individual_name: str # The name of therecipient. This value is informational and not verified by the recipient's bank., standard_entry_class_code: str(corporate_credit_or_debit/corporate_trade_exchange/prearranged_payments_and_deposit/internet_initiated) # The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the ACH Prenotification.}\n@returns(200) {account_id: any, account_number: str, addendum: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_name: any, created_at: str(date-time), credit_debit_indicator: any, effective_date: any, id: str, idempotency_key: any, individual_id: any, individual_name: any, notifications_of_change: [map], prenotification_return: any, routing_number: str, standard_entry_class_code: any, status: str, type: str} # ACH Prenotification\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /ach_prenotifications/{ach_prenotification_id}\n@desc Retrieve an ACH Prenotification\n@required {ach_prenotification_id: str}\n@returns(200) {account_id: any, account_number: str, addendum: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_name: any, created_at: str(date-time), credit_debit_indicator: any, effective_date: any, id: str, idempotency_key: any, individual_id: any, individual_name: any, notifications_of_change: [map], prenotification_return: any, routing_number: str, standard_entry_class_code: any, status: str, type: str} # ACH Prenotification\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group ach_transfers\n@endpoint GET /ach_transfers\n@desc List ACH Transfers\n@optional {cursor: str, limit: int, account_id: str, external_account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # ACH Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /ach_transfers\n@desc Create an ACH Transfer\n@required {account_id: str # The Increase identifier for the account that will send the transfer., amount: int # The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account., statement_descriptor: str # A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If `individual_name` and `company_name` are not explicitly set by this API, the `statement_descriptor` will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass `individual_name` and `company_name` instead of relying on this fallback.}\n@optional {account_number: str # The account number for the destination account., addenda: map{category!: str, freeform: map, payment_order_remittance_advice: map} # Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank., company_descriptive_date: str # The description of the date of the transfer, usually in the format `YYMMDD`. This is included in the transfer data sent to the receiving bank., company_discretionary_data: str # The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank., company_entry_description: str # A description of the transfer, included in the transfer data sent to the receiving bank. Standardized formatting may be required, for example `PAYROLL` for payroll-related Prearranged Payments and Deposits (PPD) credit transfers., company_name: str # The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank., destination_account_holder: str(business/individual/unknown) # The type of entity that owns the account to which the ACH Transfer is being sent., external_account_id: str # The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number`, `routing_number`, and `funding` must be absent., funding: str(checking/savings/general_ledger) # The type of the account to which the transfer will be sent., individual_id: str # Your identifier for the transfer recipient., individual_name: str # The name of the transfer recipient. This value is informational and not verified by the recipient's bank., preferred_effective_date: map{date: str(date), settlement_schedule: str} # 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., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., routing_number: str # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account., standard_entry_class_code: str(corporate_credit_or_debit/corporate_trade_exchange/prearranged_payments_and_deposit/internet_initiated) # The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer., transaction_timing: str(synchronous/asynchronous) # The timing of the transaction.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /ach_transfers/{ach_transfer_id}\n@desc Retrieve an ACH Transfer\n@required {ach_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /ach_transfers/{ach_transfer_id}/approve\n@desc Approve an ACH Transfer\n@required {ach_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /ach_transfers/{ach_transfer_id}/cancel\n@desc Cancel a pending ACH Transfer\n@required {ach_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group bookkeeping_accounts\n@endpoint GET /bookkeeping_accounts\n@desc List Bookkeeping Accounts\n@optional {cursor: str, limit: int, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Bookkeeping Account List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /bookkeeping_accounts\n@desc Create a Bookkeeping Account\n@required {name: str # The name you choose for the account.}\n@optional {account_id: str # The account, if `compliance_category` is `commingled_cash`., compliance_category: str(commingled_cash/customer_balance) # The account compliance category., entity_id: str # The entity, if `compliance_category` is `customer_balance`.}\n@returns(200) {account_id: any, compliance_category: any, entity_id: any, id: str, idempotency_key: any, name: str, type: str} # Bookkeeping Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /bookkeeping_accounts/{bookkeeping_account_id}\n@desc Update a Bookkeeping Account\n@required {bookkeeping_account_id: str, name: str # The name you choose for the account.}\n@returns(200) {account_id: any, compliance_category: any, entity_id: any, id: str, idempotency_key: any, name: str, type: str} # Bookkeeping Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /bookkeeping_accounts/{bookkeeping_account_id}/balance\n@desc Retrieve a Bookkeeping Account Balance\n@required {bookkeeping_account_id: str}\n@optional {at_time: str(date-time)}\n@returns(200) {balance: int, bookkeeping_account_id: str, type: str} # Bookkeeping Balance Lookup\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group bookkeeping_entries\n@endpoint GET /bookkeeping_entries\n@desc List Bookkeeping Entries\n@optional {cursor: str, limit: int, account_id: str}\n@returns(200) {data: [map], next_cursor: any} # Bookkeeping Entry List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /bookkeeping_entries/{bookkeeping_entry_id}\n@desc Retrieve a Bookkeeping Entry\n@required {bookkeeping_entry_id: str}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), entry_set_id: str, id: str, type: str} # Bookkeeping Entry\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group bookkeeping_entry_sets\n@endpoint GET /bookkeeping_entry_sets\n@desc List Bookkeeping Entry Sets\n@optional {cursor: str, limit: int, transaction_id: str, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Bookkeeping Entry Set List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /bookkeeping_entry_sets\n@desc Create a Bookkeeping Entry Set\n@required {entries: [map{account_id!: str, amount!: int}] # The bookkeeping entries.}\n@optional {date: str(date-time) # The date of the transaction. Optional if `transaction_id` is provided, in which case we use the `date` of that transaction. Required otherwise., transaction_id: str # The identifier of the Transaction related to this entry set, if any.}\n@returns(200) {created_at: str(date-time), date: str(date-time), entries: [map], id: str, idempotency_key: any, transaction_id: any, type: str} # Bookkeeping Entry Set\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /bookkeeping_entry_sets/{bookkeeping_entry_set_id}\n@desc Retrieve a Bookkeeping Entry Set\n@required {bookkeeping_entry_set_id: str}\n@returns(200) {created_at: str(date-time), date: str(date-time), entries: [map], id: str, idempotency_key: any, transaction_id: any, type: str} # Bookkeeping Entry Set\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_disputes\n@endpoint GET /card_disputes\n@desc List Card Disputes\n@optional {cursor: str, limit: int, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Card Dispute List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_disputes\n@desc Create a Card Dispute\n@required {disputed_transaction_id: str # The Transaction you wish to dispute. This Transaction must have a `source_type` of `card_settlement`., network: str # The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network.}\n@optional {amount: int # The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction., attachment_files: [map{file_id!: str}] # The files to be attached to the initial dispute submission., explanation: str # The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks., visa: map{authorization: map, category!: str, consumer_canceled_merchandise: map, consumer_canceled_recurring_transaction: map, consumer_canceled_services: map, consumer_counterfeit_merchandise: map, consumer_credit_not_processed: map, consumer_damaged_or_defective_merchandise: map, consumer_merchandise_misrepresentation: map, consumer_merchandise_not_as_described: map, consumer_merchandise_not_received: map, consumer_non_receipt_of_cash: map, consumer_original_credit_transaction_not_accepted: map, consumer_quality_merchandise: map, consumer_quality_services: map, consumer_services_misrepresentation: map, consumer_services_not_as_described: map, consumer_services_not_received: map, fraud: map, processing_error: map} # The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`.}\n@returns(200) {amount: int, card_id: str, created_at: str(date-time), disputed_transaction_id: str, id: str, idempotency_key: any, loss: any, network: str, status: str, type: str, user_submission_required_by: any, visa: any, win: any, withdrawal: any} # Card Dispute\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_disputes/{card_dispute_id}\n@desc Retrieve a Card Dispute\n@required {card_dispute_id: str}\n@returns(200) {amount: int, card_id: str, created_at: str(date-time), disputed_transaction_id: str, id: str, idempotency_key: any, loss: any, network: str, status: str, type: str, user_submission_required_by: any, visa: any, win: any, withdrawal: any} # Card Dispute\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_disputes/{card_dispute_id}/submit_user_submission\n@desc Submit a User Submission for a Card Dispute\n@required {card_dispute_id: str, network: str # The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.}\n@optional {amount: int # The adjusted monetary amount of the part of the transaction that is being disputed. This is optional and will default to the most recent amount provided. If provided, the amount must be less than or equal to the amount of the transaction., attachment_files: [map{file_id!: str}] # The files to be attached to the user submission., explanation: str # The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks., visa: map{category!: str, chargeback: map, merchant_prearbitration_decline: map, user_prearbitration: map} # The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`.}\n@returns(200) {amount: int, card_id: str, created_at: str(date-time), disputed_transaction_id: str, id: str, idempotency_key: any, loss: any, network: str, status: str, type: str, user_submission_required_by: any, visa: any, win: any, withdrawal: any} # Card Dispute\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_disputes/{card_dispute_id}/withdraw\n@desc Withdraw a Card Dispute\n@required {card_dispute_id: str}\n@optional {explanation: str # The explanation for withdrawing the Card Dispute.}\n@returns(200) {amount: int, card_id: str, created_at: str(date-time), disputed_transaction_id: str, id: str, idempotency_key: any, loss: any, network: str, status: str, type: str, user_submission_required_by: any, visa: any, win: any, withdrawal: any} # Card Dispute\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_payments\n@endpoint GET /card_payments\n@desc List Card Payments\n@optional {cursor: str, limit: int, account_id: str, card_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Card Payment List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_payments/{card_payment_id}\n@desc Retrieve a Card Payment\n@required {card_payment_id: str}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_purchase_supplements\n@endpoint GET /card_purchase_supplements\n@desc List Card Purchase Supplements\n@optional {cursor: str, limit: int, card_payment_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Card Purchase Supplement List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_purchase_supplements/{card_purchase_supplement_id}\n@desc Retrieve a Card Purchase Supplement\n@required {card_purchase_supplement_id: str}\n@returns(200) {card_payment_id: any, id: str, invoice: any, line_items: any, transaction_id: str, type: str} # Card Purchase Supplement\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_push_transfers\n@endpoint GET /card_push_transfers\n@desc List Card Push Transfers\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Card Push Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_push_transfers\n@desc Create a Card Push Transfer\n@required {business_application_identifier: str(account_to_account/business_to_business/money_transfer_bank_initiated/non_card_bill_payment/consumer_bill_payment/card_bill_payment/funds_disbursement/funds_transfer/loyalty_and_offers/merchant_disbursement/merchant_payment/person_to_person/top_up/wallet_transfer) # The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it., card_token_id: str # The Increase identifier for the Card Token that represents the card number you're pushing funds to., merchant_category_code: str # The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it., merchant_city_name: str # The city name of the merchant (generally your business) sending the transfer., merchant_name: str # The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization., merchant_name_prefix: str # For certain Business Application Identifiers, the statement descriptor is `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant., merchant_postal_code: str # The postal code of the merchant (generally your business) sending the transfer., merchant_state: str # The state of the merchant (generally your business) sending the transfer., presentment_amount: map{currency!: str, value!: str} # The amount to transfer. The receiving bank will convert this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account., recipient_name: str # The name of the funds recipient., sender_address_city: str # The city of the sender., sender_address_line1: str # The address line 1 of the sender., sender_address_postal_code: str # The postal code of the sender., sender_address_state: str # The state of the sender., sender_name: str # The name of the funds originator., source_account_number_id: str # The identifier of the Account Number from which to send the transfer.}\n@optional {merchant_legal_business_name: str # The legal business name of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada., merchant_street_address: str # The street address of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada., recipient_address_city: str # The city of the recipient. Required if the card is issued in Canada., recipient_address_line1: str # The first line of the recipient's address. Required if the card is issued in Canada., recipient_address_postal_code: str # The postal code of the recipient. Required if the card is issued in Canada., recipient_address_state: str # The state or province of the recipient. Required if the card is issued in Canada., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API.}\n@returns(200) {acceptance: any, account_id: str, approval: any, business_application_identifier: str, cancellation: any, card_token_id: str, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_name_prefix: str, merchant_postal_code: str, merchant_state: str, presentment_amount: map{currency: str, value: str}, recipient_name: str, route: str, sender_address_city: str, sender_address_line1: str, sender_address_postal_code: str, sender_address_state: str, sender_name: str, source_account_number_id: str, status: str, submission: any, type: str} # Card Push Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_push_transfers/{card_push_transfer_id}\n@desc Retrieve a Card Push Transfer\n@required {card_push_transfer_id: str}\n@returns(200) {acceptance: any, account_id: str, approval: any, business_application_identifier: str, cancellation: any, card_token_id: str, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_name_prefix: str, merchant_postal_code: str, merchant_state: str, presentment_amount: map{currency: str, value: str}, recipient_name: str, route: str, sender_address_city: str, sender_address_line1: str, sender_address_postal_code: str, sender_address_state: str, sender_name: str, source_account_number_id: str, status: str, submission: any, type: str} # Card Push Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_push_transfers/{card_push_transfer_id}/approve\n@desc Approve a Card Push Transfer\n@required {card_push_transfer_id: str}\n@returns(200) {acceptance: any, account_id: str, approval: any, business_application_identifier: str, cancellation: any, card_token_id: str, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_name_prefix: str, merchant_postal_code: str, merchant_state: str, presentment_amount: map{currency: str, value: str}, recipient_name: str, route: str, sender_address_city: str, sender_address_line1: str, sender_address_postal_code: str, sender_address_state: str, sender_name: str, source_account_number_id: str, status: str, submission: any, type: str} # Card Push Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_push_transfers/{card_push_transfer_id}/cancel\n@desc Cancel a pending Card Push Transfer\n@required {card_push_transfer_id: str}\n@returns(200) {acceptance: any, account_id: str, approval: any, business_application_identifier: str, cancellation: any, card_token_id: str, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_name_prefix: str, merchant_postal_code: str, merchant_state: str, presentment_amount: map{currency: str, value: str}, recipient_name: str, route: str, sender_address_city: str, sender_address_line1: str, sender_address_postal_code: str, sender_address_state: str, sender_name: str, source_account_number_id: str, status: str, submission: any, type: str} # Card Push Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_tokens\n@endpoint GET /card_tokens\n@desc List Card Tokens\n@optional {cursor: str, limit: int, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Card Token List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_tokens/{card_token_id}\n@desc Retrieve a Card Token\n@required {card_token_id: str}\n@returns(200) {created_at: str(date-time), expiration_date: str(date), id: str, last4: str, length: int, prefix: str, type: str} # Card Token\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_tokens/{card_token_id}/capabilities\n@desc Retrieve the capabilities of a Card Token\n@required {card_token_id: str}\n@returns(200) {routes: [map], type: str} # Card Token Capabilities\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group card_validations\n@endpoint GET /card_validations\n@desc List Card Validations\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Card Validation List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /card_validations\n@desc Create a Card Validation\n@required {account_id: str # The identifier of the Account from which to send the validation., card_token_id: str # The Increase identifier for the Card Token that represents the card number you're validating., merchant_category_code: str # A four-digit code (MCC) identifying the type of business or service provided by the merchant., merchant_city_name: str # The city where the merchant (typically your business) is located., merchant_name: str # The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name., merchant_postal_code: str # The postal code for the merchant’s (typically your business’s) location., merchant_state: str # The U.S. state where the merchant (typically your business) is located.}\n@optional {cardholder_first_name: str # The cardholder's first name., cardholder_last_name: str # The cardholder's last name., cardholder_middle_name: str # The cardholder's middle name., cardholder_postal_code: str # The postal code of the cardholder's address., cardholder_street_address: str # The cardholder's street address.}\n@returns(200) {acceptance: any, account_id: str, card_token_id: str, cardholder_first_name: any, cardholder_last_name: any, cardholder_middle_name: any, cardholder_postal_code: any, cardholder_street_address: any, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_postal_code: str, merchant_state: str, route: str, status: str, submission: any, type: str} # Card Validation\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /card_validations/{card_validation_id}\n@desc Retrieve a Card Validation\n@required {card_validation_id: str}\n@returns(200) {acceptance: any, account_id: str, card_token_id: str, cardholder_first_name: any, cardholder_last_name: any, cardholder_middle_name: any, cardholder_postal_code: any, cardholder_street_address: any, created_at: str(date-time), created_by: any, decline: any, id: str, idempotency_key: any, merchant_category_code: str, merchant_city_name: str, merchant_name: str, merchant_postal_code: str, merchant_state: str, route: str, status: str, submission: any, type: str} # Card Validation\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group cards\n@endpoint GET /cards\n@desc List Cards\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Card List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /cards\n@desc Create a Card\n@required {account_id: str # The Account the card should belong to.}\n@optional {authorization_controls: map{maximum_authorization_count: map, merchant_acceptor_identifier: map, merchant_category_code: map, merchant_country: map, spending_limits: [map]} # Controls that restrict how this card can be used., billing_address: map{city!: str, line1!: str, line2: str, postal_code!: str, state!: str} # The card's billing address., description: str # The description you choose to give the card., digital_wallet: map{digital_card_profile_id: str, email: str(email), phone: str} # The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category `digital_wallet_token_requested` or `digital_wallet_authentication_requested`., entity_id: str # The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.}\n@returns(200) {account_id: str, authorization_controls: any, billing_address: map{city: any, line1: any, line2: any, postal_code: any, state: any}, created_at: str(date-time), description: any, digital_wallet: any, entity_id: any, expiration_month: int, expiration_year: int, id: str, idempotency_key: any, last4: str, status: str, type: str} # Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /cards/{card_id}\n@desc Retrieve a Card\n@required {card_id: str}\n@returns(200) {account_id: str, authorization_controls: any, billing_address: map{city: any, line1: any, line2: any, postal_code: any, state: any}, created_at: str(date-time), description: any, digital_wallet: any, entity_id: any, expiration_month: int, expiration_year: int, id: str, idempotency_key: any, last4: str, status: str, type: str} # Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /cards/{card_id}\n@desc Update a Card\n@required {card_id: str}\n@optional {authorization_controls: map{maximum_authorization_count: map, merchant_acceptor_identifier: map, merchant_category_code: map, merchant_country: map, spending_limits: [map]} # Controls that restrict how this card can be used., billing_address: map{city!: str, line1!: str, line2: str, postal_code!: str, state!: str} # The card's updated billing address., description: str # The description you choose to give the card., digital_wallet: map{digital_card_profile_id: str, email: str(email), phone: str} # 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., entity_id: str # The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder., status: str(active/disabled/canceled) # The status to update the Card with.}\n@returns(200) {account_id: str, authorization_controls: any, billing_address: map{city: any, line1: any, line2: any, postal_code: any, state: any}, created_at: str(date-time), description: any, digital_wallet: any, entity_id: any, expiration_month: int, expiration_year: int, id: str, idempotency_key: any, last4: str, status: str, type: str} # Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /cards/{card_id}/create_details_iframe\n@desc Create a Card details iframe\n@required {card_id: str}\n@optional {physical_card_id: str # The identifier of the Physical Card to create an iframe for. This will inform the appearance of the card rendered in the iframe.}\n@returns(200) {expires_at: str(date-time), iframe_url: str, type: str} # Card iframe URL\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /cards/{card_id}/details\n@desc Retrieve sensitive details for a Card\n@required {card_id: str}\n@returns(200) {card_id: str, expiration_month: int, expiration_year: int, pin: str, primary_account_number: str, type: str, verification_code: str} # Card Details\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /cards/{card_id}/update_pin\n@desc Update a Card's PIN\n@required {card_id: str, pin: str # The 4-digit PIN for the card, for use with ATMs.}\n@returns(200) {card_id: str, expiration_month: int, expiration_year: int, pin: str, primary_account_number: str, type: str, verification_code: str} # Card Details\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group check_deposits\n@endpoint GET /check_deposits\n@desc List Check Deposits\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Check Deposit List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /check_deposits\n@desc Create a Check Deposit\n@required {account_id: str # The identifier for the Account to deposit the check in., amount: int # The deposit amount in USD cents., back_image_file_id: str # The File containing the check's back image., front_image_file_id: str # The File containing the check's front image.}\n@optional {description: str # The description you choose to give the Check Deposit, for display purposes only.}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /check_deposits/{check_deposit_id}\n@desc Retrieve a Check Deposit\n@required {check_deposit_id: str}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group check_transfers\n@endpoint GET /check_transfers\n@desc List Check Transfers\n@optional {cursor: str, limit: int, account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Check Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /check_transfers\n@desc Create a Check Transfer\n@required {account_id: str # The identifier for the account that will send the transfer., amount: int # The transfer amount in USD cents., fulfillment_method: str(physical_check/third_party) # Whether Increase will print and mail the check or if you will do it yourself., source_account_number_id: str # The identifier of the Account Number from which to send the transfer and print on the check.}\n@optional {balance_check: str(full/none) # How the account's available balance should be checked. If omitted, the default behavior is `balance_check: full`., check_number: str # The check number Increase should use for the check. This should not contain leading zeroes and must be unique across the `source_account_number`. If this is omitted, Increase will generate a check number for you., physical_check: map{attachment_file_id: str, check_voucher_image_file_id: str, mailing_address!: map, memo!: str, note: str, payer: [map], recipient_name!: str, return_address: map, shipping_method: str, signature: map} # Details relating to the physical check that Increase will print and mail. This is required if `fulfillment_method` is equal to `physical_check`. It must not be included if any other `fulfillment_method` is provided., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., third_party: map{recipient_name: str} # Details relating to the custom fulfillment you will perform. This is required if `fulfillment_method` is equal to `third_party`. It must not be included if any other `fulfillment_method` is provided., valid_until_date: str(date) # If provided, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /check_transfers/{check_transfer_id}\n@desc Retrieve a Check Transfer\n@required {check_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /check_transfers/{check_transfer_id}/approve\n@desc Approve a Check Transfer\n@required {check_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /check_transfers/{check_transfer_id}/cancel\n@desc Cancel a pending Check Transfer\n@required {check_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /check_transfers/{check_transfer_id}/stop_payment\n@desc Stop payment on a Check Transfer\n@required {check_transfer_id: str}\n@optional {reason: str(mail_delivery_failed/not_authorized/valid_until_date_passed/unknown) # The reason why this transfer should be stopped.}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group declined_transactions\n@endpoint GET /declined_transactions\n@desc List Declined Transactions\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), route_id: str, category.in: [str]}\n@returns(200) {data: [map], next_cursor: any} # Declined Transaction List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /declined_transactions/{declined_transaction_id}\n@desc Retrieve a Declined Transaction\n@required {declined_transaction_id: str}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), currency: str, description: str, id: str, route_id: any, route_type: any, source: map{ach_decline: any, card_decline: any, category: str, check_decline: any, check_deposit_rejection: any, inbound_fednow_transfer_decline: any, inbound_real_time_payments_transfer_decline: any, other: any, wire_decline: any}, type: str} # Declined Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group digital_card_profiles\n@endpoint GET /digital_card_profiles\n@desc List Card Profiles\n@optional {cursor: str, limit: int, status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Digital Card Profile List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /digital_card_profiles\n@desc Create a Digital Card Profile\n@required {app_icon_file_id: str # The identifier of the File containing the card's icon image., background_image_file_id: str # The identifier of the File containing the card's front image., card_description: str # A user-facing description for the card itself., description: str # A description you can use to identify the Card Profile., issuer_name: str # A user-facing description for whoever is issuing the card.}\n@optional {contact_email: str(email) # An email address the user can contact to receive support for their card., contact_phone: str # A phone number the user can contact to receive support for their card., contact_website: str # A website the user can visit to view and receive support for their card., text_color: map{blue!: int, green!: int, red!: int} # The Card's text color, specified as an RGB triple. The default is white.}\n@returns(200) {app_icon_file_id: str, background_image_file_id: str, card_description: str, contact_email: any, contact_phone: any, contact_website: any, created_at: str(date-time), description: str, id: str, idempotency_key: any, issuer_name: str, status: str, text_color: map{blue: int, green: int, red: int}, type: str} # Digital Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /digital_card_profiles/{digital_card_profile_id}\n@desc Retrieve a Digital Card Profile\n@required {digital_card_profile_id: str}\n@returns(200) {app_icon_file_id: str, background_image_file_id: str, card_description: str, contact_email: any, contact_phone: any, contact_website: any, created_at: str(date-time), description: str, id: str, idempotency_key: any, issuer_name: str, status: str, text_color: map{blue: int, green: int, red: int}, type: str} # Digital Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /digital_card_profiles/{digital_card_profile_id}/archive\n@desc Archive a Digital Card Profile\n@required {digital_card_profile_id: str}\n@returns(200) {app_icon_file_id: str, background_image_file_id: str, card_description: str, contact_email: any, contact_phone: any, contact_website: any, created_at: str(date-time), description: str, id: str, idempotency_key: any, issuer_name: str, status: str, text_color: map{blue: int, green: int, red: int}, type: str} # Digital Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /digital_card_profiles/{digital_card_profile_id}/clone\n@desc Clones a Digital Card Profile\n@required {digital_card_profile_id: str}\n@optional {app_icon_file_id: str # The identifier of the File containing the card's icon image., background_image_file_id: str # The identifier of the File containing the card's front image., card_description: str # A user-facing description for the card itself., contact_email: str(email) # An email address the user can contact to receive support for their card., contact_phone: str # A phone number the user can contact to receive support for their card., contact_website: str # A website the user can visit to view and receive support for their card., description: str # A description you can use to identify the Card Profile., issuer_name: str # A user-facing description for whoever is issuing the card., text_color: map{blue!: int, green!: int, red!: int} # The Card's text color, specified as an RGB triple. The default is white.}\n@returns(200) {app_icon_file_id: str, background_image_file_id: str, card_description: str, contact_email: any, contact_phone: any, contact_website: any, created_at: str(date-time), description: str, id: str, idempotency_key: any, issuer_name: str, status: str, text_color: map{blue: int, green: int, red: int}, type: str} # Digital Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group digital_wallet_tokens\n@endpoint GET /digital_wallet_tokens\n@desc List Digital Wallet Tokens\n@optional {cursor: str, limit: int, card_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Digital Wallet Token List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /digital_wallet_tokens/{digital_wallet_token_id}\n@desc Retrieve a Digital Wallet Token\n@required {digital_wallet_token_id: str}\n@returns(200) {card_id: str, cardholder: map{name: any}, created_at: str(date-time), device: map{device_type: any, identifier: any, ip_address: any, name: any}, dynamic_primary_account_number: any, id: str, status: str, token_requestor: str, type: str, updates: [map]} # Digital Wallet Token\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group entities\n@endpoint GET /entities\n@desc List Entities\n@optional {cursor: str, limit: int, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Entity List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /entities\n@desc Create an Entity\n@required {structure: str(corporation/natural_person/joint/trust/government_authority) # The type of Entity to create.}\n@optional {corporation: map{address!: map, beneficial_owners!: [map], beneficial_ownership_exemption_reason: str, email: str(email), incorporation_state: str, industry_code: str, legal_identifier!: map, name!: str, website: str} # Details of the corporation entity to create. Required if `structure` is equal to `corporation`., description: str # The description you choose to give the entity., government_authority: map{address!: map, authorized_persons!: [map], category!: str, name!: str, tax_identifier!: str, website: str} # Details of the Government Authority entity to create. Required if `structure` is equal to `government_authority`., joint: map{individuals!: [map]} # Details of the joint entity to create. Required if `structure` is equal to `joint`., natural_person: map{address!: map, confirmed_no_us_tax_id: bool, date_of_birth!: str(date), identification!: map, name!: str} # Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods., risk_rating: map{rated_at!: str(date-time), rating!: str} # An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering., supplemental_documents: [map{file_id!: str}] # Additional documentation associated with the entity., terms_agreements: [map{agreed_at!: str(date-time), ip_address!: str, terms_url!: str}] # The terms that the Entity agreed to. Not all programs are required to submit this data., third_party_verification: map{reference!: str, vendor!: str} # 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., trust: map{address!: map, category!: str, formation_document_file_id: str, formation_state: str, grantor: map, name!: str, tax_identifier: str, trustees!: [map]} # Details of the trust entity to create. Required if `structure` is equal to `trust`.}\n@returns(200) {corporation: any, created_at: str(date-time), description: any, details_confirmed_at: any, government_authority: any, id: str, idempotency_key: any, joint: any, natural_person: any, risk_rating: any, status: str, structure: str, supplemental_documents: [map], terms_agreements: [map], third_party_verification: any, trust: any, type: str, validation: any} # Entity\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /entities/{entity_id}\n@desc Retrieve an Entity\n@required {entity_id: str}\n@returns(200) {corporation: any, created_at: str(date-time), description: any, details_confirmed_at: any, government_authority: any, id: str, idempotency_key: any, joint: any, natural_person: any, risk_rating: any, status: str, structure: str, supplemental_documents: [map], terms_agreements: [map], third_party_verification: any, trust: any, type: str, validation: any} # Entity\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /entities/{entity_id}\n@desc Update an Entity\n@required {entity_id: str}\n@optional {corporation: map{address: map, email: str(email), incorporation_state: str, industry_code: str, legal_identifier: map, name: str} # Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail., details_confirmed_at: str(date-time) # When your user last confirmed the Entity's details. Depending on your program, you may be required to affirmatively confirm details with your users on an annual basis., government_authority: map{address: map, name: str} # Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail., natural_person: map{address: map, name: str} # Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail., risk_rating: map{rated_at!: str(date-time), rating!: str} # An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering., third_party_verification: map{reference!: str, vendor!: str} # 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., trust: map{address: map, name: str} # Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.}\n@returns(200) {corporation: any, created_at: str(date-time), description: any, details_confirmed_at: any, government_authority: any, id: str, idempotency_key: any, joint: any, natural_person: any, risk_rating: any, status: str, structure: str, supplemental_documents: [map], terms_agreements: [map], third_party_verification: any, trust: any, type: str, validation: any} # Entity\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /entities/{entity_id}/archive\n@desc Archive an Entity\n@required {entity_id: str}\n@returns(200) {corporation: any, created_at: str(date-time), description: any, details_confirmed_at: any, government_authority: any, id: str, idempotency_key: any, joint: any, natural_person: any, risk_rating: any, status: str, structure: str, supplemental_documents: [map], terms_agreements: [map], third_party_verification: any, trust: any, type: str, validation: any} # Entity\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group entity_beneficial_owners\n@endpoint GET /entity_beneficial_owners\n@desc List Beneficial Owners\n@required {entity_id: str}\n@optional {cursor: str, limit: int, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Beneficial Owner List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /entity_beneficial_owners\n@desc Create a beneficial owner\n@required {entity_id: str # The identifier of the Entity to associate with the new Beneficial Owner., individual: map{address!: map, confirmed_no_us_tax_id: bool, date_of_birth!: str(date), identification!: map, name!: str} # Personal details for the beneficial owner., prongs: [str] # Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both.}\n@optional {company_title: str # This person's role or title within the entity.}\n@returns(200) {company_title: any, created_at: str(date-time), entity_id: str, id: str, idempotency_key: any, individual: map{address: map{city: any, country: str, line1: str, line2: any, state: any, zip: any}, date_of_birth: str(date), identification: map{method: str, number_last4: str}, name: str}, prongs: [str], type: str} # Beneficial Owner\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /entity_beneficial_owners/{entity_beneficial_owner_id}\n@desc Retrieve a Beneficial Owner\n@required {entity_beneficial_owner_id: str}\n@returns(200) {company_title: any, created_at: str(date-time), entity_id: str, id: str, idempotency_key: any, individual: map{address: map{city: any, country: str, line1: str, line2: any, state: any, zip: any}, date_of_birth: str(date), identification: map{method: str, number_last4: str}, name: str}, prongs: [str], type: str} # Beneficial Owner\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /entity_beneficial_owners/{entity_beneficial_owner_id}\n@desc Update a Beneficial Owner\n@required {entity_beneficial_owner_id: str}\n@optional {address: map{city!: str, country!: str, line1!: str, line2: str, state: str, zip: str} # The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed., confirmed_no_us_tax_id: bool # The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number)., identification: map{drivers_license: map, method!: str, number!: str, other: map, passport: map} # A means of verifying the person's identity., name: str # The individual's legal name.}\n@returns(200) {company_title: any, created_at: str(date-time), entity_id: str, id: str, idempotency_key: any, individual: map{address: map{city: any, country: str, line1: str, line2: any, state: any, zip: any}, date_of_birth: str(date), identification: map{method: str, number_last4: str}, name: str}, prongs: [str], type: str} # Beneficial Owner\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /entity_beneficial_owners/{entity_beneficial_owner_id}/archive\n@desc Archive a Beneficial Owner\n@required {entity_beneficial_owner_id: str}\n@returns(200) {company_title: any, created_at: str(date-time), entity_id: str, id: str, idempotency_key: any, individual: map{address: map{city: any, country: str, line1: str, line2: any, state: any, zip: any}, date_of_birth: str(date), identification: map{method: str, number_last4: str}, name: str}, prongs: [str], type: str} # Beneficial Owner\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group entity_supplemental_documents\n@endpoint GET /entity_supplemental_documents\n@desc List Entity Supplemental Document Submissions\n@required {entity_id: str}\n@optional {cursor: str, limit: int, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Supplemental Document List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /entity_supplemental_documents\n@desc Create a supplemental document for an Entity\n@required {entity_id: str # The identifier of the Entity to associate with the supplemental document., file_id: str # The identifier of the File containing the document.}\n@returns(200) {created_at: str(date-time), entity_id: str, file_id: str, idempotency_key: any, type: str} # Supplemental Document\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group event_subscriptions\n@endpoint GET /event_subscriptions\n@desc List Event Subscriptions\n@optional {cursor: str, limit: int, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Event Subscription List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /event_subscriptions\n@desc Create an Event Subscription\n@required {url: str # The URL you'd like us to send webhooks to.}\n@optional {oauth_connection_id: str # If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection., selected_event_categories: [map{event_category!: str}] # If specified, this subscription will only receive webhooks for Events with the specified `category`. If specifying a Real-Time Decision event category, only one Event Category can be specified for the Event Subscription., shared_secret: str # The key that will be used to sign webhooks. If no value is passed, a random string will be used as default., status: str(active/disabled) # The status of the event subscription. Defaults to `active` if not specified.}\n@returns(200) {created_at: str(date-time), id: str, idempotency_key: any, oauth_connection_id: any, selected_event_categories: any, status: str, type: str, url: str} # Event Subscription\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /event_subscriptions/{event_subscription_id}\n@desc Retrieve an Event Subscription\n@required {event_subscription_id: str}\n@returns(200) {created_at: str(date-time), id: str, idempotency_key: any, oauth_connection_id: any, selected_event_categories: any, status: str, type: str, url: str} # Event Subscription\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /event_subscriptions/{event_subscription_id}\n@desc Update an Event Subscription\n@required {event_subscription_id: str}\n@optional {status: str(active/disabled/deleted) # The status to update the Event Subscription with.}\n@returns(200) {created_at: str(date-time), id: str, idempotency_key: any, oauth_connection_id: any, selected_event_categories: any, status: str, type: str, url: str} # Event Subscription\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group events\n@endpoint GET /events\n@desc List Events\n@optional {cursor: str, limit: int, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), category.in: [str], associated_object_id: str}\n@returns(200) {data: [map], next_cursor: any} # Event List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /events/{event_id}\n@desc Retrieve an Event\n@required {event_id: str}\n@returns(200) {associated_object_id: str, associated_object_type: str, category: str, created_at: str(date-time), id: str, type: str} # Event\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group exports\n@endpoint GET /exports\n@desc List Exports\n@optional {cursor: str, limit: int, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), category: str(account_statement_ofx/account_statement_bai2/transaction_csv/balance_csv/bookkeeping_account_balance_csv/entity_csv/vendor_csv/dashboard_table_csv/account_verification_letter/funding_instructions/form_1099_int/form_1099_misc/fee_csv/voided_check), status.in: [str], form_1099_int.account_id: str, form_1099_misc.account_id: str, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Export List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /exports\n@desc Create an Export\n@required {category: str(account_statement_ofx/account_statement_bai2/transaction_csv/balance_csv/bookkeeping_account_balance_csv/entity_csv/vendor_csv/account_verification_letter/funding_instructions/voided_check) # The type of Export to create.}\n@optional {account_statement_bai2: map{account_id: str, effective_date: str(date), program_id: str} # Options for the created export. Required if `category` is equal to `account_statement_bai2`., account_statement_ofx: map{account_id!: str, created_at: map} # Options for the created export. Required if `category` is equal to `account_statement_ofx`., account_verification_letter: map{account_number_id!: str, balance_date: str(date)} # Options for the created export. Required if `category` is equal to `account_verification_letter`., balance_csv: map{account_id: str, created_at: map} # Options for the created export. Required if `category` is equal to `balance_csv`., bookkeeping_account_balance_csv: map{bookkeeping_account_id: str, created_at: map} # Options for the created export. Required if `category` is equal to `bookkeeping_account_balance_csv`., entity_csv: map{} # Options for the created export. Required if `category` is equal to `entity_csv`., funding_instructions: map{account_number_id!: str} # Options for the created export. Required if `category` is equal to `funding_instructions`., transaction_csv: map{account_id: str, created_at: map} # Options for the created export. Required if `category` is equal to `transaction_csv`., vendor_csv: map{} # Options for the created export. Required if `category` is equal to `vendor_csv`., voided_check: map{account_number_id!: str, payer: [map]} # Options for the created export. Required if `category` is equal to `voided_check`.}\n@returns(200) {account_statement_bai2: any, account_statement_ofx: any, account_verification_letter: any, balance_csv: any, bookkeeping_account_balance_csv: any, category: str, created_at: str(date-time), dashboard_table_csv: any, entity_csv: any, fee_csv: any, form_1099_int: any, form_1099_misc: any, funding_instructions: any, id: str, idempotency_key: any, result: any, status: str, transaction_csv: any, type: str, vendor_csv: any, voided_check: any} # Export\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /exports/{export_id}\n@desc Retrieve an Export\n@required {export_id: str}\n@returns(200) {account_statement_bai2: any, account_statement_ofx: any, account_verification_letter: any, balance_csv: any, bookkeeping_account_balance_csv: any, category: str, created_at: str(date-time), dashboard_table_csv: any, entity_csv: any, fee_csv: any, form_1099_int: any, form_1099_misc: any, funding_instructions: any, id: str, idempotency_key: any, result: any, status: str, transaction_csv: any, type: str, vendor_csv: any, voided_check: any} # Export\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group external_accounts\n@endpoint GET /external_accounts\n@desc List External Accounts\n@optional {cursor: str, limit: int, status.in: [str], routing_number: str, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # External Account List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /external_accounts\n@desc Create an External Account\n@required {account_number: str # The account number for the destination account., description: str # The name you choose for the Account., routing_number: str # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.}\n@optional {account_holder: str(business/individual/unknown) # The type of entity that owns the External Account., funding: str(checking/savings/general_ledger/other) # The type of the destination account. Defaults to `checking`.}\n@returns(200) {account_holder: str, account_number: str, created_at: str(date-time), description: str, funding: str, id: str, idempotency_key: any, routing_number: str, status: str, type: str} # External Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /external_accounts/{external_account_id}\n@desc Retrieve an External Account\n@required {external_account_id: str}\n@returns(200) {account_holder: str, account_number: str, created_at: str(date-time), description: str, funding: str, id: str, idempotency_key: any, routing_number: str, status: str, type: str} # External Account\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /external_accounts/{external_account_id}\n@desc Update an External Account\n@required {external_account_id: str}\n@optional {account_holder: str(business/individual) # The type of entity that owns the External Account., description: str # The description you choose to give the external account., funding: str(checking/savings/general_ledger/other) # The funding type of the External Account., status: str(active/archived) # The status of the External Account.}\n@returns(200) {account_holder: str, account_number: str, created_at: str(date-time), description: str, funding: str, id: str, idempotency_key: any, routing_number: str, status: str, type: str} # External Account\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group fednow_transfers\n@endpoint GET /fednow_transfers\n@desc List FedNow Transfers\n@optional {cursor: str, limit: int, account_id: str, external_account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # FedNow Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /fednow_transfers\n@desc Create a FedNow Transfer\n@required {amount: int # The amount, in minor units, to send to the creditor., creditor_name: str # The creditor's name., debtor_name: str # The debtor's name., source_account_number_id: str # The Account Number to include in the transfer as the debtor's account number., unstructured_remittance_information: str # Unstructured remittance information to include in the transfer.}\n@optional {account_number: str # The creditor's account number., creditor_address: map{city!: str, line1: str, postal_code!: str, state!: str} # The creditor's address., debtor_address: map{city!: str, line1: str, postal_code!: str, state!: str} # The debtor's address., external_account_id: str # The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., routing_number: str # The creditor's bank account routing number.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, created_at: str(date-time), created_by: any, creditor_address: any, creditor_name: str, currency: str, debtor_name: str, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /fednow_transfers/{fednow_transfer_id}\n@desc Retrieve a FedNow Transfer\n@required {fednow_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, created_at: str(date-time), created_by: any, creditor_address: any, creditor_name: str, currency: str, debtor_name: str, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /fednow_transfers/{fednow_transfer_id}/approve\n@desc Approve a FedNow Transfer\n@required {fednow_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, created_at: str(date-time), created_by: any, creditor_address: any, creditor_name: str, currency: str, debtor_name: str, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /fednow_transfers/{fednow_transfer_id}/cancel\n@desc Cancel a pending FedNow Transfer\n@required {fednow_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, created_at: str(date-time), created_by: any, creditor_address: any, creditor_name: str, currency: str, debtor_name: str, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group file_links\n@endpoint POST /file_links\n@desc Create a File Link\n@required {file_id: str # The File to create a File Link for.}\n@optional {expires_at: str(date-time) # The time at which the File Link will expire. The default is 1 hour from the time of the request. The maximum is 1 day from the time of the request.}\n@returns(200) {created_at: str(date-time), expires_at: str(date-time), file_id: str, id: str, idempotency_key: any, type: str, unauthenticated_url: str} # File Link\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group files\n@endpoint GET /files\n@desc List Files\n@optional {cursor: str, limit: int, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), purpose.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # File List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /files\n@desc Create a File\n@returns(200) {created_at: str(date-time), description: any, direction: str, filename: any, id: str, idempotency_key: any, mime_type: str, purpose: str, type: str} # File\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /files/{file_id}\n@desc Retrieve a File\n@required {file_id: str}\n@returns(200) {created_at: str(date-time), description: any, direction: str, filename: any, id: str, idempotency_key: any, mime_type: str, purpose: str, type: str} # File\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group groups\n@endpoint GET /groups/current\n@desc Retrieve Group details\n@returns(200) {created_at: str(date-time), id: str, type: str} # Group\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_ach_transfers\n@endpoint GET /inbound_ach_transfers\n@desc List Inbound ACH Transfers\n@optional {cursor: str, limit: int, account_id: str, account_number_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str]}\n@returns(200) {data: [map], next_cursor: any} # Inbound ACH Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_ach_transfers/{inbound_ach_transfer_id}\n@desc Retrieve an Inbound ACH Transfer\n@required {inbound_ach_transfer_id: str}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, addenda: any, amount: int, automatically_resolves_at: str(date-time), created_at: str(date-time), decline: any, direction: str, effective_date: str(date), id: str, international_addenda: any, notification_of_change: any, originator_company_descriptive_date: any, originator_company_discretionary_data: any, originator_company_entry_description: str, originator_company_id: str, originator_company_name: str, originator_routing_number: str, receiver_id_number: any, receiver_name: any, settlement: map{settled_at: str(date-time), settlement_schedule: str}, standard_entry_class_code: str, status: str, trace_number: str, transfer_return: any, type: str} # Inbound ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_ach_transfers/{inbound_ach_transfer_id}/create_notification_of_change\n@desc Create a notification of change for an Inbound ACH Transfer\n@required {inbound_ach_transfer_id: str}\n@optional {updated_account_number: str # The updated account number to send in the notification of change., updated_routing_number: str # The updated routing number to send in the notification of change.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, addenda: any, amount: int, automatically_resolves_at: str(date-time), created_at: str(date-time), decline: any, direction: str, effective_date: str(date), id: str, international_addenda: any, notification_of_change: any, originator_company_descriptive_date: any, originator_company_discretionary_data: any, originator_company_entry_description: str, originator_company_id: str, originator_company_name: str, originator_routing_number: str, receiver_id_number: any, receiver_name: any, settlement: map{settled_at: str(date-time), settlement_schedule: str}, standard_entry_class_code: str, status: str, trace_number: str, transfer_return: any, type: str} # Inbound ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_ach_transfers/{inbound_ach_transfer_id}/decline\n@desc Decline an Inbound ACH Transfer\n@required {inbound_ach_transfer_id: str}\n@optional {reason: str(insufficient_funds/authorization_revoked_by_customer/payment_stopped/customer_advised_unauthorized_improper_ineligible_or_incomplete/representative_payee_deceased_or_unable_to_continue_in_that_capacity/beneficiary_or_account_holder_deceased/credit_entry_refused_by_receiver/duplicate_entry/corporate_customer_advised_not_authorized) # The reason why this transfer will be returned. If this parameter is unset, the return codes will be `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, addenda: any, amount: int, automatically_resolves_at: str(date-time), created_at: str(date-time), decline: any, direction: str, effective_date: str(date), id: str, international_addenda: any, notification_of_change: any, originator_company_descriptive_date: any, originator_company_discretionary_data: any, originator_company_entry_description: str, originator_company_id: str, originator_company_name: str, originator_routing_number: str, receiver_id_number: any, receiver_name: any, settlement: map{settled_at: str(date-time), settlement_schedule: str}, standard_entry_class_code: str, status: str, trace_number: str, transfer_return: any, type: str} # Inbound ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_ach_transfers/{inbound_ach_transfer_id}/transfer_return\n@desc Return an Inbound ACH Transfer\n@required {inbound_ach_transfer_id: str, reason: str(insufficient_funds/authorization_revoked_by_customer/payment_stopped/customer_advised_unauthorized_improper_ineligible_or_incomplete/representative_payee_deceased_or_unable_to_continue_in_that_capacity/beneficiary_or_account_holder_deceased/credit_entry_refused_by_receiver/duplicate_entry/corporate_customer_advised_not_authorized) # The reason why this transfer will be returned. The most usual return codes are `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, addenda: any, amount: int, automatically_resolves_at: str(date-time), created_at: str(date-time), decline: any, direction: str, effective_date: str(date), id: str, international_addenda: any, notification_of_change: any, originator_company_descriptive_date: any, originator_company_discretionary_data: any, originator_company_entry_description: str, originator_company_id: str, originator_company_name: str, originator_routing_number: str, receiver_id_number: any, receiver_name: any, settlement: map{settled_at: str(date-time), settlement_schedule: str}, standard_entry_class_code: str, status: str, trace_number: str, transfer_return: any, type: str} # Inbound ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_check_deposits\n@endpoint GET /inbound_check_deposits\n@desc List Inbound Check Deposits\n@optional {cursor: str, limit: int, account_id: str, check_transfer_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Inbound Check Deposit List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_check_deposits/{inbound_check_deposit_id}\n@desc Retrieve an Inbound Check Deposit\n@required {inbound_check_deposit_id: str}\n@returns(200) {accepted_at: any, account_id: str, account_number_id: any, adjustments: [map], amount: int, back_image_file_id: any, bank_of_first_deposit_routing_number: any, check_number: any, check_transfer_id: any, created_at: str(date-time), currency: str, declined_at: any, declined_transaction_id: any, deposit_return: any, front_image_file_id: any, id: str, payee_name_analysis: str, status: str, transaction_id: any, type: str} # Inbound Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_check_deposits/{inbound_check_deposit_id}/decline\n@desc Decline an Inbound Check Deposit\n@required {inbound_check_deposit_id: str}\n@returns(200) {accepted_at: any, account_id: str, account_number_id: any, adjustments: [map], amount: int, back_image_file_id: any, bank_of_first_deposit_routing_number: any, check_number: any, check_transfer_id: any, created_at: str(date-time), currency: str, declined_at: any, declined_transaction_id: any, deposit_return: any, front_image_file_id: any, id: str, payee_name_analysis: str, status: str, transaction_id: any, type: str} # Inbound Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_check_deposits/{inbound_check_deposit_id}/return\n@desc Return an Inbound Check Deposit\n@required {inbound_check_deposit_id: str, reason: str(altered_or_fictitious/not_authorized/duplicate_presentment/endorsement_missing/endorsement_irregular/refer_to_maker) # The reason to return the Inbound Check Deposit.}\n@returns(200) {accepted_at: any, account_id: str, account_number_id: any, adjustments: [map], amount: int, back_image_file_id: any, bank_of_first_deposit_routing_number: any, check_number: any, check_transfer_id: any, created_at: str(date-time), currency: str, declined_at: any, declined_transaction_id: any, deposit_return: any, front_image_file_id: any, id: str, payee_name_analysis: str, status: str, transaction_id: any, type: str} # Inbound Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_fednow_transfers\n@endpoint GET /inbound_fednow_transfers\n@desc List Inbound FedNow Transfers\n@optional {cursor: str, limit: int, account_id: str, account_number_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Inbound FedNow Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_fednow_transfers/{inbound_fednow_transfer_id}\n@desc Retrieve an Inbound FedNow Transfer\n@required {inbound_fednow_transfer_id: str}\n@returns(200) {account_id: str, account_number_id: str, amount: int, confirmation: any, created_at: str(date-time), creditor_name: str, currency: str, debtor_account_number: str, debtor_name: str, debtor_routing_number: str, decline: any, id: str, status: str, transaction_id: any, type: str, unstructured_remittance_information: any} # Inbound FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_mail_items\n@endpoint GET /inbound_mail_items\n@desc List Inbound Mail Items\n@optional {cursor: str, limit: int, lockbox_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Inbound Mail Item List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_mail_items/{inbound_mail_item_id}\n@desc Retrieve an Inbound Mail Item\n@required {inbound_mail_item_id: str}\n@returns(200) {checks: [map], created_at: str(date-time), file_id: str, id: str, lockbox_id: any, recipient_name: any, rejection_reason: any, status: str, type: str} # Inbound Mail Item\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_mail_items/{inbound_mail_item_id}/action\n@desc Action an Inbound Mail Item\n@required {inbound_mail_item_id: str, checks: [map{account_id: str, action!: str}] # The actions to perform on the Inbound Mail Item.}\n@returns(200) {checks: [map], created_at: str(date-time), file_id: str, id: str, lockbox_id: any, recipient_name: any, rejection_reason: any, status: str, type: str} # Inbound Mail Item\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_real_time_payments_transfers\n@endpoint GET /inbound_real_time_payments_transfers\n@desc List Inbound Real-Time Payments Transfers\n@optional {cursor: str, limit: int, account_id: str, account_number_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Inbound Real-Time Payments Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_real_time_payments_transfers/{inbound_real_time_payments_transfer_id}\n@desc Retrieve an Inbound Real-Time Payments Transfer\n@required {inbound_real_time_payments_transfer_id: str}\n@returns(200) {account_id: str, account_number_id: str, amount: int, confirmation: any, created_at: str(date-time), creditor_name: str, currency: str, debtor_account_number: str, debtor_name: str, debtor_routing_number: str, decline: any, id: str, status: str, transaction_identification: str, type: str, unstructured_remittance_information: any} # Inbound Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_wire_drawdown_requests\n@endpoint GET /inbound_wire_drawdown_requests\n@desc List Inbound Wire Drawdown Requests\n@optional {cursor: str, limit: int}\n@returns(200) {data: [map], next_cursor: any} # Inbound Wire Drawdown Request List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_wire_drawdown_requests/{inbound_wire_drawdown_request_id}\n@desc Retrieve an Inbound Wire Drawdown Request\n@required {inbound_wire_drawdown_request_id: str}\n@returns(200) {amount: int, created_at: str(date-time), creditor_account_number: str, creditor_address_line1: any, creditor_address_line2: any, creditor_address_line3: any, creditor_name: any, creditor_routing_number: str, currency: str, debtor_address_line1: any, debtor_address_line2: any, debtor_address_line3: any, debtor_name: any, end_to_end_identification: any, id: str, input_message_accountability_data: any, instruction_identification: any, recipient_account_number_id: str, type: str, unique_end_to_end_transaction_reference: any, unstructured_remittance_information: any} # Inbound Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group inbound_wire_transfers\n@endpoint GET /inbound_wire_transfers\n@desc List Inbound Wire Transfers\n@optional {cursor: str, limit: int, account_id: str, account_number_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), status.in: [str], wire_drawdown_request_id: str}\n@returns(200) {data: [map], next_cursor: any} # Inbound Wire Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /inbound_wire_transfers/{inbound_wire_transfer_id}\n@desc Retrieve an Inbound Wire Transfer\n@required {inbound_wire_transfer_id: str}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, amount: int, created_at: str(date-time), creditor_address_line1: any, creditor_address_line2: any, creditor_address_line3: any, creditor_name: any, debtor_address_line1: any, debtor_address_line2: any, debtor_address_line3: any, debtor_name: any, description: str, end_to_end_identification: any, id: str, input_message_accountability_data: any, instructing_agent_routing_number: any, instruction_identification: any, reversal: any, status: str, type: str, unique_end_to_end_transaction_reference: any, unstructured_remittance_information: any, wire_drawdown_request_id: any} # Inbound Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /inbound_wire_transfers/{inbound_wire_transfer_id}/reverse\n@desc Reverse an Inbound Wire Transfer\n@required {inbound_wire_transfer_id: str, reason: str(duplicate/creditor_request/transaction_forbidden) # Reason for the reversal.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, amount: int, created_at: str(date-time), creditor_address_line1: any, creditor_address_line2: any, creditor_address_line3: any, creditor_name: any, debtor_address_line1: any, debtor_address_line2: any, debtor_address_line3: any, debtor_name: any, description: str, end_to_end_identification: any, id: str, input_message_accountability_data: any, instructing_agent_routing_number: any, instruction_identification: any, reversal: any, status: str, type: str, unique_end_to_end_transaction_reference: any, unstructured_remittance_information: any, wire_drawdown_request_id: any} # Inbound Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group intrafi_account_enrollments\n@endpoint GET /intrafi_account_enrollments\n@desc List IntraFi Account Enrollments\n@optional {cursor: str, limit: int, account_id: str, status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # IntraFi Account Enrollment List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /intrafi_account_enrollments\n@desc Enroll an account in the IntraFi deposit sweep network\n@required {account_id: str # The identifier for the account to be added to IntraFi., email_address: str(email) # The contact email for the account owner, to be shared with IntraFi.}\n@returns(200) {account_id: str, created_at: str(date-time), email_address: any, id: str, idempotency_key: any, intrafi_id: str, status: str, type: str} # IntraFi Account Enrollment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /intrafi_account_enrollments/{intrafi_account_enrollment_id}\n@desc Get an IntraFi Account Enrollment\n@required {intrafi_account_enrollment_id: str}\n@returns(200) {account_id: str, created_at: str(date-time), email_address: any, id: str, idempotency_key: any, intrafi_id: str, status: str, type: str} # IntraFi Account Enrollment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /intrafi_account_enrollments/{intrafi_account_enrollment_id}/unenroll\n@desc Unenroll an account from IntraFi\n@required {intrafi_account_enrollment_id: str}\n@returns(200) {account_id: str, created_at: str(date-time), email_address: any, id: str, idempotency_key: any, intrafi_id: str, status: str, type: str} # IntraFi Account Enrollment\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group intrafi_exclusions\n@endpoint GET /intrafi_exclusions\n@desc List IntraFi Exclusions\n@optional {cursor: str, limit: int, entity_id: str, idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # IntraFi Exclusion List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /intrafi_exclusions\n@desc Create an IntraFi Exclusion\n@required {entity_id: str # The identifier of the Entity whose deposits will be excluded., fdic_certificate_number: str # The FDIC certificate number of the financial institution to be excluded. An FDIC certificate number uniquely identifies a financial institution, and is different than a routing number. To find one, we recommend searching by Bank Name using the [FDIC's bankfind tool](https://banks.data.fdic.gov/bankfind-suite/bankfind).}\n@returns(200) {bank_name: any, created_at: str(date-time), entity_id: str, excluded_at: any, fdic_certificate_number: any, id: str, idempotency_key: any, status: str, submitted_at: any, type: str} # IntraFi Exclusion\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /intrafi_exclusions/{intrafi_exclusion_id}\n@desc Get an IntraFi Exclusion\n@required {intrafi_exclusion_id: str}\n@returns(200) {bank_name: any, created_at: str(date-time), entity_id: str, excluded_at: any, fdic_certificate_number: any, id: str, idempotency_key: any, status: str, submitted_at: any, type: str} # IntraFi Exclusion\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /intrafi_exclusions/{intrafi_exclusion_id}/archive\n@desc Archive an IntraFi Exclusion\n@required {intrafi_exclusion_id: str}\n@returns(200) {bank_name: any, created_at: str(date-time), entity_id: str, excluded_at: any, fdic_certificate_number: any, id: str, idempotency_key: any, status: str, submitted_at: any, type: str} # IntraFi Exclusion\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group lockboxes\n@endpoint GET /lockboxes\n@desc List Lockboxes\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Lockbox List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /lockboxes\n@desc Create a Lockbox\n@required {account_id: str # The Account checks sent to this Lockbox should be deposited into.}\n@optional {description: str # The description you choose for the Lockbox, for display purposes., recipient_name: str # The name of the recipient that will receive mail at this location.}\n@returns(200) {account_id: str, address: map{city: str, line1: str, line2: str, postal_code: str, recipient: any, state: str}, check_deposit_behavior: str, created_at: str(date-time), description: any, id: str, idempotency_key: any, recipient_name: any, type: str} # Lockbox\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /lockboxes/{lockbox_id}\n@desc Retrieve a Lockbox\n@required {lockbox_id: str}\n@returns(200) {account_id: str, address: map{city: str, line1: str, line2: str, postal_code: str, recipient: any, state: str}, check_deposit_behavior: str, created_at: str(date-time), description: any, id: str, idempotency_key: any, recipient_name: any, type: str} # Lockbox\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /lockboxes/{lockbox_id}\n@desc Update a Lockbox\n@required {lockbox_id: str}\n@optional {check_deposit_behavior: str(enabled/disabled/pend_for_processing) # This indicates if checks mailed to this lockbox will be deposited., description: str # The description you choose for the Lockbox., recipient_name: str # The recipient name you choose for the Lockbox.}\n@returns(200) {account_id: str, address: map{city: str, line1: str, line2: str, postal_code: str, recipient: any, state: str}, check_deposit_behavior: str, created_at: str(date-time), description: any, id: str, idempotency_key: any, recipient_name: any, type: str} # Lockbox\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group oauth\n@endpoint POST /oauth/tokens\n@desc Create an OAuth Token\n@required {grant_type: str(authorization_code/production_token) # The credential you request in exchange for the code. In Production, this is always `authorization_code`. In Sandbox, you can pass either enum value.}\n@optional {client_id: str # The public identifier for your application., client_secret: str # The secret that confirms you own the application. This is redundant given that the request is made with your API key but it's a required component of OAuth 2.0., code: str # The authorization code generated by the user and given to you as a query parameter., production_token: str # The production token you want to exchange for a sandbox token. This is only available in Sandbox. Set `grant_type` to `production_token` to use this parameter.}\n@returns(200) {access_token: str, group_id: str, token_type: str, type: str} # OAuth Token\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group oauth_applications\n@endpoint GET /oauth_applications\n@desc List OAuth Applications\n@optional {cursor: str, limit: int, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # OAuth Application List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /oauth_applications/{oauth_application_id}\n@desc Retrieve an OAuth Application\n@required {oauth_application_id: str}\n@returns(200) {client_id: str, created_at: str(date-time), deleted_at: any, id: str, name: any, status: str, type: str} # OAuth Application\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group oauth_connections\n@endpoint GET /oauth_connections\n@desc List OAuth Connections\n@optional {cursor: str, limit: int, status.in: [str], oauth_application_id: str}\n@returns(200) {data: [map], next_cursor: any} # OAuth Connection List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /oauth_connections/{oauth_connection_id}\n@desc Retrieve an OAuth Connection\n@required {oauth_connection_id: str}\n@returns(200) {created_at: str(date-time), deleted_at: any, group_id: str, id: str, oauth_application_id: str, status: str, type: str} # OAuth Connection\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group pending_transactions\n@endpoint GET /pending_transactions\n@desc List Pending Transactions\n@optional {cursor: str, limit: int, account_id: str, route_id: str, category.in: [str], status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Pending Transaction List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /pending_transactions\n@desc Create a Pending Transaction\n@required {account_id: str # The Account to place the hold on., amount: int # The amount to hold in the minor unit of the account's currency. For dollars, for example, this is cents. This should be a negative amount - to hold $1.00 from the account, you would pass -100.}\n@optional {description: str # The description you choose to give the hold.}\n@returns(200) {account_id: str, amount: int, completed_at: any, created_at: str(date-time), currency: str, description: str, held_amount: int, id: str, route_id: any, route_type: any, source: map{account_transfer_instruction: any, ach_transfer_instruction: any, blockchain_offramp_transfer_instruction: any, blockchain_onramp_transfer_instruction: any, card_authorization: any, card_push_transfer_instruction: any, category: str, check_deposit_instruction: any, check_transfer_instruction: any, fednow_transfer_instruction: any, inbound_funds_hold: any, inbound_wire_transfer_reversal: any, other: any, real_time_payments_transfer_instruction: any, swift_transfer_instruction: any, user_initiated_hold: any, wire_transfer_instruction: any}, status: str, type: str} # Pending Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /pending_transactions/{pending_transaction_id}\n@desc Retrieve a Pending Transaction\n@required {pending_transaction_id: str}\n@returns(200) {account_id: str, amount: int, completed_at: any, created_at: str(date-time), currency: str, description: str, held_amount: int, id: str, route_id: any, route_type: any, source: map{account_transfer_instruction: any, ach_transfer_instruction: any, blockchain_offramp_transfer_instruction: any, blockchain_onramp_transfer_instruction: any, card_authorization: any, card_push_transfer_instruction: any, category: str, check_deposit_instruction: any, check_transfer_instruction: any, fednow_transfer_instruction: any, inbound_funds_hold: any, inbound_wire_transfer_reversal: any, other: any, real_time_payments_transfer_instruction: any, swift_transfer_instruction: any, user_initiated_hold: any, wire_transfer_instruction: any}, status: str, type: str} # Pending Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /pending_transactions/{pending_transaction_id}/release\n@desc Release a user-initiated Pending Transaction\n@required {pending_transaction_id: str}\n@returns(200) {account_id: str, amount: int, completed_at: any, created_at: str(date-time), currency: str, description: str, held_amount: int, id: str, route_id: any, route_type: any, source: map{account_transfer_instruction: any, ach_transfer_instruction: any, blockchain_offramp_transfer_instruction: any, blockchain_onramp_transfer_instruction: any, card_authorization: any, card_push_transfer_instruction: any, category: str, check_deposit_instruction: any, check_transfer_instruction: any, fednow_transfer_instruction: any, inbound_funds_hold: any, inbound_wire_transfer_reversal: any, other: any, real_time_payments_transfer_instruction: any, swift_transfer_instruction: any, user_initiated_hold: any, wire_transfer_instruction: any}, status: str, type: str} # Pending Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group physical_card_profiles\n@endpoint GET /physical_card_profiles\n@desc List Physical Card Profiles\n@optional {cursor: str, limit: int, status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Physical Card Profile List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /physical_card_profiles\n@desc Create a Physical Card Profile\n@required {carrier_image_file_id: str # The identifier of the File containing the physical card's carrier image., contact_phone: str # A phone number the user can contact to receive support for their card., description: str # A description you can use to identify the Card Profile., front_image_file_id: str # The identifier of the File containing the physical card's front image., program_id: str # The identifier for the Program that this Physical Card Profile falls under.}\n@optional {front_text: map{line1!: str, line2: str} # Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.}\n@returns(200) {back_image_file_id: any, carrier_image_file_id: any, contact_phone: any, created_at: str(date-time), creator: str, description: str, front_image_file_id: any, id: str, idempotency_key: any, is_default: bool, program_id: str, status: str, type: str} # Physical Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /physical_card_profiles/{physical_card_profile_id}\n@desc Retrieve a Card Profile\n@required {physical_card_profile_id: str}\n@returns(200) {back_image_file_id: any, carrier_image_file_id: any, contact_phone: any, created_at: str(date-time), creator: str, description: str, front_image_file_id: any, id: str, idempotency_key: any, is_default: bool, program_id: str, status: str, type: str} # Physical Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /physical_card_profiles/{physical_card_profile_id}/archive\n@desc Archive a Physical Card Profile\n@required {physical_card_profile_id: str}\n@returns(200) {back_image_file_id: any, carrier_image_file_id: any, contact_phone: any, created_at: str(date-time), creator: str, description: str, front_image_file_id: any, id: str, idempotency_key: any, is_default: bool, program_id: str, status: str, type: str} # Physical Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /physical_card_profiles/{physical_card_profile_id}/clone\n@desc Clone a Physical Card Profile\n@required {physical_card_profile_id: str}\n@optional {carrier_image_file_id: str # The identifier of the File containing the physical card's carrier image., contact_phone: str # A phone number the user can contact to receive support for their card., description: str # A description you can use to identify the Card Profile., front_image_file_id: str # The identifier of the File containing the physical card's front image., front_text: map{line1!: str, line2: str} # Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information., program_id: str # The identifier of the Program to use for the cloned Physical Card Profile.}\n@returns(200) {back_image_file_id: any, carrier_image_file_id: any, contact_phone: any, created_at: str(date-time), creator: str, description: str, front_image_file_id: any, id: str, idempotency_key: any, is_default: bool, program_id: str, status: str, type: str} # Physical Card Profile\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group physical_cards\n@endpoint GET /physical_cards\n@desc List Physical Cards\n@optional {cursor: str, limit: int, card_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Physical Card List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /physical_cards\n@desc Create a Physical Card\n@required {card_id: str # The underlying card representing this physical card., cardholder: map{first_name!: str, last_name!: str} # Details about the cardholder, as it will appear on the physical card., shipment: map{address!: map, method!: str, schedule: str} # The details used to ship this physical card.}\n@optional {physical_card_profile_id: str # The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.}\n@returns(200) {card_id: str, cardholder: map{first_name: str, last_name: str}, created_at: str(date-time), id: str, idempotency_key: any, physical_card_profile_id: any, shipment: map{address: map{city: str, country: str, line1: str, line2: any, line3: any, name: str, postal_code: str, state: str}, method: str, schedule: str, status: str, tracking: any}, status: str, type: str} # Physical Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /physical_cards/{physical_card_id}\n@desc Retrieve a Physical Card\n@required {physical_card_id: str}\n@returns(200) {card_id: str, cardholder: map{first_name: str, last_name: str}, created_at: str(date-time), id: str, idempotency_key: any, physical_card_profile_id: any, shipment: map{address: map{city: str, country: str, line1: str, line2: any, line3: any, name: str, postal_code: str, state: str}, method: str, schedule: str, status: str, tracking: any}, status: str, type: str} # Physical Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint PATCH /physical_cards/{physical_card_id}\n@desc Update a Physical Card\n@required {physical_card_id: str, status: str(active/disabled/canceled) # The status to update the Physical Card to.}\n@returns(200) {card_id: str, cardholder: map{first_name: str, last_name: str}, created_at: str(date-time), id: str, idempotency_key: any, physical_card_profile_id: any, shipment: map{address: map{city: str, country: str, line1: str, line2: any, line3: any, name: str, postal_code: str, state: str}, method: str, schedule: str, status: str, tracking: any}, status: str, type: str} # Physical Card\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group programs\n@endpoint GET /programs\n@desc List Programs\n@optional {cursor: str, limit: int}\n@returns(200) {data: [map], next_cursor: any} # Program List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /programs/{program_id}\n@desc Retrieve a Program\n@required {program_id: str}\n@returns(200) {bank: str, billing_account_id: any, created_at: str(date-time), default_digital_card_profile_id: any, id: str, interest_rate: str, lending: any, name: str, type: str, updated_at: str(date-time)} # Program\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group real_time_decisions\n@endpoint GET /real_time_decisions/{real_time_decision_id}\n@desc Retrieve a Real-Time Decision\n@required {real_time_decision_id: str}\n@returns(200) {card_authentication: any, card_authentication_challenge: any, card_authorization: any, card_balance_inquiry: any, category: str, created_at: str(date-time), digital_wallet_authentication: any, digital_wallet_token: any, id: str, status: str, timeout_at: str(date-time), type: str} # Real-Time Decision\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /real_time_decisions/{real_time_decision_id}/action\n@desc Action a Real-Time Decision\n@required {real_time_decision_id: str}\n@optional {card_authentication: map{decision!: str} # If the Real-Time Decision relates to a 3DS card authentication attempt, this object contains your response to the authentication., card_authentication_challenge: map{result!: str, success: map} # If the Real-Time Decision relates to 3DS card authentication challenge delivery, this object contains your response., card_authorization: map{approval: map, decision!: str, decline: map} # If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization., card_balance_inquiry: map{approval: map, decision!: str} # If the Real-Time Decision relates to a card balance inquiry attempt, this object contains your response to the inquiry., digital_wallet_authentication: map{result!: str, success: map} # If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication., digital_wallet_token: map{approval: map, decline: map} # If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.}\n@returns(200) {card_authentication: any, card_authentication_challenge: any, card_authorization: any, card_balance_inquiry: any, category: str, created_at: str(date-time), digital_wallet_authentication: any, digital_wallet_token: any, id: str, status: str, timeout_at: str(date-time), type: str} # Real-Time Decision\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group real_time_payments_transfers\n@endpoint GET /real_time_payments_transfers\n@desc List Real-Time Payments Transfers\n@optional {cursor: str, limit: int, account_id: str, external_account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Real-Time Payments Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /real_time_payments_transfers\n@desc Create a Real-Time Payments Transfer\n@required {amount: int # The transfer amount in USD cents. For Real-Time Payments transfers, must be positive., creditor_name: str # The name of the transfer's recipient., source_account_number_id: str # The identifier of the Account Number from which to send the transfer., unstructured_remittance_information: str # Unstructured information that will show on the recipient's bank statement.}\n@optional {account_number: str # The destination account number., debtor_name: str # The name of the transfer's sender. If not provided, defaults to the name of the account's entity., external_account_id: str # The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., routing_number: str # The destination American Bankers' Association (ABA) Routing Transit Number (RTN)., ultimate_creditor_name: str # The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else., ultimate_debtor_name: str # The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor_name: str, currency: str, debtor_name: any, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, ultimate_creditor_name: any, ultimate_debtor_name: any, unstructured_remittance_information: str} # Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /real_time_payments_transfers/{real_time_payments_transfer_id}\n@desc Retrieve a Real-Time Payments Transfer\n@required {real_time_payments_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor_name: str, currency: str, debtor_name: any, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, ultimate_creditor_name: any, ultimate_debtor_name: any, unstructured_remittance_information: str} # Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /real_time_payments_transfers/{real_time_payments_transfer_id}/approve\n@desc Approve a Real-Time Payments Transfer\n@required {real_time_payments_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor_name: str, currency: str, debtor_name: any, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, ultimate_creditor_name: any, ultimate_debtor_name: any, unstructured_remittance_information: str} # Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /real_time_payments_transfers/{real_time_payments_transfer_id}/cancel\n@desc Cancel a pending Real-Time Payments Transfer\n@required {real_time_payments_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor_name: str, currency: str, debtor_name: any, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, ultimate_creditor_name: any, ultimate_debtor_name: any, unstructured_remittance_information: str} # Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group routing_numbers\n@endpoint GET /routing_numbers\n@desc List Routing Numbers\n@required {routing_number: str}\n@optional {cursor: str, limit: int}\n@returns(200) {data: [map], next_cursor: any} # Routing Number List\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group simulations\n@endpoint POST /simulations/account_statements\n@desc Sandbox: Create an Account Statement\n@required {account_id: str # The identifier of the Account the statement is for.}\n@returns(200) {account_id: str, created_at: str(date-time), ending_balance: int, file_id: str, id: str, loan: any, starting_balance: int, statement_period_end: str(date-time), statement_period_start: str(date-time), type: str} # Account Statement\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/account_transfers/{account_transfer_id}/complete\n@desc Sandbox: Approve an Account Transfer\n@required {account_transfer_id: str}\n@returns(200) {account_id: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, currency: str, description: str, destination_account_id: str, destination_transaction_id: any, id: str, idempotency_key: any, pending_transaction_id: any, status: str, transaction_id: any, type: str} # Account Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/ach_transfers/{ach_transfer_id}/acknowledge\n@desc Sandbox: Acknowledge an ACH Transfer\n@required {ach_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/ach_transfers/{ach_transfer_id}/create_notification_of_change\n@desc Sandbox: Create a Notification of Change for an ACH Transfer\n@required {ach_transfer_id: str, change_code: str(incorrect_account_number/incorrect_routing_number/incorrect_routing_number_and_account_number/incorrect_transaction_code/incorrect_account_number_and_transaction_code/incorrect_routing_number_account_number_and_transaction_code/incorrect_receiving_depository_financial_institution_identification/incorrect_individual_identification_number/addenda_format_error/incorrect_standard_entry_class_code_for_outbound_international_payment/misrouted_notification_of_change/incorrect_trace_number/incorrect_company_identification_number/incorrect_identification_number/incorrectly_formatted_corrected_data/incorrect_discretionary_data/routing_number_not_from_original_entry_detail_record/depository_financial_institution_account_number_not_from_original_entry_detail_record/incorrect_transaction_code_by_originating_depository_financial_institution) # The reason for the notification of change., corrected_data: str # The corrected data for the notification of change (e.g., a new routing number).}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/ach_transfers/{ach_transfer_id}/return\n@desc Sandbox: Return an ACH Transfer\n@required {ach_transfer_id: str}\n@optional {reason: str(insufficient_fund/no_account/account_closed/invalid_account_number_structure/account_frozen_entry_returned_per_ofac_instruction/credit_entry_refused_by_receiver/unauthorized_debit_to_consumer_account_using_corporate_sec_code/corporate_customer_advised_not_authorized/payment_stopped/non_transaction_account/uncollected_funds/routing_number_check_digit_error/customer_advised_unauthorized_improper_ineligible_or_incomplete/amount_field_error/authorization_revoked_by_customer/invalid_ach_routing_number/file_record_edit_criteria/enr_invalid_individual_name/returned_per_odfi_request/limited_participation_dfi/incorrectly_coded_outbound_international_payment/account_sold_to_another_dfi/addenda_error/beneficiary_or_account_holder_deceased/customer_advised_not_within_authorization_terms/corrected_return/duplicate_entry/duplicate_return/enr_duplicate_enrollment/enr_invalid_dfi_account_number/enr_invalid_individual_id_number/enr_invalid_representative_payee_indicator/enr_invalid_transaction_code/enr_return_of_enr_entry/enr_routing_number_check_digit_error/entry_not_processed_by_gateway/field_error/foreign_receiving_dfi_unable_to_settle/iat_entry_coding_error/improper_effective_entry_date/improper_source_document_source_document_presented/invalid_company_id/invalid_foreign_receiving_dfi_identification/invalid_individual_id_number/item_and_rck_entry_presented_for_payment/item_related_to_rck_entry_is_ineligible/mandatory_field_error/misrouted_dishonored_return/misrouted_return/no_errors_found/non_acceptance_of_r62_dishonored_return/non_participant_in_iat_program/permissible_return_entry/permissible_return_entry_not_accepted/rdfi_non_settlement/rdfi_participant_in_check_truncation_program/representative_payee_deceased_or_unable_to_continue_in_that_capacity/return_not_a_duplicate/return_of_erroneous_or_reversing_debit/return_of_improper_credit_entry/return_of_improper_debit_entry/return_of_xck_entry/source_document_presented_for_payment/state_law_affecting_rck_acceptance/stop_payment_on_item_related_to_rck_entry/stop_payment_on_source_document/timely_original_return/trace_number_error/untimely_dishonored_return/untimely_return) # The reason why the Federal Reserve or destination bank returned this transfer. Defaults to `no_account`.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/ach_transfers/{ach_transfer_id}/settle\n@desc Sandbox: Settle an ACH Transfer\n@required {ach_transfer_id: str}\n@optional {inbound_funds_hold_behavior: str(release_immediately/release_on_default_schedule) # The behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/ach_transfers/{ach_transfer_id}/submit\n@desc Sandbox: Submit an ACH Transfer\n@required {ach_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, addenda: any, amount: int, approval: any, cancellation: any, company_descriptive_date: any, company_discretionary_data: any, company_entry_description: any, company_id: str, company_name: any, created_at: str(date-time), created_by: any, currency: str, destination_account_holder: str, external_account_id: any, funding: str, id: str, idempotency_key: any, inbound_funds_hold: any, individual_id: any, individual_name: any, network: str, notifications_of_change: [map], pending_transaction_id: any, preferred_effective_date: map{date: any, settlement_schedule: any}, return: any, routing_number: str, settlement: any, standard_entry_class_code: str, statement_descriptor: str, status: str, submission: any, transaction_id: any, type: str} # ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_authentications\n@desc Sandbox: Create a Card Authentication attempt\n@required {card_id: str # The identifier of the Card to be authorized.}\n@optional {category: str(payment_authentication/non_payment_authentication) # The category of the card authentication attempt., device_channel: str(app/browser/three_ds_requestor_initiated) # The device channel of the card authentication attempt., merchant_acceptor_id: str # The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with., merchant_category_code: str # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with., merchant_country: str # The country the merchant resides in., merchant_name: str # The name of the merchant, purchase_amount: int # The purchase amount in cents.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_authentications/{card_payment_id}/challenge_attempts\n@desc Sandbox: Create a Card Authentication Challenge attempt\n@required {card_payment_id: str, one_time_code: str # The one-time code to be validated.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_authentications/{card_payment_id}/challenges\n@desc Sandbox: Create an initial Card Authentication Challenge\n@required {card_payment_id: str}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_authorization_expirations\n@desc Sandbox: Expire a Card Authorization\n@required {card_payment_id: str # The identifier of the Card Payment to expire.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_authorizations\n@desc Sandbox: Create a Card Authorization\n@required {amount: int # The authorization amount in cents.}\n@optional {authenticated_card_payment_id: str # The identifier of a Card Payment with a `card_authentication` if you want to simulate an authenticated authorization., card_id: str # The identifier of the Card to be authorized., decline_reason: str(account_closed/card_not_active/card_canceled/physical_card_not_active/entity_not_active/group_locked/insufficient_funds/cvv2_mismatch/pin_mismatch/card_expiration_mismatch/transaction_not_allowed/breaches_limit/webhook_declined/webhook_timed_out/declined_by_stand_in_processing/invalid_physical_card/missing_original_authorization/invalid_cryptogram/failed_3ds_authentication/suspected_card_testing/suspected_fraud) # Forces a card decline with a specific reason. No real time decision will be sent., digital_wallet_token_id: str # The identifier of the Digital Wallet Token to be authorized., event_subscription_id: str # The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes., merchant_acceptor_id: str # The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with., merchant_category_code: str # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with., merchant_city: str # The city the merchant resides in., merchant_country: str # The country the merchant resides in., merchant_descriptor: str # The merchant descriptor of the merchant the card is transacting with., merchant_state: str # The state the merchant resides in., network_details: map{visa!: map} # Fields specific to a given card network., network_risk_score: int # The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest., physical_card_id: str # The identifier of the Physical Card to be authorized., processing_category: map{category!: str, refund: map} # Fields specific to a specific type of authorization, such as Automatic Fuel Dispensers, Refund Authorizations, or Cash Disbursements., terminal_id: str # The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.}\n@returns(200) {declined_transaction: any, pending_transaction: any, type: str} # Inbound Card Authorization Simulation Result\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_balance_inquiries\n@desc Sandbox: Create a Card Balance Inquiry\n@optional {balance: int # The balance amount in cents. The account balance will be used if not provided., card_id: str # The identifier of the Card to be authorized., decline_reason: str(account_closed/card_not_active/card_canceled/physical_card_not_active/entity_not_active/group_locked/insufficient_funds/cvv2_mismatch/pin_mismatch/card_expiration_mismatch/transaction_not_allowed/breaches_limit/webhook_declined/webhook_timed_out/declined_by_stand_in_processing/invalid_physical_card/missing_original_authorization/invalid_cryptogram/failed_3ds_authentication/suspected_card_testing/suspected_fraud) # Forces a card decline with a specific reason. No real time decision will be sent., digital_wallet_token_id: str # The identifier of the Digital Wallet Token to be authorized., event_subscription_id: str # The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes., merchant_acceptor_id: str # The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with., merchant_category_code: str # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with., merchant_city: str # The city the merchant resides in., merchant_country: str # The country the merchant resides in., merchant_descriptor: str # The merchant descriptor of the merchant the card is transacting with., merchant_state: str # The state the merchant resides in., network_details: map{visa!: map} # Fields specific to a given card network., network_risk_score: int # The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest., physical_card_id: str # The identifier of the Physical Card to be authorized., terminal_id: str # The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_disputes/{card_dispute_id}/action\n@desc Sandbox: Advance the state of a Card Dispute\n@required {card_dispute_id: str, network: str # The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.}\n@optional {visa: map{accept_chargeback: map, accept_user_submission: map, action!: str, decline_user_prearbitration: map, receive_merchant_prearbitration: map, represent: map, request_further_information: map, time_out_chargeback: map, time_out_merchant_prearbitration: map, time_out_representment: map, time_out_user_prearbitration: map} # The Visa-specific parameters for the taking action on the dispute. Required if and only if `network` is `visa`.}\n@returns(200) {amount: int, card_id: str, created_at: str(date-time), disputed_transaction_id: str, id: str, idempotency_key: any, loss: any, network: str, status: str, type: str, user_submission_required_by: any, visa: any, win: any, withdrawal: any} # Card Dispute\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_fuel_confirmations\n@desc Sandbox: Confirm the fuel pump amount for a Card Authorization\n@required {amount: int # The amount of the fuel_confirmation in minor units in the card authorization's currency., card_payment_id: str # The identifier of the Card Payment to create a fuel_confirmation on.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_increments\n@desc Sandbox: Increment a Card Authorization\n@required {amount: int # The amount of the increment in minor units in the card authorization's currency., card_payment_id: str # The identifier of the Card Payment to create an increment on.}\n@optional {event_subscription_id: str # The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_refunds\n@desc Sandbox: Refund a card transaction\n@optional {amount: int # The refund amount in cents. Pulled off the `pending_transaction` or the `transaction` if not provided., pending_transaction_id: str # The identifier of the Pending Transaction for the refund authorization. If this is provided, `transaction` must not be provided as a refund with a refund authorized can not be linked to a regular transaction., transaction_id: str # The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement.}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), currency: str, description: str, id: str, route_id: any, route_type: any, source: map{account_revenue_payment: any, account_transfer_intention: any, ach_transfer_intention: any, ach_transfer_rejection: any, ach_transfer_return: any, blockchain_offramp_transfer_settlement: any, blockchain_onramp_transfer_intention: any, card_dispute_acceptance: any, card_dispute_financial: any, card_dispute_loss: any, card_financial: any, card_push_transfer_acceptance: any, card_refund: any, card_revenue_payment: any, card_settlement: any, cashback_payment: any, category: str, check_deposit_acceptance: any, check_deposit_return: any, check_transfer_deposit: any, fednow_transfer_acknowledgement: any, fee_payment: any, inbound_ach_transfer: any, inbound_ach_transfer_return_intention: any, inbound_check_adjustment: any, inbound_check_deposit_return_intention: any, inbound_fednow_transfer_confirmation: any, inbound_real_time_payments_transfer_confirmation: any, inbound_wire_reversal: any, inbound_wire_transfer: any, inbound_wire_transfer_reversal: any, interest_payment: any, internal_source: any, other: any, real_time_payments_transfer_acknowledgement: any, sample_funds: any, swift_transfer_intention: any, swift_transfer_return: any, wire_transfer_intention: any}, type: str} # Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_reversals\n@desc Sandbox: Reverse a Card Authorization\n@required {card_payment_id: str # The identifier of the Card Payment to create a reversal on.}\n@optional {amount: int # The amount of the reversal in minor units in the card authorization's currency. This defaults to the authorization amount.}\n@returns(200) {account_id: str, card_id: str, created_at: str(date-time), digital_wallet_token_id: any, elements: [map], id: str, physical_card_id: any, state: map{authorized_amount: int, fuel_confirmed_amount: int, incremented_amount: int, refund_authorized_amount: int, refunded_amount: int, reversed_amount: int, settled_amount: int}, type: str} # Card Payment\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_settlements\n@desc Sandbox: Settle a Card Authorization\n@required {card_id: str # The identifier of the Card to create a settlement on., pending_transaction_id: str # The identifier of the Pending Transaction for the Card Authorization you wish to settle.}\n@optional {amount: int # The amount to be settled. This defaults to the amount of the Pending Transaction being settled.}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), currency: str, description: str, id: str, route_id: any, route_type: any, source: map{account_revenue_payment: any, account_transfer_intention: any, ach_transfer_intention: any, ach_transfer_rejection: any, ach_transfer_return: any, blockchain_offramp_transfer_settlement: any, blockchain_onramp_transfer_intention: any, card_dispute_acceptance: any, card_dispute_financial: any, card_dispute_loss: any, card_financial: any, card_push_transfer_acceptance: any, card_refund: any, card_revenue_payment: any, card_settlement: any, cashback_payment: any, category: str, check_deposit_acceptance: any, check_deposit_return: any, check_transfer_deposit: any, fednow_transfer_acknowledgement: any, fee_payment: any, inbound_ach_transfer: any, inbound_ach_transfer_return_intention: any, inbound_check_adjustment: any, inbound_check_deposit_return_intention: any, inbound_fednow_transfer_confirmation: any, inbound_real_time_payments_transfer_confirmation: any, inbound_wire_reversal: any, inbound_wire_transfer: any, inbound_wire_transfer_reversal: any, interest_payment: any, internal_source: any, other: any, real_time_payments_transfer_acknowledgement: any, sample_funds: any, swift_transfer_intention: any, swift_transfer_return: any, wire_transfer_intention: any}, type: str} # Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/card_tokens\n@desc Sandbox: Create a Card Token\n@optional {capabilities: [map{cross_border_push_transfers!: str, domestic_push_transfers!: str, route!: str}] # The capabilities of the outbound card token., expiration: str(date) # The expiration date of the card., last4: str # The last 4 digits of the card number., outcome: map{decline: map, result!: str} # The outcome to simulate for card push transfers using this token., prefix: str # The prefix of the card number, usually the first 8 digits., primary_account_number_length: int # The total length of the card number, including prefix and last4.}\n@returns(200) {created_at: str(date-time), expiration_date: str(date), id: str, last4: str, length: int, prefix: str, type: str} # Card Token\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/check_deposits/{check_deposit_id}/adjustment\n@desc Sandbox: Adjust a Check Deposit\n@required {check_deposit_id: str}\n@optional {amount: int # The adjustment amount in the minor unit of the Check Deposit's currency (e.g., cents). A negative amount means that the funds are being clawed back by the other bank and is a debit to your account. Defaults to the negative of the Check Deposit amount., reason: str(late_return/wrong_payee_credit/adjusted_amount/non_conforming_item/paid) # The reason for the adjustment. Defaults to `non_conforming_item`, which is often used for a low quality image that the recipient wasn't able to handle.}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/check_deposits/{check_deposit_id}/reject\n@desc Sandbox: Reject a Check Deposit\n@required {check_deposit_id: str}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/check_deposits/{check_deposit_id}/return\n@desc Sandbox: Return a Check Deposit\n@required {check_deposit_id: str}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/check_deposits/{check_deposit_id}/submit\n@desc Sandbox: Submit a Check Deposit\n@required {check_deposit_id: str}\n@optional {scan: map{account_number!: str, auxiliary_on_us: str, routing_number!: str} # If set, the simulation will use these values for the check's scanned MICR data.}\n@returns(200) {account_id: str, amount: int, back_image_file_id: any, created_at: str(date-time), deposit_acceptance: any, deposit_adjustments: [map], deposit_rejection: any, deposit_return: any, deposit_submission: any, description: any, front_image_file_id: str, id: str, idempotency_key: any, inbound_funds_hold: any, inbound_mail_item_id: any, lockbox_id: any, status: str, transaction_id: any, type: str} # Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/check_transfers/{check_transfer_id}/mail\n@desc Sandbox: Mail a Check Transfer\n@required {check_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, approved_inbound_check_deposit_id: any, balance_check: any, cancellation: any, check_number: str, created_at: str(date-time), created_by: any, currency: str, fulfillment_method: str, id: str, idempotency_key: any, mailing: any, pending_transaction_id: any, physical_check: any, routing_number: str, source_account_number_id: any, status: str, stop_payment_request: any, submission: any, third_party: any, type: str, valid_until_date: any} # Check Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/digital_wallet_token_requests\n@desc Sandbox: Create a digital wallet token request\n@required {card_id: str # The identifier of the Card to be authorized.}\n@returns(200) {decline_reason: any, digital_wallet_token_id: any, type: str} # Inbound Digital Wallet Token Request Simulation Result\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/exports\n@desc Sandbox: Generate a Tax Form Export\n@required {category: str # The type of Export to create.}\n@optional {form_1099_int: map{account_id!: str} # Options for the created export. Required if `category` is equal to `form_1099_int`.}\n@returns(200) {account_statement_bai2: any, account_statement_ofx: any, account_verification_letter: any, balance_csv: any, bookkeeping_account_balance_csv: any, category: str, created_at: str(date-time), dashboard_table_csv: any, entity_csv: any, fee_csv: any, form_1099_int: any, form_1099_misc: any, funding_instructions: any, id: str, idempotency_key: any, result: any, status: str, transaction_csv: any, type: str, vendor_csv: any, voided_check: any} # Export\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_ach_transfers\n@desc Sandbox: Create an Inbound ACH Transfer\n@required {account_number_id: str # The identifier of the Account Number the inbound ACH Transfer is for., amount: int # The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.}\n@optional {addenda: map{category!: str, freeform: map} # Additional information to include in the transfer., company_descriptive_date: str # The description of the date of the transfer., company_discretionary_data: str # Data associated with the transfer set by the sender., company_entry_description: str # The description of the transfer set by the sender., company_id: str # The sender's company ID., company_name: str # The name of the sender., receiver_id_number: str # The ID of the receiver of the transfer., receiver_name: str # The name of the receiver of the transfer., resolve_at: str(date-time) # The time at which the transfer should be resolved. If not provided will resolve immediately., standard_entry_class_code: str(corporate_credit_or_debit/corporate_trade_exchange/prearranged_payments_and_deposit/internet_initiated/point_of_sale/telephone_initiated/customer_initiated/accounts_receivable/machine_transfer/shared_network_transaction/represented_check/back_office_conversion/point_of_purchase/check_truncation/destroyed_check/international_ach_transaction) # The standard entry class code for the transfer.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, addenda: any, amount: int, automatically_resolves_at: str(date-time), created_at: str(date-time), decline: any, direction: str, effective_date: str(date), id: str, international_addenda: any, notification_of_change: any, originator_company_descriptive_date: any, originator_company_discretionary_data: any, originator_company_entry_description: str, originator_company_id: str, originator_company_name: str, originator_routing_number: str, receiver_id_number: any, receiver_name: any, settlement: map{settled_at: str(date-time), settlement_schedule: str}, standard_entry_class_code: str, status: str, trace_number: str, transfer_return: any, type: str} # Inbound ACH Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_check_deposits\n@desc Sandbox: Create an Inbound Check Deposit\n@required {account_number_id: str # The identifier of the Account Number the Inbound Check Deposit will be against., amount: int # The check amount in cents., check_number: str # The check number on the check to be deposited.}\n@optional {payee_name_analysis: str(name_matches/does_not_match/not_evaluated) # Simulate the outcome of [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches). Defaults to `not_evaluated`.}\n@returns(200) {accepted_at: any, account_id: str, account_number_id: any, adjustments: [map], amount: int, back_image_file_id: any, bank_of_first_deposit_routing_number: any, check_number: any, check_transfer_id: any, created_at: str(date-time), currency: str, declined_at: any, declined_transaction_id: any, deposit_return: any, front_image_file_id: any, id: str, payee_name_analysis: str, status: str, transaction_id: any, type: str} # Inbound Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment\n@desc Sandbox: Create an Inbound Check Deposit Adjustment\n@required {inbound_check_deposit_id: str}\n@optional {amount: int # The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit., reason: str(late_return/wrong_payee_credit/adjusted_amount/non_conforming_item/paid) # The reason for the adjustment. Defaults to `wrong_payee_credit`.}\n@returns(200) {accepted_at: any, account_id: str, account_number_id: any, adjustments: [map], amount: int, back_image_file_id: any, bank_of_first_deposit_routing_number: any, check_number: any, check_transfer_id: any, created_at: str(date-time), currency: str, declined_at: any, declined_transaction_id: any, deposit_return: any, front_image_file_id: any, id: str, payee_name_analysis: str, status: str, transaction_id: any, type: str} # Inbound Check Deposit\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_fednow_transfers\n@desc Sandbox: Create an Inbound FedNow Transfer\n@required {account_number_id: str # The identifier of the Account Number the inbound FedNow Transfer is for., amount: int # The transfer amount in USD cents. Must be positive.}\n@optional {debtor_account_number: str # The account number of the account that sent the transfer., debtor_name: str # The name provided by the sender of the transfer., debtor_routing_number: str # The routing number of the account that sent the transfer., unstructured_remittance_information: str # Additional information included with the transfer.}\n@returns(200) {account_id: str, account_number_id: str, amount: int, confirmation: any, created_at: str(date-time), creditor_name: str, currency: str, debtor_account_number: str, debtor_name: str, debtor_routing_number: str, decline: any, id: str, status: str, transaction_id: any, type: str, unstructured_remittance_information: any} # Inbound FedNow Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_mail_items\n@desc Sandbox: Create an Inbound Mail Item\n@required {amount: int # The amount of the check to be simulated, in cents., lockbox_id: str # The identifier of the Lockbox to simulate inbound mail to.}\n@optional {contents_file_id: str # The file containing the PDF contents. If not present, a default check image file will be used.}\n@returns(200) {checks: [map], created_at: str(date-time), file_id: str, id: str, lockbox_id: any, recipient_name: any, rejection_reason: any, status: str, type: str} # Inbound Mail Item\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_real_time_payments_transfers\n@desc Sandbox: Create an Inbound Real-Time Payments Transfer\n@required {account_number_id: str # The identifier of the Account Number the inbound Real-Time Payments Transfer is for., amount: int # The transfer amount in USD cents. Must be positive.}\n@optional {debtor_account_number: str # The account number of the account that sent the transfer., debtor_name: str # The name provided by the sender of the transfer., debtor_routing_number: str # The routing number of the account that sent the transfer., request_for_payment_id: str # The identifier of a pending Request for Payment that this transfer will fulfill., unstructured_remittance_information: str # Additional information included with the transfer.}\n@returns(200) {account_id: str, account_number_id: str, amount: int, confirmation: any, created_at: str(date-time), creditor_name: str, currency: str, debtor_account_number: str, debtor_name: str, debtor_routing_number: str, decline: any, id: str, status: str, transaction_identification: str, type: str, unstructured_remittance_information: any} # Inbound Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_wire_drawdown_requests\n@desc Sandbox: Create an Inbound Wire Drawdown request\n@required {amount: int # The amount being requested in cents., creditor_account_number: str # The creditor's account number., creditor_routing_number: str # The creditor's routing number., currency: str # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be \"USD\"., recipient_account_number_id: str # The Account Number to which the recipient of this request is being requested to send funds from.}\n@optional {creditor_address_line1: str # A free-form address field set by the sender representing the first line of the creditor's address., creditor_address_line2: str # A free-form address field set by the sender representing the second line of the creditor's address., creditor_address_line3: str # A free-form address field set by the sender representing the third line of the creditor's address., creditor_name: str # A free-form name field set by the sender representing the creditor's name., debtor_account_number: str # The debtor's account number., debtor_address_line1: str # A free-form address field set by the sender representing the first line of the debtor's address., debtor_address_line2: str # A free-form address field set by the sender representing the second line of the debtor's address., debtor_address_line3: str # A free-form address field set by the sender., debtor_name: str # A free-form name field set by the sender representing the debtor's name., debtor_routing_number: str # The debtor's routing number., end_to_end_identification: str # A free-form reference string set by the sender, to help identify the transfer., instruction_identification: str # The sending bank's identifier for the wire transfer., unique_end_to_end_transaction_reference: str # The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer., unstructured_remittance_information: str # A free-form message set by the sender.}\n@returns(200) {amount: int, created_at: str(date-time), creditor_account_number: str, creditor_address_line1: any, creditor_address_line2: any, creditor_address_line3: any, creditor_name: any, creditor_routing_number: str, currency: str, debtor_address_line1: any, debtor_address_line2: any, debtor_address_line3: any, debtor_name: any, end_to_end_identification: any, id: str, input_message_accountability_data: any, instruction_identification: any, recipient_account_number_id: str, type: str, unique_end_to_end_transaction_reference: any, unstructured_remittance_information: any} # Inbound Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/inbound_wire_transfers\n@desc Sandbox: Create an Inbound Wire Transfer\n@required {account_number_id: str # The identifier of the Account Number the inbound Wire Transfer is for., amount: int # The transfer amount in cents. Must be positive.}\n@optional {creditor_address_line1: str # The sending bank will set creditor_address_line1 in production. You can simulate any value here., creditor_address_line2: str # The sending bank will set creditor_address_line2 in production. You can simulate any value here., creditor_address_line3: str # The sending bank will set creditor_address_line3 in production. You can simulate any value here., creditor_name: str # The sending bank will set creditor_name in production. You can simulate any value here., debtor_address_line1: str # The sending bank will set debtor_address_line1 in production. You can simulate any value here., debtor_address_line2: str # The sending bank will set debtor_address_line2 in production. You can simulate any value here., debtor_address_line3: str # The sending bank will set debtor_address_line3 in production. You can simulate any value here., debtor_name: str # The sending bank will set debtor_name in production. You can simulate any value here., end_to_end_identification: str # The sending bank will set end_to_end_identification in production. You can simulate any value here., instructing_agent_routing_number: str # The sending bank will set instructing_agent_routing_number in production. You can simulate any value here., instruction_identification: str # The sending bank will set instruction_identification in production. You can simulate any value here., unique_end_to_end_transaction_reference: str # The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here., unstructured_remittance_information: str # The sending bank will set unstructured_remittance_information in production. You can simulate any value here., wire_drawdown_request_id: str # The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.}\n@returns(200) {acceptance: any, account_id: str, account_number_id: str, amount: int, created_at: str(date-time), creditor_address_line1: any, creditor_address_line2: any, creditor_address_line3: any, creditor_name: any, debtor_address_line1: any, debtor_address_line2: any, debtor_address_line3: any, debtor_name: any, description: str, end_to_end_identification: any, id: str, input_message_accountability_data: any, instructing_agent_routing_number: any, instruction_identification: any, reversal: any, status: str, type: str, unique_end_to_end_transaction_reference: any, unstructured_remittance_information: any, wire_drawdown_request_id: any} # Inbound Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/interest_payments\n@desc Sandbox: Create an interest payment\n@required {account_id: str # The identifier of the Account the Interest Payment should be paid to is for., amount: int # The interest amount in cents. Must be positive.}\n@optional {accrued_on_account_id: str # The identifier of the Account the Interest accrued on. Defaults to `account_id`., period_end: str(date-time) # The end of the interest period. If not provided, defaults to the current time., period_start: str(date-time) # The start of the interest period. If not provided, defaults to the current time.}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), currency: str, description: str, id: str, route_id: any, route_type: any, source: map{account_revenue_payment: any, account_transfer_intention: any, ach_transfer_intention: any, ach_transfer_rejection: any, ach_transfer_return: any, blockchain_offramp_transfer_settlement: any, blockchain_onramp_transfer_intention: any, card_dispute_acceptance: any, card_dispute_financial: any, card_dispute_loss: any, card_financial: any, card_push_transfer_acceptance: any, card_refund: any, card_revenue_payment: any, card_settlement: any, cashback_payment: any, category: str, check_deposit_acceptance: any, check_deposit_return: any, check_transfer_deposit: any, fednow_transfer_acknowledgement: any, fee_payment: any, inbound_ach_transfer: any, inbound_ach_transfer_return_intention: any, inbound_check_adjustment: any, inbound_check_deposit_return_intention: any, inbound_fednow_transfer_confirmation: any, inbound_real_time_payments_transfer_confirmation: any, inbound_wire_reversal: any, inbound_wire_transfer: any, inbound_wire_transfer_reversal: any, interest_payment: any, internal_source: any, other: any, real_time_payments_transfer_acknowledgement: any, sample_funds: any, swift_transfer_intention: any, swift_transfer_return: any, wire_transfer_intention: any}, type: str} # Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/pending_transactions/{pending_transaction_id}/release_inbound_funds_hold\n@desc Sandbox: Release an Inbound Funds Hold\n@required {pending_transaction_id: str}\n@returns(200) {account_id: str, amount: int, completed_at: any, created_at: str(date-time), currency: str, description: str, held_amount: int, id: str, route_id: any, route_type: any, source: map{account_transfer_instruction: any, ach_transfer_instruction: any, blockchain_offramp_transfer_instruction: any, blockchain_onramp_transfer_instruction: any, card_authorization: any, card_push_transfer_instruction: any, category: str, check_deposit_instruction: any, check_transfer_instruction: any, fednow_transfer_instruction: any, inbound_funds_hold: any, inbound_wire_transfer_reversal: any, other: any, real_time_payments_transfer_instruction: any, swift_transfer_instruction: any, user_initiated_hold: any, wire_transfer_instruction: any}, status: str, type: str} # Pending Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/physical_cards/{physical_card_id}/advance_shipment\n@desc Sandbox: Advance the shipment status of a Physical Card\n@required {physical_card_id: str, shipment_status: str(pending/canceled/submitted/acknowledged/rejected/shipped/returned/requires_attention) # The shipment status to move the Physical Card to.}\n@returns(200) {card_id: str, cardholder: map{first_name: str, last_name: str}, created_at: str(date-time), id: str, idempotency_key: any, physical_card_profile_id: any, shipment: map{address: map{city: str, country: str, line1: str, line2: any, line3: any, name: str, postal_code: str, state: str}, method: str, schedule: str, status: str, tracking: any}, status: str, type: str} # Physical Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/physical_cards/{physical_card_id}/tracking_updates\n@desc Sandbox: Create a Physical Card Shipment Tracking Update\n@required {physical_card_id: str, category: str(in_transit/processed_for_delivery/delivered/delivery_issue/returned_to_sender) # The type of tracking event.}\n@optional {carrier_estimated_delivery_at: str(date-time) # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered., city: str # The city where the event took place., postal_code: str # The postal code where the event took place., state: str # The state where the event took place.}\n@returns(200) {card_id: str, cardholder: map{first_name: str, last_name: str}, created_at: str(date-time), id: str, idempotency_key: any, physical_card_profile_id: any, shipment: map{address: map{city: str, country: str, line1: str, line2: any, line3: any, name: str, postal_code: str, state: str}, method: str, schedule: str, status: str, tracking: any}, status: str, type: str} # Physical Card\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/programs\n@desc Sandbox: Create a Program\n@required {name: str # The name of the program being added.}\n@optional {bank: str(core_bank/first_internet_bank/grasshopper_bank/twin_city_bank) # The bank for the program's accounts, defaults to First Internet Bank., lending_maximum_extendable_credit: int # The maximum extendable credit of the program being added., reserve_account_id: str # The identifier of the Account the Program should be added to is for.}\n@returns(200) {bank: str, billing_account_id: any, created_at: str(date-time), default_digital_card_profile_id: any, id: str, interest_rate: str, lending: any, name: str, type: str, updated_at: str(date-time)} # Program\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete\n@desc Sandbox: Complete a Real-Time Payments Transfer\n@required {real_time_payments_transfer_id: str}\n@optional {rejection: map{reject_reason_code!: str} # If set, the simulation will reject the transfer.}\n@returns(200) {account_id: str, account_number: str, acknowledgement: any, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor_name: str, currency: str, debtor_name: any, external_account_id: any, id: str, idempotency_key: any, pending_transaction_id: any, rejection: any, routing_number: str, source_account_number_id: str, status: str, submission: any, transaction_id: any, type: str, ultimate_creditor_name: any, ultimate_debtor_name: any, unstructured_remittance_information: str} # Real-Time Payments Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse\n@desc Sandbox: Refuse a Wire Drawdown Request\n@required {wire_drawdown_request_id: str}\n@returns(200) {account_number_id: str, amount: int, created_at: str(date-time), creditor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, currency: str, debtor_account_number: str, debtor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_external_account_id: any, debtor_name: str, debtor_routing_number: str, fulfillment_inbound_wire_transfer_id: any, id: str, idempotency_key: any, status: str, submission: any, type: str, unstructured_remittance_information: str} # Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit\n@desc Sandbox: Submit a Wire Drawdown Request\n@required {wire_drawdown_request_id: str}\n@returns(200) {account_number_id: str, amount: int, created_at: str(date-time), creditor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, currency: str, debtor_account_number: str, debtor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_external_account_id: any, debtor_name: str, debtor_routing_number: str, fulfillment_inbound_wire_transfer_id: any, id: str, idempotency_key: any, status: str, submission: any, type: str, unstructured_remittance_information: str} # Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/wire_transfers/{wire_transfer_id}/reverse\n@desc Sandbox: Reverse a Wire Transfer\n@required {wire_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /simulations/wire_transfers/{wire_transfer_id}/submit\n@desc Sandbox: Submit a Wire Transfer\n@required {wire_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group swift_transfers\n@endpoint GET /swift_transfers\n@desc List Swift Transfers\n@optional {cursor: str, limit: int, account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Swift Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /swift_transfers\n@desc Create a Swift Transfer\n@required {account_id: str # The identifier for the account that will send the transfer., account_number: str # The creditor's account number., bank_identification_code: str # The bank identification code (BIC) of the creditor. If it ends with the three-character branch code, this must be 11 characters long. Otherwise this must be 8 characters and the branch code will be assumed to be `XXX`., creditor_address: map{city!: str, country!: str, line1!: str, line2: str, postal_code: str, state: str} # The creditor's address., creditor_name: str # The creditor's name., debtor_address: map{city!: str, country!: str, line1!: str, line2: str, postal_code: str, state: str} # The debtor's address., debtor_name: str # The debtor's name., instructed_amount: int # The amount, in minor units of `instructed_currency`, to send to the creditor., instructed_currency: str # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the instructed amount., source_account_number_id: str # The Account Number to include in the transfer as the debtor's account number., unstructured_remittance_information: str # Unstructured remittance information to include in the transfer.}\n@optional {require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., routing_number: str # The creditor's bank account routing or transit number. Required in certain countries.}\n@returns(200) {account_id: str, account_number: str, amount: int, bank_identification_code: str, created_at: str(date-time), created_by: map{api_key: any, category: str, oauth_application: any, user: any}, creditor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, debtor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_name: str, id: str, idempotency_key: any, instructed_amount: int, instructed_currency: str, pending_transaction_id: any, routing_number: any, source_account_number_id: str, status: str, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # Swift Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /swift_transfers/{swift_transfer_id}\n@desc Retrieve a Swift Transfer\n@required {swift_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, bank_identification_code: str, created_at: str(date-time), created_by: map{api_key: any, category: str, oauth_application: any, user: any}, creditor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, debtor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_name: str, id: str, idempotency_key: any, instructed_amount: int, instructed_currency: str, pending_transaction_id: any, routing_number: any, source_account_number_id: str, status: str, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # Swift Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /swift_transfers/{swift_transfer_id}/approve\n@desc Approve a Swift Transfer\n@required {swift_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, bank_identification_code: str, created_at: str(date-time), created_by: map{api_key: any, category: str, oauth_application: any, user: any}, creditor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, debtor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_name: str, id: str, idempotency_key: any, instructed_amount: int, instructed_currency: str, pending_transaction_id: any, routing_number: any, source_account_number_id: str, status: str, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # Swift Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /swift_transfers/{swift_transfer_id}/cancel\n@desc Cancel a pending Swift Transfer\n@required {swift_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, bank_identification_code: str, created_at: str(date-time), created_by: map{api_key: any, category: str, oauth_application: any, user: any}, creditor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, debtor_address: map{city: any, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_name: str, id: str, idempotency_key: any, instructed_amount: int, instructed_currency: str, pending_transaction_id: any, routing_number: any, source_account_number_id: str, status: str, transaction_id: any, type: str, unique_end_to_end_transaction_reference: str, unstructured_remittance_information: str} # Swift Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group transactions\n@endpoint GET /transactions\n@desc List Transactions\n@optional {cursor: str, limit: int, account_id: str, created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time), category.in: [str], route_id: str}\n@returns(200) {data: [map], next_cursor: any} # Transaction List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /transactions/{transaction_id}\n@desc Retrieve a Transaction\n@required {transaction_id: str}\n@returns(200) {account_id: str, amount: int, created_at: str(date-time), currency: str, description: str, id: str, route_id: any, route_type: any, source: map{account_revenue_payment: any, account_transfer_intention: any, ach_transfer_intention: any, ach_transfer_rejection: any, ach_transfer_return: any, blockchain_offramp_transfer_settlement: any, blockchain_onramp_transfer_intention: any, card_dispute_acceptance: any, card_dispute_financial: any, card_dispute_loss: any, card_financial: any, card_push_transfer_acceptance: any, card_refund: any, card_revenue_payment: any, card_settlement: any, cashback_payment: any, category: str, check_deposit_acceptance: any, check_deposit_return: any, check_transfer_deposit: any, fednow_transfer_acknowledgement: any, fee_payment: any, inbound_ach_transfer: any, inbound_ach_transfer_return_intention: any, inbound_check_adjustment: any, inbound_check_deposit_return_intention: any, inbound_fednow_transfer_confirmation: any, inbound_real_time_payments_transfer_confirmation: any, inbound_wire_reversal: any, inbound_wire_transfer: any, inbound_wire_transfer_reversal: any, interest_payment: any, internal_source: any, other: any, real_time_payments_transfer_acknowledgement: any, sample_funds: any, swift_transfer_intention: any, swift_transfer_return: any, wire_transfer_intention: any}, type: str} # Transaction\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group wire_drawdown_requests\n@endpoint GET /wire_drawdown_requests\n@desc List Wire Drawdown Requests\n@optional {cursor: str, limit: int, status.in: [str], idempotency_key: str}\n@returns(200) {data: [map], next_cursor: any} # Wire Drawdown Request List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /wire_drawdown_requests\n@desc Create a Wire Drawdown Request\n@required {account_number_id: str # The Account Number to which the debtor should send funds., amount: int # The amount requested from the debtor, in USD cents., creditor_address: map{city!: str, country!: str, line1!: str, line2: str, postal_code: str, state: str} # The creditor's address., creditor_name: str # The creditor's name., debtor_address: map{city!: str, country!: str, line1!: str, line2: str, postal_code: str, state: str} # The debtor's address., debtor_name: str # The debtor's name., unstructured_remittance_information: str # Remittance information the debtor will see as part of the request.}\n@optional {charge_bearer: str(shared/debtor/creditor/service_level) # Determines who bears the cost of the drawdown request. Defaults to `shared` if not specified., debtor_account_number: str # The debtor's account number., debtor_external_account_id: str # The ID of an External Account to initiate a transfer to. If this parameter is provided, `debtor_account_number` and `debtor_routing_number` must be absent., debtor_routing_number: str # The debtor's routing number., end_to_end_identification: str # A free-form reference string set by the sender mirrored back in the subsequent wire transfer.}\n@returns(200) {account_number_id: str, amount: int, created_at: str(date-time), creditor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, currency: str, debtor_account_number: str, debtor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_external_account_id: any, debtor_name: str, debtor_routing_number: str, fulfillment_inbound_wire_transfer_id: any, id: str, idempotency_key: any, status: str, submission: any, type: str, unstructured_remittance_information: str} # Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /wire_drawdown_requests/{wire_drawdown_request_id}\n@desc Retrieve a Wire Drawdown Request\n@required {wire_drawdown_request_id: str}\n@returns(200) {account_number_id: str, amount: int, created_at: str(date-time), creditor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, creditor_name: str, currency: str, debtor_account_number: str, debtor_address: map{city: str, country: str, line1: str, line2: any, postal_code: any, state: any}, debtor_external_account_id: any, debtor_name: str, debtor_routing_number: str, fulfillment_inbound_wire_transfer_id: any, id: str, idempotency_key: any, status: str, submission: any, type: str, unstructured_remittance_information: str} # Wire Drawdown Request\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@group wire_transfers\n@endpoint GET /wire_transfers\n@desc List Wire Transfers\n@optional {cursor: str, limit: int, account_id: str, external_account_id: str, idempotency_key: str, status.in: [str], created_at.after: str(date-time), created_at.before: str(date-time), created_at.on_or_after: str(date-time), created_at.on_or_before: str(date-time)}\n@returns(200) {data: [map], next_cursor: any} # Wire Transfer List\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /wire_transfers\n@desc Create a Wire Transfer\n@required {account_id: str # The identifier for the account that will send the transfer., amount: int # The transfer amount in USD cents., creditor: map{address: map, name!: str} # The person or business that is receiving the funds from the transfer., remittance: map{category!: str, tax: map, unstructured: map} # Additional remittance information related to the wire transfer.}\n@optional {account_number: str # The account number for the destination account., debtor: map{address: map, name!: str} # The person or business whose funds are being transferred. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details., external_account_id: str # The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent., inbound_wire_drawdown_request_id: str # The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent., require_approval: bool # Whether the transfer requires explicit approval via the dashboard or API., routing_number: str # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account., source_account_number_id: str # The ID of an Account Number that will be passed to the wire's recipient}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint GET /wire_transfers/{wire_transfer_id}\n@desc Retrieve a Wire Transfer\n@required {wire_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /wire_transfers/{wire_transfer_id}/approve\n@desc Approve a Wire Transfer\n@required {wire_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endpoint POST /wire_transfers/{wire_transfer_id}/cancel\n@desc Cancel a pending Wire Transfer\n@required {wire_transfer_id: str}\n@returns(200) {account_id: str, account_number: str, amount: int, approval: any, cancellation: any, created_at: str(date-time), created_by: any, creditor: any, currency: str, debtor: any, external_account_id: any, id: str, idempotency_key: any, inbound_wire_drawdown_request_id: any, network: str, pending_transaction_id: any, remittance: any, reversal: any, routing_number: str, source_account_number_id: any, status: str, submission: any, transaction_id: any, type: str} # Wire Transfer\n@errors {4XX: Error, 5XX: Error}\n\n@endgroup\n\n@end\n"}