> ## 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. # Get Spend Control > Get spend control ## OpenAPI ````yaml openapi.json get /spend_controls/{spend_control_id} 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: 0.207.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /spend_controls/{spend_control_id}: get: tags: - Spend Controls summary: Get Spend Control description: | Get spend control operationId: getSpendControl parameters: - $ref: '#/components/parameters/spend_control_id' responses: '200': 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: parameters: spend_control_id: in: path name: spend_control_id required: true schema: $ref: '#/components/schemas/spend_control_id' schemas: 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 required: - number_of_related_accounts type: object - $ref: '#/components/schemas/spend_control' required: - action_case - action_decline - amount_limit - creation_time - id - is_active - last_modified_time - name - number_of_related_accounts - scope - time_range spend_control_id: description: The unique identifier of a spending control example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string 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 amount_limit: description: >- Monetary limit for the spend control in the smallest currency unit (eg cents) 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 direction: $ref: '#/components/schemas/spend_control_direction' 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 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_types: $ref: '#/components/schemas/payment_type_list' scope: $ref: '#/components/schemas/spend_control_scope' time_range: $ref: '#/components/schemas/spend_control_time_range' required: - action_case - action_decline - amount_limit - is_active - name - time_range title: Spend Control type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. 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: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object 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 DEBIT. To limit the rate of funds flowing in to an account, use CREDIT. If this is not set, the spend control applies to debits (ie spending) only. enum: - CREDITS - DEBITS 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. items: type: string type: array 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: description: The scope of the spend control enum: - ACCOUNT - BANK - FINTECH readOnly: true 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_DAYS: $ref: '#/components/schemas/spend_control_rolling_window_days' SINGLE_TRANSACTION: $ref: '#/components/schemas/spend_control_single_transaction' propertyName: time_range_type oneOf: - $ref: '#/components/schemas/spend_control_forever' - $ref: '#/components/schemas/spend_control_single_transaction' - $ref: '#/components/schemas/spend_control_rolling_window_days' type: object 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 - INTERNAL_TRANSFER - SYNCTERA_PAY - WIRE type: string spend_control_forever: allOf: - $ref: '#/components/schemas/spend_control_time_range_type' required: - time_range_type title: Forever spend_control_rolling_window_days: allOf: - properties: days: description: >- The number of days to define a rolling window for a spend control maximum: 31 minimum: 1 type: integer required: - days - time_range_type type: object - $ref: '#/components/schemas/spend_control_time_range_type' title: Rolling Window Days spend_control_single_transaction: allOf: - $ref: '#/components/schemas/spend_control_time_range_type' required: - time_range_type title: Single Transaction spend_control_time_range_type: properties: time_range_type: enum: - FOREVER - ROLLING_WINDOW_DAYS - SINGLE_TRANSACTION type: string required: - time_range_type type: object responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````