> ## 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. # Preview capability tasks > Returns descriptor-only tasks from one pinned, side-effect-free evaluation snapshot. ## OpenAPI ````yaml /openapi.json get /v3/customers/{customerId}/capabilities/{capabilityId}/tasks-preview 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/customers/{customerId}/capabilities/{capabilityId}/tasks-preview: get: tags: - capabilities summary: Preview capability tasks description: >- Returns descriptor-only tasks from one pinned, side-effect-free evaluation snapshot. operationId: getV3CustomersByCustomerIdCapabilitiesByCapabilityIdTasks-preview parameters: - schema: type: string in: path name: customerId required: true - schema: type: string in: path name: capabilityId required: true responses: '200': description: Task descriptors returned content: application/json: schema: type: object properties: data: type: array items: type: object properties: category: type: string description: Canonical task category. subject: type: object properties: type: enum: - customer - related_party description: Customer or related-party subject type. id: type: string description: Public subject identifier. required: - type - id description: Customer or related-party task subject. requirements: type: array items: type: object properties: key: type: string description: Stable requirement descriptor key. section: type: string description: Optional requirement section label. request: anyOf: - type: object properties: type: description: Profile-field request. enum: - profile prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. valueType: enum: - string - number - boolean - date - country - money - address - tax_identifier - identity_document - object - array description: Canonical profile value type. itemValueType: enum: - string - number - boolean - date - country - money - address - tax_identifier - identity_document - object description: Array element value type. profilePointer: type: string pattern: >- ^\/(?:[^/~]|~0|~1)*(?:\/(?:[^/~]|~0|~1)*)*$ description: >- Canonical customer or related-party JSON Pointer. constraints: type: object properties: minLength: type: integer minimum: 0 description: Minimum string length. maxLength: type: integer minimum: 1 description: Maximum string length. pattern: type: string description: Regular expression the value must match. required: [] description: Type-compatible profile constraints. required: - type - prompt - required - valueType - profilePointer - type: object properties: type: description: Free-text request. enum: - text prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. constraints: type: object properties: minLength: type: integer minimum: 0 description: Minimum string length. maxLength: type: integer minimum: 1 description: Maximum string length. pattern: type: string description: Regular expression the value must match. required: [] description: String constraints. required: - type - prompt - required - type: object properties: type: description: Full-date request. enum: - date prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. constraints: type: object properties: minimum: type: string format: date description: Inclusive minimum full-date. maximum: type: string format: date description: Inclusive maximum full-date. required: [] description: Full-date constraints. required: - type - prompt - required - type: object properties: type: description: Select request discriminator. enum: - single_select prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. options: type: array items: type: object properties: value: type: string minLength: 1 description: Stable submitted option value. label: type: string minLength: 1 description: Human-readable option label. description: type: string description: Additional option guidance. required: - value - label minItems: 1 description: Available options. constraints: type: object properties: minItems: type: integer minimum: 0 description: Minimum selections. maxItems: type: integer minimum: 1 description: Maximum selections. required: [] description: Selection-count constraints. required: - type - prompt - required - options - type: object properties: type: description: Select request discriminator. enum: - multi_select prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. options: type: array items: type: object properties: value: type: string minLength: 1 description: Stable submitted option value. label: type: string minLength: 1 description: Human-readable option label. description: type: string description: Additional option guidance. required: - value - label minItems: 1 description: Available options. constraints: type: object properties: minItems: type: integer minimum: 0 description: Minimum selections. maxItems: type: integer minimum: 1 description: Maximum selections. required: [] description: Selection-count constraints. required: - type - prompt - required - options - type: object properties: type: description: Boolean request. enum: - boolean prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. required: - type - prompt - required - type: object properties: type: description: Versioned attestation request. enum: - attestation prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. text: type: string minLength: 1 description: Exact text presented for acceptance. version: type: string minLength: 1 description: Immutable text version. constraints: type: object properties: verificationLink: allOf: - type: string - type: number description: Forbidden on summary representations. required: [] description: URL-free public attestation constraints. required: - type - prompt - required - text - version - type: object properties: type: description: Document request. enum: - document prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. purpose: type: string minLength: 1 description: Published document purpose. acceptedDocumentTypes: type: array items: type: string minItems: 1 description: Accepted document types. minDocuments: type: integer minimum: 1 description: Minimum document count. maxDocuments: type: integer minimum: 1 description: Maximum document count. constraints: type: object properties: maxAgeDays: type: integer minimum: 1 description: Maximum document age in days. captureMethods: type: array items: type: string minItems: 1 description: Accepted capture methods. nameMatch: type: string description: Required subject name. acceptedFormats: type: array items: type: string minItems: 1 description: Accepted media formats. required: [] description: Document constraints. required: - type - prompt - required - purpose - type: object properties: type: description: Related-party reference request. enum: - resource_reference prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. resourceType: description: Referenced resource type. enum: - related_party requiredRoles: type: array items: type: string minItems: 1 description: Required related-party roles. required: - type - prompt - required - resourceType - type: object properties: type: description: Mutually exclusive evidence routes. enum: - alternatives prompt: type: string minLength: 1 description: Instruction for choosing one route. alternatives: type: array items: type: object properties: key: type: string minLength: 1 description: Stable alternative key. request: anyOf: - type: object properties: type: description: Profile-field request. enum: - profile prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. valueType: enum: - string - number - boolean - date - country - money - address - tax_identifier - identity_document - object - array description: Canonical profile value type. itemValueType: enum: - string - number - boolean - date - country - money - address - tax_identifier - identity_document - object description: Array element value type. profilePointer: type: string pattern: >- ^\/(?:[^/~]|~0|~1)*(?:\/(?:[^/~]|~0|~1)*)*$ description: >- Canonical customer or related-party JSON Pointer. constraints: type: object properties: minLength: type: integer minimum: 0 description: Minimum string length. maxLength: type: integer minimum: 1 description: Maximum string length. pattern: type: string description: Regular expression the value must match. required: [] description: Type-compatible profile constraints. required: - type - prompt - required - valueType - profilePointer - type: object properties: type: description: Free-text request. enum: - text prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. constraints: type: object properties: minLength: type: integer minimum: 0 description: Minimum string length. maxLength: type: integer minimum: 1 description: Maximum string length. pattern: type: string description: Regular expression the value must match. required: [] description: String constraints. required: - type - prompt - required - type: object properties: type: description: Full-date request. enum: - date prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. constraints: type: object properties: minimum: type: string format: date description: Inclusive minimum full-date. maximum: type: string format: date description: Inclusive maximum full-date. required: [] description: Full-date constraints. required: - type - prompt - required - type: object properties: type: description: Select request discriminator. enum: - single_select prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. options: type: array items: type: object properties: value: type: string minLength: 1 description: Stable submitted option value. label: type: string minLength: 1 description: Human-readable option label. description: type: string description: Additional option guidance. required: - value - label minItems: 1 description: Available options. constraints: type: object properties: minItems: type: integer minimum: 0 description: Minimum selections. maxItems: type: integer minimum: 1 description: Maximum selections. required: [] description: Selection-count constraints. required: - type - prompt - required - options - type: object properties: type: description: Select request discriminator. enum: - multi_select prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. options: type: array items: type: object properties: value: type: string minLength: 1 description: Stable submitted option value. label: type: string minLength: 1 description: Human-readable option label. description: type: string description: Additional option guidance. required: - value - label minItems: 1 description: Available options. constraints: type: object properties: minItems: type: integer minimum: 0 description: Minimum selections. maxItems: type: integer minimum: 1 description: Maximum selections. required: [] description: Selection-count constraints. required: - type - prompt - required - options - type: object properties: type: description: Boolean request. enum: - boolean prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. required: - type - prompt - required - type: object properties: type: description: Versioned attestation request. enum: - attestation prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. text: type: string minLength: 1 description: Exact text presented for acceptance. version: type: string minLength: 1 description: Immutable text version. constraints: type: object properties: verificationLink: allOf: - type: string - type: number description: Forbidden on summary representations. required: [] description: URL-free public attestation constraints. required: - type - prompt - required - text - version - type: object properties: type: description: Document request. enum: - document prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. purpose: type: string minLength: 1 description: Published document purpose. acceptedDocumentTypes: type: array items: type: string minItems: 1 description: Accepted document types. minDocuments: type: integer minimum: 1 description: Minimum document count. maxDocuments: type: integer minimum: 1 description: Maximum document count. constraints: type: object properties: maxAgeDays: type: integer minimum: 1 description: Maximum document age in days. captureMethods: type: array items: type: string minItems: 1 description: Accepted capture methods. nameMatch: type: string description: Required subject name. acceptedFormats: type: array items: type: string minItems: 1 description: Accepted media formats. required: [] description: Document constraints. required: - type - prompt - required - purpose - type: object properties: type: description: Related-party reference request. enum: - resource_reference prompt: type: string minLength: 1 description: >- Instruction shown to the person completing the task. required: description: >- Published non-alternative requests are required. enum: - true allowsAbsence: type: boolean description: Whether an absence answer is accepted. resourceType: description: Referenced resource type. enum: - related_party requiredRoles: type: array items: type: string minItems: 1 description: Required related-party roles. required: - type - prompt - required - resourceType required: - key - request minItems: 1 description: Non-recursive alternative requests. required: - type - prompt - alternatives required: - key - request description: Ordered requirement descriptors. verificationSessions: type: array items: type: object properties: key: type: string description: Stable verification-session key. type: enum: - identity_verification - business_verification description: >- Identity or business verification-session type. required: - key - type description: Ordered verification-session descriptors. tosSessions: type: array items: type: object properties: key: type: string description: Stable verification-session key. type: description: Hosted terms-session type. enum: - terms_of_service required: - key - type description: Ordered terms-session descriptors. completionPolicy: anyOf: - type: object properties: type: enum: - requirements - verification_sessions - tos_sessions description: >- Task child collection evaluated by this policy leaf. completion: description: >- Every live member of the collection must complete. enum: - all required: - type - completion - type: object properties: mode: enum: - all_of - any_of description: >- How nested completion conditions are combined. conditions: type: array items: anyOf: - type: object properties: type: enum: - requirements - verification_sessions - tos_sessions description: >- Task child collection evaluated by this policy leaf. completion: description: >- Every live member of the collection must complete. enum: - all required: - type - completion - type: object properties: mode: enum: - all_of - any_of description: >- How nested completion conditions are combined. conditions: type: array items: type: object properties: type: enum: - requirements - verification_sessions - tos_sessions description: >- Task child collection evaluated by this policy leaf. completion: description: >- Every live member of the collection must complete. enum: - all required: - type - completion minItems: 2 description: Two or more normalized child conditions. required: - mode - conditions minItems: 2 description: Two or more normalized child conditions. required: - mode - conditions description: Normalized completion expression. required: - category - subject - requirements - verificationSessions - tosSessions - completionPolicy description: Descriptor-only capability task preview. required: - data '400': description: Invalid request. 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: Insufficient permissions. 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: 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 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. '422': description: Capability is not requestable 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 - [Capabilities and tasks](/integration/onboarding/capabilities-and-requirements.md) - [Cancel capability](/api-reference/capabilities/post-v3-customers-by-customer-id-capabilities-by-capability-id-cancel.md) - [Create capability](/api-reference/capabilities/post-v3-customers-by-customer-id-capabilities-by-capability-id.md) - [Capability created](/api-reference/webhooks/capability-created.md) - [List capability applications](/api-reference/capabilities/get-v3-customers-by-customer-id-capabilities-by-capability-id-applications.md)