> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Spend Control > Create a spend control ## OpenAPI ````yaml openapi-v1.json post /spend_controls openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 1.181.0 servers: - description: Production url: https://api.synctera.com/v1 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v1 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage spending controls name: Spend Controls (beta) - description: Rates name: Rates - description: Requests to create and manage webhooks name: Webhooks - description: Tenant Config name: Tenant Config - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Lending Config name: Lending Config - description: Payments related to lending accounts name: Payments - description: Manage negative balance processes name: Negative Balance - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Create and manage transactions name: Transactions (beta) - description: Autopay payment records for billing periods name: Autopays - description: Create and manage accounts name: Accounts - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Requests to create and manage card disputes name: Card Disputes - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Bulk card issuance name: Bulk Issuance - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Request to create and manage exclusions name: Statements - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) paths: /spend_controls: post: tags: - Spend Controls (beta) summary: Create Spend Control description: | Create a spend control operationId: createSpendControl requestBody: content: application/json: schema: $ref: '#/components/schemas/spend_control_creation_request' description: Details of the spend control to create required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/spend_control_response' description: Spend control details '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' components: schemas: spend_control_creation_request: allOf: - type: object - $ref: '#/components/schemas/spend_control' required: - action_case - action_decline - is_active - name - time_range spend_control_response: allOf: - properties: number_of_related_accounts: description: A count of how many accounts are using this spend control minimum: 0 type: integer number_of_related_cards: description: A count of how many cards are using this spend control minimum: 0 type: integer number_of_related_customers: description: A count of how many customers are using this spend control minimum: 0 type: integer tenant: $ref: '#/components/schemas/tenant_id' required: - number_of_related_accounts - number_of_related_cards - number_of_related_customers - tenant type: object - $ref: '#/components/schemas/spend_control' required: - action_case - action_decline - creation_time - id - is_active - last_modified_time - name - number_of_related_accounts - time_range spend_control: properties: action_case: description: >- If set, create a case for transactions that do not conform to the spend control type: boolean action_decline: description: >- If set, decline transactions that do not conform to the spend control type: boolean aggregation_level: allOf: - $ref: '#/components/schemas/spend_control_aggregation_level' amount_limit: description: >- Monetary limit for the spend control in the smallest currency unit (eg cents). At least one of amount_limit and transaction_count_limit must be specified. format: int64 minimum: 0 type: integer creation_time: description: The timestamp representing when the spend control was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string description: description: Optional description for the spend control type: string direction: $ref: '#/components/schemas/spend_control_direction' geo_restrictions: $ref: '#/components/schemas/spend_control_geo_restrictions' id: description: Spend Control ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string is_active: description: Indicates if spend control is active example: true type: boolean last_modified_time: description: The timestamp representing when the spend control was last modified example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string managed_by: $ref: '#/components/schemas/managed_by_types' merchant_category_codes: $ref: '#/components/schemas/merchant_category_codes' name: description: Name assigned to spend control type: string payment_sub_types: $ref: '#/components/schemas/payment_sub_type_list' payment_subtype_map: allOf: - $ref: '#/components/schemas/payment_subtype_map' description: > Not returned by the API. Anchors `components.schemas.payment_subtype_map` in the merged OpenAPI document for documentation and code generation. readOnly: true payment_types: $ref: '#/components/schemas/payment_type_list' scope: allOf: - $ref: '#/components/schemas/spend_control_scope' time_range: $ref: '#/components/schemas/spend_control_time_range' transaction_count_limit: description: >- Number of transactions allowed by the spend control, regardless of transaction amounts. At least one of amount_limit and transaction_count_limit must be specified. format: int64 minimum: 0 type: integer required: - action_case - action_decline - direction - is_active - name - time_range title: Spend Control type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string error: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object spend_control_aggregation_level: description: > Controls how spend is measured for enforcement: * `ACCOUNT` - Per-account: each account's spend is checked independently (default) * `CUSTOMER` - Per-customer: spend is aggregated across all accounts owned by the customer * `CARDS` - Per-card: spend is aggregated per specific card enum: - ACCOUNT - CARDS - CUSTOMER type: string spend_control_direction: description: > The direction of funds flow to which a spend control applies. To limit the rate of funds flowing out of an account, use DEBITS. To limit the rate of funds flowing in to an account, use CREDITS. Use ANY to apply the spend control to both debits and credits. If this is not set, the spend control applies to debits (ie spending) only. enum: - ANY - CREDITS - DEBITS type: string spend_control_geo_restrictions: description: Geographic restrictions for spend controls properties: countries: description: ISO 3166-1 alpha-2 country codes to block or allow example: - CA - GB - US items: pattern: ^[A-Z]{2}$ type: string minItems: 1 type: array uniqueItems: true country_sources: description: Which country attributes on the transaction to evaluate example: - COUNTER_PARTY items: $ref: '#/components/schemas/country_source' minItems: 1 type: array mode: $ref: '#/components/schemas/geo_restriction_mode' required: - countries - mode type: object managed_by_types: description: The type of resource manager enum: - BANK - FINTECH - PLATFORM type: string merchant_category_codes: description: merchant category codes for spend control items: description: specify a specific MCC or a range of MCCs using a dash (-) example: 5600–5699 pattern: ^\d{4}(-\d{4})?$ type: string maxItems: 10 type: array payment_sub_type_list: description: >- A list of payment sub-types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all sub-types. Values must use "PAYMENT_TYPE.SUBTYPE" dot notation (e.g. "CARD.ATM_WITHDRAWAL", "ACH.INCOMING_CREDIT"). If payment_types is also set, every entry here must belong to one of those payment types or a 422 AMBIGUOUS_PAYMENT_SUBTYPES error will be returned. See payment_subtype_map for the full list of valid values grouped by payment type. items: $ref: '#/components/schemas/spend_control_payment_subtype' type: array payment_subtype_map: description: >- A read-only reference object describing which payment sub-types are valid for each payment type, using the exact "PAYMENT_TYPE.SUBTYPE" dot-notation format required by payment_sub_type_list. Use this to build type-aware UI (e.g. once a user selects CARD in payment_types, offer only the CARD.* values from this map). properties: ACH: items: $ref: '#/components/schemas/ach_spend_control_subtype' type: array CARD: items: $ref: '#/components/schemas/card_spend_control_subtype' type: array CASH: items: $ref: '#/components/schemas/cash_spend_control_subtype' type: array CHECK: items: $ref: '#/components/schemas/check_spend_control_subtype' type: array EFT_CA: items: $ref: '#/components/schemas/eft_ca_spend_control_subtype' type: array EXTERNAL_CARD: items: $ref: '#/components/schemas/external_card_spend_control_subtype' type: array FEDNOW: items: $ref: '#/components/schemas/fednow_spend_control_subtype' type: array INTERNAL_TRANSFER: items: $ref: '#/components/schemas/internal_transfer_spend_control_subtype' type: array SYNCTERA_PAY: items: $ref: '#/components/schemas/synctera_pay_spend_control_subtype' type: array WIRE: items: $ref: '#/components/schemas/wire_spend_control_subtype' type: array readOnly: true type: object payment_type_list: description: >- A list of payment types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all types of payments. items: $ref: '#/components/schemas/payment_type' type: array spend_control_scope: default: ACCOUNT description: > The scope determines which accounts this spend control applies to: * `ACCOUNT` - Applies only to accounts explicitly linked via account mappings (default) * `CUSTOMER` - Applies only to customers explicitly linked via customer mappings * `CARDS` - Applies only to cards explicitly linked via card mappings * `FINTECH` - Automatically applies to all accounts under the fintech tenant * `BANK` - Automatically applies to all accounts under the bank tenant enum: - ACCOUNT - BANK - CARDS - CUSTOMER - FINTECH type: string spend_control_time_range: description: The time range to which the spend control applies discriminator: mapping: FOREVER: $ref: '#/components/schemas/spend_control_forever' ROLLING_WINDOW: $ref: '#/components/schemas/spend_control_rolling_window' ROLLING_WINDOW_DAYS: $ref: '#/components/schemas/spend_control_rolling_window_days' SINGLE_TRANSACTION: $ref: '#/components/schemas/spend_control_single_transaction' STATIC_WINDOW: $ref: '#/components/schemas/spend_control_static_window' propertyName: time_range_type oneOf: - $ref: '#/components/schemas/spend_control_forever' - $ref: '#/components/schemas/spend_control_rolling_window' - $ref: '#/components/schemas/spend_control_single_transaction' - $ref: '#/components/schemas/spend_control_static_window' - $ref: '#/components/schemas/spend_control_rolling_window_days' type: object country_source: description: > Which country attribute on the transaction to evaluate: * `ORIGINATOR_BANK` - Country of the originating bank * `ORIGINATOR_PARTY` - Country of the originating party * `COUNTER_PARTY_BANK` - Country of the counter-party's bank * `COUNTER_PARTY` - Country of the counter-party * `TRANSACTION_LOCATION` - Physical location where the transaction occurred (applied to card transactions only) * `ALL` - Evaluate all applicable country sources enum: - ALL - COUNTER_PARTY - COUNTER_PARTY_BANK - ORIGINATOR_BANK - ORIGINATOR_PARTY - TRANSACTION_LOCATION type: string geo_restriction_mode: description: Whether countries are allowed or blocked enum: - ALLOW_LIST - BLOCK_LIST type: string spend_control_payment_subtype: anyOf: - $ref: '#/components/schemas/wire_spend_control_subtype' - $ref: '#/components/schemas/card_spend_control_subtype' - $ref: '#/components/schemas/internal_transfer_spend_control_subtype' - $ref: '#/components/schemas/external_card_spend_control_subtype' - $ref: '#/components/schemas/cash_spend_control_subtype' - $ref: '#/components/schemas/fednow_spend_control_subtype' - $ref: '#/components/schemas/eft_ca_spend_control_subtype' - $ref: '#/components/schemas/synctera_pay_spend_control_subtype' - $ref: '#/components/schemas/ach_spend_control_subtype' - $ref: '#/components/schemas/check_spend_control_subtype' description: >- A valid payment sub-type value for a spend control, expressed in "PAYMENT_TYPE.SUBTYPE" dot notation. See payment_subtype_map for valid values grouped by payment type. ach_spend_control_subtype: description: >- Valid ACH payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - ACH.INCOMING_CREDIT - ACH.INCOMING_CREDIT_CONTESTED_RETURN - ACH.INCOMING_CREDIT_CONTESTED_RETURN_REVERSAL - ACH.INCOMING_CREDIT_DISHONORED_RETURN - ACH.INCOMING_CREDIT_DISHONORED_RETURN_REVERSAL - ACH.INCOMING_CREDIT_RETURN - ACH.INCOMING_CREDIT_RETURN_REVERSAL - ACH.INCOMING_CREDIT_REVERSAL - ACH.INCOMING_DEBIT - ACH.INCOMING_DEBIT_CONTESTED_RETURN - ACH.INCOMING_DEBIT_CONTESTED_RETURN_REVERSAL - ACH.INCOMING_DEBIT_DISHONORED_RETURN - ACH.INCOMING_DEBIT_DISHONORED_RETURN_REVERSAL - ACH.INCOMING_DEBIT_RETURN - ACH.INCOMING_DEBIT_RETURN_REVERSAL - ACH.INCOMING_DEBIT_REVERSAL - ACH.OUTGOING_CREDIT - ACH.OUTGOING_CREDIT_CONTESTED_RETURN - ACH.OUTGOING_CREDIT_DISHONORED_RETURN - ACH.OUTGOING_CREDIT_RETURN - ACH.OUTGOING_CREDIT_REVERSAL - ACH.OUTGOING_DEBIT - ACH.OUTGOING_DEBIT_CONTESTED_RETURN - ACH.OUTGOING_DEBIT_DISHONORED_RETURN - ACH.OUTGOING_DEBIT_RETURN - ACH.OUTGOING_DEBIT_REVERSAL - ACH.PRENOTE - ACH.PRENOTE_REVERSAL - ACH.TEMP_HOLD type: string card_spend_control_subtype: description: >- Valid CARD payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - CARD.ATM_WITHDRAWAL - CARD.ATM_WITHDRAWAL_REVERSAL - CARD.BALANCE_INQUIRY - CARD.CARD_CHARGEBACK_CASE1 - CARD.CARD_CHARGEBACK_CASE2 - CARD.CARD_CHARGEBACK_CASE3 - CARD.CARD_NETWORK_FINAL_CHARGEBACK - CARD.CARD_NETWORK_FINAL_CHARGEBACK_REVERSAL - CARD.CARD_NETWORK_FIRST_CHARGEBACK - CARD.CARD_NETWORK_FIRST_CHARGEBACK_REVERSAL - CARD.CARD_NETWORK_REPRESENTMENT - CARD.CARD_NETWORK_REPRESENTMENT_REVERSAL - CARD.CARD_TRANSACTION - CARD.CARD_TRANSACTION_REVERSAL - CARD.CHARGEBACK - CARD.CHARGEBACK_REVERSAL - CARD.CREDIT - CARD.CREDIT_REVERSAL - CARD.DIRECTPOST - CARD.DIRECTPOST_REVERSAL - CARD.HOLD - CARD.HOLD_DECREASE - CARD.HOLD_INCREASE - CARD.HOLD_POST - CARD.HOLD_POST_REVERSAL - CARD.HOLD_REPLACE - CARD.POS_CASHBACK - CARD.POS_CASHBACK_REVERSAL - CARD.POS_PURCHASE - CARD.POS_PURCHASE_REFUND - CARD.POS_PURCHASE_REFUND_REVERSAL - CARD.POS_PURCHASE_REVERSAL - CARD.POS_REFUND - CARD.POS_REFUND_REVERSAL - CARD.PROVISIONAL_CREDIT - CARD.PROVISIONAL_CREDIT_REVERSAL type: string cash_spend_control_subtype: description: >- Valid CASH payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - CASH.CASH_ORDER - CASH.CASH_ORDER_REVERSAL - CASH.DEPOSIT - CASH.DEPOSIT_REVERSAL - CASH.IN_STORE_DEPOSIT - CASH.IN_STORE_DEPOSIT_REVERSAL - CASH.TEMP_HOLD type: string check_spend_control_subtype: description: >- Valid CHECK payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - CHECK.MOBILE_DEPOSIT - CHECK.MOBILE_DEPOSIT_RETURN - CHECK.MOBILE_DEPOSIT_RETURN_REVERSAL - CHECK.MOBILE_DEPOSIT_REVERSAL - CHECK.TEMP_HOLD type: string eft_ca_spend_control_subtype: description: >- Valid EFT_CA payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - EFT_CA.BULK_OUTGOING_CREDIT - EFT_CA.BULK_OUTGOING_CREDIT_RETURN - EFT_CA.BULK_OUTGOING_CREDIT_RETURN_REVERSAL - EFT_CA.BULK_OUTGOING_CREDIT_REVERSAL - EFT_CA.BULK_OUTGOING_DEBIT - EFT_CA.BULK_OUTGOING_DEBIT_RETURN - EFT_CA.BULK_OUTGOING_DEBIT_RETURN_REVERSAL - EFT_CA.BULK_OUTGOING_DEBIT_REVERSAL - EFT_CA.INCOMING_CREDIT - EFT_CA.INCOMING_CREDIT_RETURN - EFT_CA.INCOMING_CREDIT_RETURN_REVERSAL - EFT_CA.INCOMING_CREDIT_REVERSAL - EFT_CA.INCOMING_DEBIT - EFT_CA.INCOMING_DEBIT_RETURN - EFT_CA.INCOMING_DEBIT_RETURN_REVERSAL - EFT_CA.INCOMING_DEBIT_REVERSAL - EFT_CA.OUTGOING_CREDIT - EFT_CA.OUTGOING_CREDIT_RETURN - EFT_CA.OUTGOING_CREDIT_RETURN_REVERSAL - EFT_CA.OUTGOING_CREDIT_REVERSAL - EFT_CA.OUTGOING_DEBIT - EFT_CA.OUTGOING_DEBIT_RETURN - EFT_CA.OUTGOING_DEBIT_RETURN_REVERSAL - EFT_CA.OUTGOING_DEBIT_REVERSAL type: string external_card_spend_control_subtype: description: >- Valid EXTERNAL_CARD payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - EXTERNAL_CARD.CARD_FUNDING - EXTERNAL_CARD.CARD_FUNDING_REVERSAL - EXTERNAL_CARD.CARD_SEND - EXTERNAL_CARD.CARD_SEND_REVERSAL - EXTERNAL_CARD.CHARGEBACK_DEBIT - EXTERNAL_CARD.CHARGEBACK_DEBIT_REVERSAL type: string fednow_spend_control_subtype: description: >- Valid FEDNOW payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - FEDNOW.FEDNOW_INCOMING - FEDNOW.FEDNOW_OUTGOING type: string internal_transfer_spend_control_subtype: description: >- Valid INTERNAL_TRANSFER payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - INTERNAL_TRANSFER.ACCOUNT_BALANCE_ADJUSTMENT - INTERNAL_TRANSFER.ACCOUNT_BALANCE_ADJUSTMENT_REVERSAL - INTERNAL_TRANSFER.ACCOUNT_DECREASE_LIMIT - INTERNAL_TRANSFER.ACCOUNT_DECREASE_LIMIT_REVERSAL - INTERNAL_TRANSFER.ACCOUNT_INCREASE_LIMIT - INTERNAL_TRANSFER.ACCOUNT_INCREASE_LIMIT_REVERSAL - INTERNAL_TRANSFER.ACCOUNT_TO_ACCOUNT - INTERNAL_TRANSFER.ACCOUNT_TO_ACCOUNT_REVERSAL - INTERNAL_TRANSFER.ACCOUNT_TO_ACCOUNT_SWEEP - INTERNAL_TRANSFER.ACCOUNT_TO_ACCOUNT_SWEEP_REVERSAL - INTERNAL_TRANSFER.ACH_CREDIT_SWEEP - INTERNAL_TRANSFER.ACH_CREDIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.ACH_DEBIT_SWEEP - INTERNAL_TRANSFER.ACH_DEBIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.ACH_FLOAT_TRANSFER - INTERNAL_TRANSFER.ACH_FLOAT_TRANSFER_REVERSAL - INTERNAL_TRANSFER.ACH_INCOMING_CREDIT_SWEEP - INTERNAL_TRANSFER.ACH_INCOMING_DEBIT_SWEEP - INTERNAL_TRANSFER.ACH_INCOMING_RETURN_CREDIT_SWEEP - INTERNAL_TRANSFER.ACH_INCOMING_RETURN_DEBIT_SWEEP - INTERNAL_TRANSFER.ACH_OUTGOING_CREDIT_SWEEP - INTERNAL_TRANSFER.ACH_OUTGOING_DEBIT_SWEEP - INTERNAL_TRANSFER.ACH_OUTGOING_RETURN_CREDIT_SWEEP - INTERNAL_TRANSFER.ACH_OUTGOING_RETURN_DEBIT_SWEEP - INTERNAL_TRANSFER.ACH_SWEEP - INTERNAL_TRANSFER.ACH_SWEEP_REVERSAL - INTERNAL_TRANSFER.BULK_DOMESTIC_WIRE_OUTGOING_SWEEP - INTERNAL_TRANSFER.BULK_DOMESTIC_WIRE_OUTGOING_SWEEP_REVERSAL - INTERNAL_TRANSFER.BULK_EFT_CA_OUTGOING_CREDIT_SWEEP - INTERNAL_TRANSFER.BULK_EFT_CA_OUTGOING_CREDIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.BULK_EFT_CA_OUTGOING_DEBIT_SWEEP - INTERNAL_TRANSFER.BULK_EFT_CA_OUTGOING_DEBIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.CARD_CHARGEBACK - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE1 - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE1_REVERSAL - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE2 - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE2_REVERSAL - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE3 - INTERNAL_TRANSFER.CARD_CHARGEBACK_CASE3_REVERSAL - INTERNAL_TRANSFER.CARD_CHARGEBACK_REVERSAL - INTERNAL_TRANSFER.CARD_CHARGEBACK_WRITEOFF - INTERNAL_TRANSFER.CARD_CHARGEBACK_WRITEOFF_REVERSAL - INTERNAL_TRANSFER.CARD_PROVISIONAL_CREDIT - INTERNAL_TRANSFER.CARD_PROVISIONAL_CREDIT_REVERSAL - INTERNAL_TRANSFER.CASHBACK - INTERNAL_TRANSFER.CASHBACK_REVERSAL - INTERNAL_TRANSFER.CASHBACK_SWEEP - INTERNAL_TRANSFER.CASHBACK_SWEEP_REVERSAL - INTERNAL_TRANSFER.CASH_DEPOSIT_KIOSK - INTERNAL_TRANSFER.CASH_DEPOSIT_KIOSK_REVERSAL - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK_GOV - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK_GOV_REVERSAL - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK_PAYROLL - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL - INTERNAL_TRANSFER.CHECK_DEPOSIT_KIOSK_REVERSAL - INTERNAL_TRANSFER.CHECK_DEPOSIT_MOBILE - INTERNAL_TRANSFER.CHECK_DEPOSIT_MOBILE_REVERSAL - INTERNAL_TRANSFER.CREDIT_MEMO - INTERNAL_TRANSFER.CREDIT_MEMO_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_CASH_PICKUP - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET - INTERNAL_TRANSFER.DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_WIRE_INCOMING_RETURN_SWEEP - INTERNAL_TRANSFER.DOMESTIC_WIRE_INCOMING_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_WIRE_INCOMING_SWEEP - INTERNAL_TRANSFER.DOMESTIC_WIRE_INCOMING_SWEEP_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP - INTERNAL_TRANSFER.DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.DOMESTIC_WIRE_OUTGOING_SWEEP - INTERNAL_TRANSFER.DOMESTIC_WIRE_OUTGOING_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_INCOMING_CREDIT_RETURN_SWEEP - INTERNAL_TRANSFER.EFT_CA_INCOMING_CREDIT_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_INCOMING_CREDIT_SWEEP - INTERNAL_TRANSFER.EFT_CA_INCOMING_CREDIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_INCOMING_DEBIT_RETURN_SWEEP - INTERNAL_TRANSFER.EFT_CA_INCOMING_DEBIT_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_INCOMING_DEBIT_SWEEP - INTERNAL_TRANSFER.EFT_CA_INCOMING_DEBIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP - INTERNAL_TRANSFER.EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_OUTGOING_CREDIT_SWEEP - INTERNAL_TRANSFER.EFT_CA_OUTGOING_CREDIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP - INTERNAL_TRANSFER.EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.EFT_CA_OUTGOING_DEBIT_SWEEP - INTERNAL_TRANSFER.EFT_CA_OUTGOING_DEBIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.ETRANSFER_SWEEP - INTERNAL_TRANSFER.ETRANSFER_SWEEP_REVERSAL - INTERNAL_TRANSFER.EXCHANGE_RATE_DIFFERENCE_GAIN - INTERNAL_TRANSFER.EXCHANGE_RATE_DIFFERENCE_GAIN_REVERSAL - INTERNAL_TRANSFER.EXCHANGE_RATE_DIFFERENCE_LOSS - INTERNAL_TRANSFER.EXCHANGE_RATE_DIFFERENCE_LOSS_REVERSAL - INTERNAL_TRANSFER.FEE - INTERNAL_TRANSFER.FEE_REVERSAL - INTERNAL_TRANSFER.FEE_SWEEP - INTERNAL_TRANSFER.FEE_SWEEP_REVERSAL - INTERNAL_TRANSFER.FORCE_PAYMENT - INTERNAL_TRANSFER.FORCE_PAYMENT_REVERSAL - INTERNAL_TRANSFER.INCOMING_WIRE - INTERNAL_TRANSFER.INCOMING_WIRE_REVERSAL - INTERNAL_TRANSFER.INCOMING_WIRE_SWEEP - INTERNAL_TRANSFER.INCOMING_WIRE_SWEEP_REVERSAL - INTERNAL_TRANSFER.INTEREST_CHARGED - INTERNAL_TRANSFER.INTEREST_CHARGED_REVERSAL - INTERNAL_TRANSFER.INTEREST_CHARGED_SWEEP - INTERNAL_TRANSFER.INTEREST_CHARGED_SWEEP_REVERSAL - INTERNAL_TRANSFER.INTEREST_INCOME - INTERNAL_TRANSFER.INTEREST_INCOME_REVERSAL - INTERNAL_TRANSFER.INTEREST_PAYOUT - INTERNAL_TRANSFER.INTEREST_PAYOUT_REVERSAL - INTERNAL_TRANSFER.INTEREST_PAYOUT_SWEEP - INTERNAL_TRANSFER.INTEREST_PAYOUT_SWEEP_REVERSAL - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_INCOMING_SWEEP - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_INCOMING_SWEEP_REVERSAL - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_OUTGOING_SWEEP - INTERNAL_TRANSFER.INTERNATIONAL_WIRE_OUTGOING_SWEEP_REVERSAL - INTERNAL_TRANSFER.INVOICE - INTERNAL_TRANSFER.INVOICE_REVERSAL - INTERNAL_TRANSFER.JIT_FUND - INTERNAL_TRANSFER.JIT_FUND_REVERSAL - INTERNAL_TRANSFER.LOAN_DISBURSEMENT - INTERNAL_TRANSFER.LOAN_DISBURSEMENT_REVERSAL - INTERNAL_TRANSFER.LOAN_FUNDING - INTERNAL_TRANSFER.LOAN_FUNDING_REVERSAL - INTERNAL_TRANSFER.LOC_USAGE - INTERNAL_TRANSFER.LOC_USAGE_REVERSAL - INTERNAL_TRANSFER.MANUAL_ADJUSTMENT - INTERNAL_TRANSFER.MANUAL_ADJUSTMENT_REVERSAL - INTERNAL_TRANSFER.MANUAL_ADJUSTMENT_SWEEP - INTERNAL_TRANSFER.MANUAL_ADJUSTMENT_SWEEP_REVERSAL - INTERNAL_TRANSFER.MANUAL_AFT_SWEEP - INTERNAL_TRANSFER.MANUAL_CARD_SWEEP - INTERNAL_TRANSFER.MANUAL_CARD_SWEEP_REVERSAL - INTERNAL_TRANSFER.MANUAL_CASH_DEPOSIT_SWEEP - INTERNAL_TRANSFER.MANUAL_CHECK_SWEEP - INTERNAL_TRANSFER.MANUAL_CHECK_SWEEP_REVERSAL - INTERNAL_TRANSFER.MANUAL_OCT_SWEEP - INTERNAL_TRANSFER.MANUAL_WIRE_SWEEP - INTERNAL_TRANSFER.MANUAL_WIRE_SWEEP_REVERSAL - INTERNAL_TRANSFER.MARKETPLACE_GIFT_CARD - INTERNAL_TRANSFER.MARKETPLACE_GIFT_CARD_REVERSAL - INTERNAL_TRANSFER.MASTERCARD_GROSS_SWEEP - INTERNAL_TRANSFER.MASTERCARD_GROSS_SWEEP_REVERSAL - INTERNAL_TRANSFER.MASTERCARD_INTERCHANGE_SWEEP - INTERNAL_TRANSFER.MASTERCARD_INTERCHANGE_SWEEP_REVERSAL - INTERNAL_TRANSFER.MASTERCARD_NET_SWEEP - INTERNAL_TRANSFER.MASTERCARD_NET_SWEEP_REVERSAL - INTERNAL_TRANSFER.MOBILE_DEPOSIT_RETURN_SWEEP - INTERNAL_TRANSFER.MOBILE_DEPOSIT_RETURN_SWEEP_REVERSAL - INTERNAL_TRANSFER.MOBILE_DEPOSIT_SWEEP - INTERNAL_TRANSFER.MOBILE_DEPOSIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.NETWORK_ADJUSTMENT_SWEEP - INTERNAL_TRANSFER.NETWORK_ADJUSTMENT_SWEEP_REVERSAL - INTERNAL_TRANSFER.NETWORK_CHARGEBACK_SWEEP - INTERNAL_TRANSFER.NETWORK_CHARGEBACK_SWEEP_REVERSAL - INTERNAL_TRANSFER.OUTGOING_INTERNATIONAL_REMITTANCE - INTERNAL_TRANSFER.OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL - INTERNAL_TRANSFER.PEER_TO_PEER - INTERNAL_TRANSFER.PROGRAM_DECREASE - INTERNAL_TRANSFER.PROGRAM_DECREASE_REVERSAL - INTERNAL_TRANSFER.PROGRAM_EXPANSION - INTERNAL_TRANSFER.PROGRAM_EXPANSION_REVERSAL - INTERNAL_TRANSFER.PROMOTIONAL_CREDIT - INTERNAL_TRANSFER.PROMOTIONAL_CREDIT_REVERSAL - INTERNAL_TRANSFER.PROMOTIONAL_CREDIT_SWEEP - INTERNAL_TRANSFER.PROMOTIONAL_CREDIT_SWEEP_REVERSAL - INTERNAL_TRANSFER.PULSE_GROSS_SWEEP - INTERNAL_TRANSFER.PULSE_GROSS_SWEEP_REVERSAL - INTERNAL_TRANSFER.PULSE_INTERCHANGE_SWEEP - INTERNAL_TRANSFER.PULSE_INTERCHANGE_SWEEP_REVERSAL - INTERNAL_TRANSFER.REPAYMENT - INTERNAL_TRANSFER.REPAYMENT_REVERSAL - INTERNAL_TRANSFER.SECURITY_ACCOUNT_PAYMENT - INTERNAL_TRANSFER.SECURITY_ACCOUNT_PAYMENT_REVERSAL - INTERNAL_TRANSFER.SECURITY_HOLD - INTERNAL_TRANSFER.SIGN_UP_BONUS - INTERNAL_TRANSFER.SIGN_UP_BONUS_REVERSAL - INTERNAL_TRANSFER.SUBSCRIPTION_FEE - INTERNAL_TRANSFER.SUBSCRIPTION_FEE_REVERSAL - INTERNAL_TRANSFER.TRANSFER_FEE - INTERNAL_TRANSFER.TRANSFER_FEE_REVERSAL - INTERNAL_TRANSFER.TRANSFER_FEE_REVERSAL_REVERSAL - INTERNAL_TRANSFER.VISA_GROSS_SWEEP - INTERNAL_TRANSFER.VISA_GROSS_SWEEP_REVERSAL - INTERNAL_TRANSFER.VISA_INTERCHANGE_SWEEP - INTERNAL_TRANSFER.VISA_INTERCHANGE_SWEEP_REVERSAL - INTERNAL_TRANSFER.VISA_NET_SWEEP - INTERNAL_TRANSFER.VISA_NET_SWEEP_REVERSAL - INTERNAL_TRANSFER.WIRE_SETTLEMENT_CREDIT - INTERNAL_TRANSFER.WIRE_SETTLEMENT_CREDIT_REVERSAL - INTERNAL_TRANSFER.WIRE_SETTLEMENT_DEBIT - INTERNAL_TRANSFER.WIRE_SETTLEMENT_DEBIT_REVERSAL type: string synctera_pay_spend_control_subtype: description: >- Valid SYNCTERA_PAY payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - SYNCTERA_PAY.INCOMING_INTERAC_AUTODEPOSIT - SYNCTERA_PAY.INCOMING_INTERAC_AUTODEPOSIT_RETURN - SYNCTERA_PAY.INCOMING_INTERAC_AUTODEPOSIT_RETURN_REVERSAL - SYNCTERA_PAY.INCOMING_INTERAC_AUTODEPOSIT_REVERSAL - SYNCTERA_PAY.INCOMING_INTERAC_E_TRANSFER - SYNCTERA_PAY.INCOMING_INTERAC_E_TRANSFER_RETURN - SYNCTERA_PAY.INCOMING_INTERAC_E_TRANSFER_RETURN_REVERSAL - SYNCTERA_PAY.INCOMING_INTERAC_E_TRANSFER_REVERSAL - SYNCTERA_PAY.INCOMING_INTERNATIONAL_WIRE - SYNCTERA_PAY.INCOMING_INTERNATIONAL_WIRE_REVERSAL - SYNCTERA_PAY.OUTGOING_ACCOUNT_TRANSFER - SYNCTERA_PAY.OUTGOING_ACCOUNT_TRANSFER_RETURN - SYNCTERA_PAY.OUTGOING_ACCOUNT_TRANSFER_RETURN_REVERSAL - SYNCTERA_PAY.OUTGOING_ACCOUNT_TRANSFER_REVERSAL - SYNCTERA_PAY.OUTGOING_BILL_PAYMENT - SYNCTERA_PAY.OUTGOING_BILL_PAYMENT_RETURN - SYNCTERA_PAY.OUTGOING_BILL_PAYMENT_RETURN_REVERSAL - SYNCTERA_PAY.OUTGOING_BILL_PAYMENT_REVERSAL - SYNCTERA_PAY.OUTGOING_CARD_LOAD - SYNCTERA_PAY.OUTGOING_CARD_LOAD_REVERSAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_RETURN - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_RETURN - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_CASH_PICKUP - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_RETURN - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_RETURN - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_RETURN - SYNCTERA_PAY.OUTGOING_DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERAC_E_TRANSFER - SYNCTERA_PAY.OUTGOING_INTERAC_E_TRANSFER_RETURN - SYNCTERA_PAY.OUTGOING_INTERAC_E_TRANSFER_RETURN_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERAC_E_TRANSFER_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_ATM_WITHDRAWAL - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_ATM_WITHDRAWAL_RETURN - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_BANK_DEPOSIT - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_BANK_DEPOSIT_RETURN - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_CASH_PICKUP - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_CASH_PICKUP_RETURN - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_CASH_PICKUP_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_HOME_DELIVERY - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_HOME_DELIVERY_RETURN - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_MOBILE_WALLET - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_MOBILE_WALLET_RETURN - >- SYNCTERA_PAY.OUTGOING_INTERNATIONAL_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_REMITTANCE - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_REMITTANCE_RETURN - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_REMITTANCE_RETURN_REVERSAL - SYNCTERA_PAY.OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL type: string wire_spend_control_subtype: description: >- Valid WIRE payment sub-types for spend controls in PAYMENT_TYPE.SUBTYPE format. enum: - WIRE.BULK_DOMESTIC_OUTGOING - WIRE.BULK_DOMESTIC_OUTGOING_REVERSAL - WIRE.DOMESTIC_INCOMING - WIRE.DOMESTIC_INCOMING_RETURN - WIRE.DOMESTIC_INCOMING_RETURN_REVERSAL - WIRE.DOMESTIC_INCOMING_REVERSAL - WIRE.DOMESTIC_OUTGOING - WIRE.DOMESTIC_OUTGOING_RETURN - WIRE.DOMESTIC_OUTGOING_RETURN_REVERSAL - WIRE.DOMESTIC_OUTGOING_REVERSAL - WIRE.INTERNATIONAL_INCOMING - WIRE.INTERNATIONAL_INCOMING_RETURN - WIRE.INTERNATIONAL_INCOMING_RETURN_REVERSAL - WIRE.INTERNATIONAL_INCOMING_REVERSAL - WIRE.INTERNATIONAL_OUTGOING - WIRE.INTERNATIONAL_OUTGOING_RETURN - WIRE.INTERNATIONAL_OUTGOING_RETURN_REVERSAL - WIRE.INTERNATIONAL_OUTGOING_REVERSAL type: string payment_type: description: > The type of payment to which a spend control applies. If this is not set, the spend control applies to all spending, regardless of payment type. enum: - ACH - CARD - CASH - CHECK - EFT_CA - EXTERNAL_CARD - FEDNOW - INTERNAL_TRANSFER - SYNCTERA_PAY - WIRE type: string spend_control_forever: properties: time_range_type: $ref: '#/components/schemas/spend_control_time_range_type' required: - time_range_type title: Forever spend_control_rolling_window: properties: period: enum: - DAYS - HOURS - MINUTES - MONTHS - QUARTERS - SECONDS - WEEKS - YEARS type: string time_range_type: $ref: '#/components/schemas/spend_control_time_range_type' value: minimum: 1 type: integer required: - period - time_range_type - value title: Rolling Window type: object spend_control_rolling_window_days: properties: days: description: The number of days to define a rolling window for a spend control maximum: 31 minimum: 1 type: integer time_range_type: $ref: '#/components/schemas/spend_control_time_range_type' required: - days - time_range_type title: Rolling Window Days spend_control_single_transaction: properties: time_range_type: $ref: '#/components/schemas/spend_control_time_range_type' required: - time_range_type title: Single Transaction spend_control_static_window: properties: period: enum: - DAILY - HOURLY - LIFETIME - MINUTE - MONTHLY - QUARTERLY - WEEKLY - YEARLY type: string time_range_type: $ref: '#/components/schemas/spend_control_time_range_type' required: - period - time_range_type title: Static Window type: object spend_control_time_range_type: enum: - FOREVER - ROLLING_WINDOW - ROLLING_WINDOW_DAYS - SINGLE_TRANSACTION - STATIC_WINDOW type: string responses: bad_request: content: application/json: schema: $ref: '#/components/schemas/error' description: Bad request unauthorized: content: application/json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/json: schema: $ref: '#/components/schemas/error' description: Forbidden unprocessable_entity: content: application/json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````