> ## Documentation Index > Fetch the complete documentation index at: https://docs.swipelux.com/llms.txt > Use this file to discover all available pages before exploring further. # Force sandbox capability status > Forces a sandbox capability to `ready`, `rejected`, or `restricted`. ## OpenAPI ````yaml /openapi.json post /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status openapi: 3.1.0 info: title: Swipelux API version: 3.1.0 servers: - url: https://platform.swipelux.com description: Production and sandbox; environment selected by API key security: - apiKey: [] tags: - name: customers x-displayName: Customers description: >- Create, list, update, export, and archive individual and business customers and their related parties. - name: capabilities x-displayName: Capabilities description: >- Discover, request, inspect, and cancel customer capabilities and their institution applications. - name: accounts x-displayName: Accounts description: Create, inspect, update, and archive customer accounts. - name: recipients x-displayName: Recipients description: Create third-party recipients and their payout destinations. - name: Tasks x-displayName: Tasks description: Inspect customer, capability, application, account, and transfer tasks. - name: Task submissions x-displayName: Task submissions description: Submit and inspect immutable answers to customer tasks. - name: documents x-displayName: Documents description: Upload and inspect customer documents used in task submissions. - name: money-movement x-displayName: Money movement description: Create quotes, execute quote-backed transfers, and inspect transfer state. - name: rules x-displayName: Rules description: >- Standing instructions that act on incoming funds. A rule watches a custodial wallet account (`trigger`) and, when funds become available on it, transfers them to a target (`action`) — most commonly a sweep to a non-custodial wallet destination. Rules match at the account credit, not at the deposit rail: fiat deposits settle into the issued bank account's settlement wallet account, so a rule on that wallet account catches ACH/SEPA/SWIFT deposits, stablecoin deposits, and internal transfers alike. The action target reuses the money-movement vocabulary (`account` for the customer's own accounts, `destination` for recipient destinations). At most one non-archived rule may watch a given trigger account. Statuses: `active ⇄ paused → archived` — pause and resume through PATCH, archive (terminal) through DELETE. - name: sandbox x-displayName: Sandbox description: Simulate supported account, task, capability, and transfer outcomes. - name: institutions x-displayName: Institutions description: List institutions referenced by capabilities and applications. - name: webhooks x-displayName: Webhooks description: Configure webhook endpoints and inspect delivery activity. externalDocs: description: Swipelux Documentation url: https://docs.swipelux.com paths: /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status: post: tags: - sandbox summary: Force sandbox capability status description: Forces a sandbox capability to `ready`, `rejected`, or `restricted`. operationId: postV3SandboxCustomersByCustomerIdCapabilitiesByCapabilityIdStatus parameters: - schema: type: string in: path name: customerId required: true - schema: type: string in: path name: capabilityId required: true requestBody: required: true content: application/json: schema: type: object required: - status properties: status: type: string enum: - ready - rejected - restricted description: Capability status implemented by the sandbox simulator. examples: ready: value: status: ready rejected: value: status: rejected restricted: value: status: restricted responses: '200': description: Sandbox capability status forced content: application/json: schema: type: object properties: data: anyOf: - type: object properties: id: type: string pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$ description: >- Permanent capability id, for example `ach_pooled`. `wire_pooled`/`wire_named` cover bank-wire capability requests, including provider routes that use the domestic wire network as the underlying rail. The internal rail remains a method/rail vocabulary value, not a public capability id. Open enum — values are added over time; clients must tolerate unknown values. customerId: type: string description: Customer identifier. method: enum: - ach - wire - rtp - pix - sepa - swift - spei - pse - transfers_3_0 - uaefts - faster_payments - sepa_instant - ipp - card - stablecoin_transfers description: >- Single payment method represented by this capability. Open enum — values are added over time; clients must tolerate unknown values. accountType: anyOf: - enum: - pooled - named nullable: true description: >- Bank account type when the capability is bank-account based. status: description: >- Capability status. Closed enum — exhaustive; additions would be a breaking change. enum: - ready statusReason: allOf: - type: string - type: number description: >- Structured reason for a non-ready capability. Ready capabilities omit this field. openTaskIds: type: array items: type: string description: >- Ids of open tasks associated with this capability or one of its applications, including shared customer tasks reached through an active dependency, ordered by creation time and then task id. Empty when nothing is open. applications: type: array items: type: object properties: id: type: string description: Application identifier (`apl_...`). institution: type: object properties: id: type: string description: >- Opaque public institution id to send in `institutions`. name: type: string description: Public institution name. bic: anyOf: - type: string nullable: true description: BIC/SWIFT code when known. required: - id - name - bic status: enum: - requested - in_review - action_required - ready - rejected - disabled - canceled description: >- Institution application status. Closed enum — exhaustive; additions would be a breaking change. statusReason: anyOf: - type: object properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. message: type: string description: >- Human-readable explanation of the current status. actor: enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. required: - code - message - actor - retryable nullable: true description: >- Structured reason for the current status. `in_review` always returns a stored or synthesized reason; self-explanatory statuses may return null. openTaskIds: type: array items: type: string description: >- Ids of open tasks associated with this application, including shared customer tasks reached through an active dependency, ordered by creation time and then task id. Empty when nothing is open. submittedAt: anyOf: - type: string nullable: true description: Submitted at. createdAt: type: string description: Created at. updatedAt: type: string description: Updated at. required: - id - institution - status - statusReason - openTaskIds - submittedAt - createdAt - updatedAt description: Institution compliance flows for this capability. submittedAt: anyOf: - type: string nullable: true description: Submitted at. createdAt: type: string description: Created at. updatedAt: type: string description: Updated at. required: - id - customerId - method - accountType - status - openTaskIds - applications - submittedAt - createdAt - updatedAt - type: object properties: id: type: string pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$ description: >- Permanent capability id, for example `ach_pooled`. `wire_pooled`/`wire_named` cover bank-wire capability requests, including provider routes that use the domestic wire network as the underlying rail. The internal rail remains a method/rail vocabulary value, not a public capability id. Open enum — values are added over time; clients must tolerate unknown values. customerId: type: string description: Customer identifier. method: enum: - ach - wire - rtp - pix - sepa - swift - spei - pse - transfers_3_0 - uaefts - faster_payments - sepa_instant - ipp - card - stablecoin_transfers description: >- Single payment method represented by this capability. Open enum — values are added over time; clients must tolerate unknown values. accountType: anyOf: - enum: - pooled - named nullable: true description: >- Bank account type when the capability is bank-account based. status: enum: - pending - restricted - rejected - canceled description: >- Capability status. Closed enum — exhaustive; additions would be a breaking change. statusReason: type: object properties: code: type: string description: >- Stable snake_case reason code for the capability status. resolution: enum: - complete_tasks - wait - contact_support - none description: Action that can move the capability forward. message: type: string description: >- Human-readable explanation of the capability status. required: - code - resolution - message description: >- Structured reason for a non-ready capability. Ready capabilities omit this field. openTaskIds: type: array items: type: string description: >- Ids of open tasks associated with this capability or one of its applications, including shared customer tasks reached through an active dependency, ordered by creation time and then task id. Empty when nothing is open. applications: type: array items: type: object properties: id: type: string description: Application identifier (`apl_...`). institution: type: object properties: id: type: string description: >- Opaque public institution id to send in `institutions`. name: type: string description: Public institution name. bic: anyOf: - type: string nullable: true description: BIC/SWIFT code when known. required: - id - name - bic status: enum: - requested - in_review - action_required - ready - rejected - disabled - canceled description: >- Institution application status. Closed enum — exhaustive; additions would be a breaking change. statusReason: anyOf: - type: object properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. message: type: string description: >- Human-readable explanation of the current status. actor: enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. required: - code - message - actor - retryable nullable: true description: >- Structured reason for the current status. `in_review` always returns a stored or synthesized reason; self-explanatory statuses may return null. openTaskIds: type: array items: type: string description: >- Ids of open tasks associated with this application, including shared customer tasks reached through an active dependency, ordered by creation time and then task id. Empty when nothing is open. submittedAt: anyOf: - type: string nullable: true description: Submitted at. createdAt: type: string description: Created at. updatedAt: type: string description: Updated at. required: - id - institution - status - statusReason - openTaskIds - submittedAt - createdAt - updatedAt description: Institution compliance flows for this capability. submittedAt: anyOf: - type: string nullable: true description: Submitted at. createdAt: type: string description: Created at. updatedAt: type: string description: Updated at. required: - id - customerId - method - accountType - status - statusReason - openTaskIds - applications - submittedAt - createdAt - updatedAt description: Capability. required: - data '400': description: Validation error content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/validation-error description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 400 description: HTTP status code. code: type: string enum: - validation_error description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. '401': description: Authentication required. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId - retryable properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/unauthorized description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 401 description: HTTP status code. code: type: string enum: - unauthorized description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. retryable: type: boolean enum: - false description: Whether retrying the same request may succeed. '403': description: Live API key — sandbox-only endpoint content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId - retryable properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/forbidden description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 403 description: HTTP status code. code: type: string enum: - forbidden description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. retryable: type: boolean enum: - false description: Whether retrying the same request may succeed. '404': description: Customer not found content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/not-found description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 404 description: HTTP status code. code: type: string enum: - not_found description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. '422': description: Capability or requested status cannot be forced content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/invalid-capability description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 422 description: HTTP status code. code: type: string enum: - invalid_capability description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. '500': description: Internal server error. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId - retryable properties: type: type: string format: uri enum: - https://docs.swipelux.com/errors/internal-error description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer enum: - 500 description: HTTP status code. code: type: string enum: - internal_error description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. retryable: type: boolean enum: - true description: Whether retrying the same request may succeed. components: securitySchemes: apiKey: type: apiKey in: header name: X-API-Key ```` ## Related topics - [Force sandbox transfer state](/api-reference/sandbox/post-v3-sandbox-transfers-by-transfer-id-state.md) - [Migrate a v1 or v2 integration to Swipelux API v3](/api-reference/versioning/migrate-to-v3.md) - [Sandbox testing](/integration/sandbox.md) - [Quickstart](/integration/quickstart.md) - [Errors and retries](/integration/errors.md)