> ## 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. # Get recipient > Returns a recipient with its payout destinations. ## OpenAPI ````yaml /openapi.json get /v3/customers/{customerId}/recipients/{recipientId} 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}/recipients/{recipientId}: get: tags: - recipients summary: Get recipient description: Returns a recipient with its payout destinations. operationId: getV3CustomersByCustomerIdRecipientsByRecipientId parameters: - in: path name: recipientId schema: type: string required: true - schema: type: string in: path name: customerId required: true responses: '200': description: Recipient retrieved content: application/json: schema: type: object properties: data: anyOf: - type: object properties: id: type: string customerId: type: string relationship: enum: - employee - contractor - vendor - subsidiary - merchant - customer - landlord - family - other externalId: type: string status: enum: - active - rejected - archived description: >- Recipient status. Closed enum — active is usable, rejected means a provider rejected the recipient, and archived is no longer usable; additions would be a breaking change. email: type: string phone: type: string address: type: object required: - streetLine1 - city - postalCode - country additionalProperties: false properties: streetLine1: type: string streetLine2: type: string city: type: string state: type: string postalCode: type: string country: type: string label: type: string metadata: type: object additionalProperties: {} createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true description: >- Archive timestamp set by DELETE; null while the recipient is active. type: enum: - individual firstName: type: string lastName: type: string destinations: type: array items: anyOf: - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - sepa currency: type: string minLength: 3 maxLength: 3 details: type: object required: - iban - accountHolderName - country additionalProperties: false properties: iban: type: string minLength: 15 maxLength: 34 bic: type: string minLength: 8 maxLength: 11 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - sepa currency: type: string minLength: 3 maxLength: 3 details: type: object required: - iban - accountHolderName - country additionalProperties: false properties: iban: type: string minLength: 15 maxLength: 34 bic: type: string minLength: 8 maxLength: 11 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - swift currency: type: string minLength: 3 maxLength: 3 details: type: object required: - swiftCode - accountNumber - bankName - accountHolderName - country additionalProperties: false properties: swiftCode: type: string minLength: 8 maxLength: 11 accountNumber: type: string minLength: 1 maxLength: 34 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 routingNumber: type: string minLength: 9 maxLength: 9 intermediaryBankSwift: type: string minLength: 8 maxLength: 11 intermediaryBankName: type: string minLength: 1 maxLength: 255 intermediaryBankAddress: type: string minLength: 1 maxLength: 512 status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - swift currency: type: string minLength: 3 maxLength: 3 details: type: object required: - swiftCode - accountNumber - bankName - accountHolderName - country additionalProperties: false properties: swiftCode: type: string minLength: 8 maxLength: 11 accountNumber: type: string minLength: 1 maxLength: 34 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 routingNumber: type: string minLength: 9 maxLength: 9 intermediaryBankSwift: type: string minLength: 8 maxLength: 11 intermediaryBankName: type: string minLength: 1 maxLength: 255 intermediaryBankAddress: type: string minLength: 1 maxLength: 512 status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - ach currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - ach currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wire currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wire currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - spei currency: type: string minLength: 3 maxLength: 3 details: type: object properties: clabe: type: string minLength: 18 maxLength: 18 institutionName: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: MX required: - clabe - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - spei currency: type: string minLength: 3 maxLength: 3 details: type: object properties: clabe: type: string minLength: 18 maxLength: 18 institutionName: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: MX required: - clabe - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - pse currency: type: string minLength: 3 maxLength: 3 details: type: object properties: bankCode: type: string minLength: 1 maxLength: 64 accountNumber: type: string minLength: 1 maxLength: 34 documentType: type: string minLength: 1 maxLength: 32 documentNumber: type: string minLength: 1 maxLength: 64 email: type: string format: email bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: CO required: - bankCode - accountNumber - documentType - documentNumber - email - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - pse currency: type: string minLength: 3 maxLength: 3 details: type: object properties: bankCode: type: string minLength: 1 maxLength: 64 accountNumber: type: string minLength: 1 maxLength: 34 documentType: type: string minLength: 1 maxLength: 32 documentNumber: type: string minLength: 1 maxLength: 64 email: type: string format: email bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: CO required: - bankCode - accountNumber - documentType - documentNumber - email - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - transfers_3_0 currency: type: string minLength: 3 maxLength: 3 details: type: object properties: cbu: type: string minLength: 22 maxLength: 22 alias: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 taxId: type: string minLength: 1 maxLength: 64 country: type: string minLength: 2 maxLength: 2 default: AR required: - cbu - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - transfers_3_0 currency: type: string minLength: 3 maxLength: 3 details: type: object properties: cbu: type: string minLength: 22 maxLength: 22 alias: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 taxId: type: string minLength: 1 maxLength: 64 country: type: string minLength: 2 maxLength: 2 default: AR required: - cbu - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wallet currency: type: string minLength: 2 maxLength: 10 ownership: anyOf: - type: object properties: type: enum: - self_custodied required: - type additionalProperties: false - type: object properties: type: enum: - custodial custodianName: type: string minLength: 1 maxLength: 255 required: - type - custodianName additionalProperties: false details: type: object properties: network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche address: type: string minLength: 1 maxLength: 255 label: type: string maxLength: 255 required: - network - address additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - ownership - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wallet currency: type: string minLength: 2 maxLength: 10 ownership: anyOf: - type: object properties: type: enum: - self_custodied required: - type additionalProperties: false - type: object properties: type: enum: - custodial custodianName: type: string minLength: 1 maxLength: 255 required: - type - custodianName additionalProperties: false details: type: object properties: network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche address: type: string minLength: 1 maxLength: 255 label: type: string maxLength: 255 required: - network - address additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - ownership - details - status additionalProperties: false required: - id - customerId - relationship - status - createdAt - updatedAt - archivedAt - type - firstName - lastName - destinations additionalProperties: false - type: object properties: id: type: string customerId: type: string relationship: enum: - employee - contractor - vendor - subsidiary - merchant - customer - landlord - family - other externalId: type: string status: enum: - active - rejected - archived description: >- Recipient status. Closed enum — active is usable, rejected means a provider rejected the recipient, and archived is no longer usable; additions would be a breaking change. email: type: string phone: type: string address: type: object required: - streetLine1 - city - postalCode - country additionalProperties: false properties: streetLine1: type: string streetLine2: type: string city: type: string state: type: string postalCode: type: string country: type: string label: type: string metadata: type: object additionalProperties: {} createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true description: >- Archive timestamp set by DELETE; null while the recipient is active. type: enum: - business companyName: type: string businessIndustry: type: string description: >- 6-digit NAICS code used for provider-backed ACH readiness checks on business recipients. destinations: type: array items: anyOf: - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - sepa currency: type: string minLength: 3 maxLength: 3 details: type: object required: - iban - accountHolderName - country additionalProperties: false properties: iban: type: string minLength: 15 maxLength: 34 bic: type: string minLength: 8 maxLength: 11 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - sepa currency: type: string minLength: 3 maxLength: 3 details: type: object required: - iban - accountHolderName - country additionalProperties: false properties: iban: type: string minLength: 15 maxLength: 34 bic: type: string minLength: 8 maxLength: 11 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - swift currency: type: string minLength: 3 maxLength: 3 details: type: object required: - swiftCode - accountNumber - bankName - accountHolderName - country additionalProperties: false properties: swiftCode: type: string minLength: 8 maxLength: 11 accountNumber: type: string minLength: 1 maxLength: 34 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 routingNumber: type: string minLength: 9 maxLength: 9 intermediaryBankSwift: type: string minLength: 8 maxLength: 11 intermediaryBankName: type: string minLength: 1 maxLength: 255 intermediaryBankAddress: type: string minLength: 1 maxLength: 512 status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - swift currency: type: string minLength: 3 maxLength: 3 details: type: object required: - swiftCode - accountNumber - bankName - accountHolderName - country additionalProperties: false properties: swiftCode: type: string minLength: 8 maxLength: 11 accountNumber: type: string minLength: 1 maxLength: 34 bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 routingNumber: type: string minLength: 9 maxLength: 9 intermediaryBankSwift: type: string minLength: 8 maxLength: 11 intermediaryBankName: type: string minLength: 1 maxLength: 255 intermediaryBankAddress: type: string minLength: 1 maxLength: 512 status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - ach currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - ach currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wire currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wire currency: type: string minLength: 3 maxLength: 3 details: type: object properties: routingNumber: type: string minLength: 9 maxLength: 9 accountNumber: type: string minLength: 1 maxLength: 34 accountType: enum: - checking - savings default: checking bankName: type: string minLength: 1 maxLength: 255 bankAddress: type: string minLength: 1 maxLength: 512 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - routingNumber - accountNumber - bankName - accountHolderName - country additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - spei currency: type: string minLength: 3 maxLength: 3 details: type: object properties: clabe: type: string minLength: 18 maxLength: 18 institutionName: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: MX required: - clabe - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - spei currency: type: string minLength: 3 maxLength: 3 details: type: object properties: clabe: type: string minLength: 18 maxLength: 18 institutionName: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: MX required: - clabe - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - pse currency: type: string minLength: 3 maxLength: 3 details: type: object properties: bankCode: type: string minLength: 1 maxLength: 64 accountNumber: type: string minLength: 1 maxLength: 34 documentType: type: string minLength: 1 maxLength: 32 documentNumber: type: string minLength: 1 maxLength: 64 email: type: string format: email bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: CO required: - bankCode - accountNumber - documentType - documentNumber - email - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - pse currency: type: string minLength: 3 maxLength: 3 details: type: object properties: bankCode: type: string minLength: 1 maxLength: 64 accountNumber: type: string minLength: 1 maxLength: 34 documentType: type: string minLength: 1 maxLength: 32 documentNumber: type: string minLength: 1 maxLength: 64 email: type: string format: email bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 default: CO required: - bankCode - accountNumber - documentType - documentNumber - email - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - transfers_3_0 currency: type: string minLength: 3 maxLength: 3 details: type: object properties: cbu: type: string minLength: 22 maxLength: 22 alias: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 taxId: type: string minLength: 1 maxLength: 64 country: type: string minLength: 2 maxLength: 2 default: AR required: - cbu - accountHolderName additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - transfers_3_0 currency: type: string minLength: 3 maxLength: 3 details: type: object properties: cbu: type: string minLength: 22 maxLength: 22 alias: type: string minLength: 1 maxLength: 255 bankName: type: string minLength: 1 maxLength: 255 accountHolderName: type: string minLength: 1 maxLength: 255 taxId: type: string minLength: 1 maxLength: 64 country: type: string minLength: 2 maxLength: 2 default: AR required: - cbu - accountHolderName additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - details - status additionalProperties: false - anyOf: - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wallet currency: type: string minLength: 2 maxLength: 10 ownership: anyOf: - type: object properties: type: enum: - self_custodied required: - type additionalProperties: false - type: object properties: type: enum: - custodial custodianName: type: string minLength: 1 maxLength: 255 required: - type - custodianName additionalProperties: false details: type: object properties: network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche address: type: string minLength: 1 maxLength: 255 label: type: string maxLength: 255 required: - network - address additionalProperties: false status: description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. enum: - action_required statusReason: 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 description: >- Why this destination requires action. Present exactly when status is action_required; omitted otherwise. required: - id - createdAt - updatedAt - archivedAt - type - currency - ownership - details - status - statusReason additionalProperties: false - type: object properties: id: type: string label: type: string createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true type: description: >- Recipient destination type. Closed enum — exhaustive; additions would be a breaking change. enum: - wallet currency: type: string minLength: 2 maxLength: 10 ownership: anyOf: - type: object properties: type: enum: - self_custodied required: - type additionalProperties: false - type: object properties: type: enum: - custodial custodianName: type: string minLength: 1 maxLength: 255 required: - type - custodianName additionalProperties: false details: type: object properties: network: enum: - polygon - ethereum - base - arbitrum - optimism - bsc - avalanche address: type: string minLength: 1 maxLength: 255 label: type: string maxLength: 255 required: - network - address additionalProperties: false status: enum: - in_review - ready - archived description: >- Destination status. `ready` means lifecycle checks passed. Ready bank destinations can be fiat quote targets when other quote checks pass; ready wallet destinations can be stablecoin-move targets when their network and currency match the source. Closed enum — exhaustive; additions would be a breaking change. required: - id - createdAt - updatedAt - archivedAt - type - currency - ownership - details - status additionalProperties: false required: - id - customerId - relationship - status - createdAt - updatedAt - archivedAt - type - companyName - destinations additionalProperties: false required: - data additionalProperties: false examples: business: value: data: id: rcp_9zK4pQ8rT2mA7sL1dV6x customerId: cus_uPlL04SqhMf8QYHcJV status: active type: business relationship: vendor companyName: Northwind Supplies LLC businessIndustry: '541511' email: finance@northwind.example address: streetLine1: 500 Market Street city: San Francisco state: CA postalCode: '94105' country: US label: Northwind vendor createdAt: '2026-06-25T12:00:00.000Z' updatedAt: '2026-06-25T12:00:00.000Z' archivedAt: null destinations: - id: dst_7mA9sL1kBc6dV8xN2pQ4rT type: ach currency: USD status: ready details: routingNumber: '021000021' accountNumber: '123456789' accountType: checking bankName: JPMorgan Chase accountHolderName: Jason Swipelux country: US createdAt: '2026-06-25T12:01:00.000Z' updatedAt: '2026-06-25T12:01:00.000Z' archivedAt: null '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: Resource 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. '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 - [Get recipient destination](/api-reference/recipients/get-v3-customers-by-customer-id-recipients-by-recipient-id-destinations-by-destination-id.md) - [Recipients and destinations](/integration/recipients.md) - [List recipients](/api-reference/recipients/get-v3-customers-by-customer-id-recipients.md) - [Update recipient](/api-reference/recipients/patch-v3-customers-by-customer-id-recipients-by-recipient-id.md) - [Archive recipient](/api-reference/recipients/delete-v3-customers-by-customer-id-recipients-by-recipient-id.md)