> ## 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 transfer state > Forces an existing sandbox transfer to `completed` or `failed`. ## OpenAPI ````yaml /openapi.json post /v3/sandbox/transfers/{transferId}/state 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/transfers/{transferId}/state: post: tags: - sandbox summary: Force sandbox transfer state description: Forces an existing sandbox transfer to `completed` or `failed`. operationId: postV3SandboxTransfersByTransferIdState parameters: - schema: type: string in: path name: transferId required: true requestBody: required: true content: application/json: schema: type: object required: - state properties: state: type: string enum: - completed - failed description: Transfer state implemented by the sandbox simulator. stateDetail: type: object description: >- Optional failure detail. Applied only when forcing a payin transfer to `failed`; ignored for completed states and payout transfers. required: - code properties: code: type: string minLength: 1 message: type: string minLength: 1 examples: completed: value: state: completed failed: value: state: failed stateDetail: code: provider_review message: Sandbox transfer failed. responses: '200': description: Sandbox transfer state forced content: application/json: schema: type: object properties: data: type: object properties: id: type: string origin: enum: - quoted - inbound_deposit description: >- How the transfer was created. `quoted` comes from a v3 quote; `inbound_deposit` comes from reconciliation. Open enum — values are added over time; clients must tolerate unknown values. quoteId: type: string description: >- Quote id. Always present for `quoted` transfers and absent for `inbound_deposit` transfers. customerId: type: string capabilityId: type: string description: >- Capability id when a capability applies. Absent for inbound deposits that do not map to a capability. openTaskIds: type: array items: type: string description: >- Ids of transfer-scoped tasks with status `action_required` or `in_review`, ordered by creation time and id. Empty when nothing is open. institutionId: type: string description: >- Public institution id echoed from the quote when the backing bank capability has a single institution. externalId: type: string method: type: string description: >- Movement method derived from the capability for quoted transfers or normalized from the receiving rail for inbound deposits. Open enum — values are added over time; clients must tolerate unknown values. direction: enum: - fiat_to_stablecoin - stablecoin_to_fiat - stablecoin_move description: >- Transfer direction. Closed enum — exhaustive; additions would be a breaking change. state: enum: - awaiting_funds - processing - action_required - completed - failed - canceled description: >- Public transfer state. `processing` covers funds received through settlement. `action_required` is projected when an otherwise in-flight transfer has open transfer tasks. `canceled` is projected when an unfunded deposit window expires. Closed enum — exhaustive; additions would be a breaking change. stateDetail: 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 state. Nullable on happy-path states; required for action_required and other non-terminal blocking/failure states. amounts: type: object properties: in: type: object properties: amount: type: string currency: type: string network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche description: >- Blockchain network for a crypto leg. Absent for fiat legs and uncatalogued networks. Blockchain network id. Open enum — values are added over time; clients must tolerate unknown values. required: - amount - currency out: type: object properties: amount: type: string currency: type: string network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche description: >- Blockchain network for a crypto leg. Absent for fiat legs and uncatalogued networks. Blockchain network id. Open enum — values are added over time; clients must tolerate unknown values. required: - amount - currency settled: type: object properties: amount: type: string currency: type: string required: - amount - currency description: Actually delivered amount; present once completed. required: - in - out fees: type: array items: type: object properties: beneficiary: anyOf: - enum: - developer - enum: - service description: >- Fee beneficiary. Closed enum — exhaustive; additions would be a breaking change. amount: type: string currency: type: string rule: type: object required: - fixed - bips properties: fixed: type: string bips: type: number required: - beneficiary - amount - currency description: >- Applied fee snapshot, using the same shape as the quote fee lines. source: anyOf: - type: object properties: type: enum: - external required: - type - type: object properties: type: enum: - account id: type: string description: >- Source account for stablecoin-funded movements. required: - type - id destination: anyOf: - type: object properties: type: enum: - account id: type: string pattern: ^acc_[a-zA-Z0-9]+$ required: - type - id - type: object properties: type: enum: - destination id: type: string pattern: ^dst_[a-zA-Z0-9]+$ required: - type - id references: type: object properties: transactionHash: type: string traceNumber: type: string description: >- Provider payment tracking reference, such as an ACH trace number or wire reference. Absent when unavailable. imad: type: string uetr: type: string explorerUrl: type: string description: >- Block-explorer link for the crypto leg, derived from the wallet network. Absent when the network has no catalogued explorer. returnedTransferId: type: string nullable: true description: Return-movement id; currently always null. required: - returnedTransferId memo: type: string supportingDocuments: type: array items: type: string instructions: anyOf: - type: object properties: type: enum: - bank method: enum: - ach - wire - rtp - sepa - swift - spei - transfers_3_0 - uaefts - faster_payments description: >- Bank instruction method. Open enum — values are added over time; clients must tolerate unknown values. amount: type: object properties: amount: type: string currency: type: string required: - amount - currency accountHolderName: type: string bankName: type: string details: type: object additionalProperties: type: string description: >- Per-method banking coordinates in camelCase: routingNumber/accountNumber/accountType (ach, wire, rtp), iban/bic (sepa, uaefts), swiftCode/accountNumber (swift), sortCode/accountNumber (faster_payments), clabe (spei), cbu (transfers_3_0). reference: type: object properties: value: type: string required: type: boolean description: >- Whether the deposit must carry this reference to be matched. Pooled accounts match deposits by reference; named virtual accounts match by account number. required: - value - required description: Payment reference to include with the deposit. localAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency description: >- Amount in the local settlement currency when the rail settles in a currency different from the quoted in amount. expiresAt: type: string required: - type - method - amount - details - type: object properties: type: enum: - code method: enum: - pix description: >- Code instruction method. Open enum — values are added over time; clients must tolerate unknown values. amount: type: object properties: amount: type: string currency: type: string required: - amount - currency code: type: string description: >- Copyable payment code the customer pastes into their banking app. localAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency expiresAt: type: string required: - type - method - amount - code - type: object properties: type: enum: - redirect method: enum: - pse description: >- Redirect instruction method. Open enum — values are added over time; clients must tolerate unknown values. amount: type: object properties: amount: type: string currency: type: string required: - amount - currency url: type: string description: >- Hosted payment page the customer completes the payment on. localAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency expiresAt: type: string required: - type - amount - url nullable: true description: >- Deposit instructions, discriminated by `type`. `null` for payout-side transfers, which are funded from the source account. timestamps: type: object properties: createdAt: type: string updatedAt: type: string fundsReceivedAt: type: string nullable: true description: Currently always null. completedAt: type: string nullable: true description: Currently always null. failedAt: type: string nullable: true description: Currently always null. returnedAt: type: string nullable: true description: Currently always null. settledAt: type: string nullable: true description: Currently always null. required: - createdAt - updatedAt - fundsReceivedAt - completedAt - failedAt - returnedAt - settledAt required: - id - origin - customerId - openTaskIds - method - direction - state - stateDetail - amounts - fees - source - destination - references - instructions - timestamps required: - data '400': description: Validation, state transition, or non-sandbox rejection content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string 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`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. 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. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string 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. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '401': description: Authentication required. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string 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`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. 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. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string 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. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '403': description: Live API key — sandbox-only endpoint content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string 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`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. 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. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string 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. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '404': description: Transfer not found for this merchant content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string 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`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. 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. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string 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. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '500': description: Internal server error. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string 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`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. 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. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string 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. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. components: securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: Your Swipelux API key. Obtain this from the Swipelux Dashboard. ```` ## Related topics - [Force sandbox capability status](/api-reference/sandbox/post-v3-sandbox-customers-by-customer-id-capabilities-by-capability-id-status.md) - [Sandbox testing](/integration/sandbox.md) - [Credit a sandbox account](/api-reference/sandbox/post-v3-sandbox-accounts-by-account-id-topup.md) - [Create sandbox task](/api-reference/sandbox/post-v3-sandbox-tasks.md) - [Review sandbox task submission](/api-reference/sandbox/post-v3-sandbox-tasks-by-task-id-review.md)