> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt
> Use this file to discover all available pages before exploring further.

# Complete bank account linking

> Completes the Plaid Link flow by exchanging the public token, retrieving account details, and storing the linked bank accounts.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/bank-accounts/link-complete
openapi: 3.0.3
info:
  title: Spritz Finance API
  version: 1.0.0
  description: API for the Spritz Finance platform with RFC 9457 error handling
servers:
  - url: https://platform.spritz.finance
    description: Production
  - url: https://sandbox.spritz.finance
    description: Sandbox
security: []
tags:
  - name: Users
    description: User management endpoints
  - name: Bank Accounts
    description: Manage bank accounts for off-ramp destinations
  - name: Bills
    description: Manage bill pay accounts
  - name: Cards
    description: Spritz-issued debit cards
  - name: Auto-Ramp Accounts
    description: Virtual bank accounts that automatically convert fiat deposits to crypto
  - name: Spritz App
    description: >-
      Endpoints used by the Spritz app and internal SDKs. Excluded from the
      public partner spec.
paths:
  /v1/bank-accounts/link-complete:
    post:
      tags:
        - Bank Accounts
      summary: Complete bank account linking
      description: >-
        Completes the Plaid Link flow by exchanging the public token, retrieving
        account details, and storing the linked bank accounts.
      operationId: postV1Bank-accountsLink-complete
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                publicToken:
                  description: Public token returned by Plaid Link on success
                  type: string
                accountIds:
                  minItems: 1
                  description: IDs of the accounts the user selected in Plaid Link
                  type: array
                  items:
                    type: string
                institutionId:
                  type: string
                institutionName:
                  type: string
              required:
                - publicToken
                - accountIds
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                publicToken:
                  description: Public token returned by Plaid Link on success
                  type: string
                accountIds:
                  minItems: 1
                  description: IDs of the accounts the user selected in Plaid Link
                  type: array
                  items:
                    type: string
                institutionId:
                  type: string
                institutionName:
                  type: string
              required:
                - publicToken
                - accountIds
          multipart/form-data:
            schema:
              type: object
              properties:
                publicToken:
                  description: Public token returned by Plaid Link on success
                  type: string
                accountIds:
                  minItems: 1
                  description: IDs of the accounts the user selected in Plaid Link
                  type: array
                  items:
                    type: string
                institutionId:
                  type: string
                institutionName:
                  type: string
              required:
                - publicToken
                - accountIds
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  bankAccounts:
                    description: Bank accounts linked by this Plaid Link completion.
                    type: array
                    items:
                      description: >-
                        Bank account details. The `type` field indicates the
                        account variant.
                      anyOf:
                        - description: US bank account response
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the bank account
                              type: string
                              example: ba_abc123
                            status:
                              description: Current status of the account
                              anyOf:
                                - type: string
                                  enum:
                                    - active
                                - type: string
                                  enum:
                                    - pending
                                - type: string
                                  enum:
                                    - inactive
                                - type: string
                                  enum:
                                    - rejected
                              example: active
                            statusReason:
                              description: >-
                                Why the account is not usable, or null when no
                                reason applies.
                              anyOf:
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_invalid
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_closed
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_blocked
                              example: account_invalid
                            accountHolderName:
                              description: Name of the account holder
                              type: string
                              example: John Doe
                            institution:
                              description: Financial institution details
                              type: object
                              properties:
                                name:
                                  description: Name of the financial institution
                                  type: string
                                  example: Chase
                                logo:
                                  description: URL to institution logo
                                  type: string
                                  example: https://example.com/chase-logo.png
                              required:
                                - name
                            supportedRails:
                              description: Payment rails available for this account
                              type: array
                              items:
                                description: >-
                                  Fiat delivery rail.


                                  - `ach_standard`: ACH bank transfer, next
                                  business day.

                                  - `ach_same_day`: ACH same-day transfer,
                                  delivered same business day.

                                  - `rtp`: Real-time payment, seconds, 24/7.

                                  - `wire`: Wire transfer, same/next day.

                                  - `eft`: Electronic funds transfer, 1-2
                                  business days.

                                  - `sepa`: SEPA transfer (EU), 1-2 business
                                  days.

                                  - `faster_payments`: UK Faster Payments,
                                  near-instant.

                                  - `push_to_card`: Push to debit card, minutes.

                                  - `bill_pay`: Bill payment rail.

                                  - `card_deposit`: Deposit to crypto card.
                                anyOf:
                                  - type: string
                                    enum:
                                      - ach_standard
                                  - type: string
                                    enum:
                                      - ach_same_day
                                  - type: string
                                    enum:
                                      - rtp
                                  - type: string
                                    enum:
                                      - wire
                                  - type: string
                                    enum:
                                      - eft
                                  - type: string
                                    enum:
                                      - sepa
                                  - type: string
                                    enum:
                                      - faster_payments
                                  - type: string
                                    enum:
                                      - push_to_card
                                  - type: string
                                    enum:
                                      - bill_pay
                                  - type: string
                                    enum:
                                      - card_deposit
                                example: ach_standard
                              example:
                                - ach_standard
                                - rtp
                            label:
                              description: Friendly name for the account
                              type: string
                              example: Primary Checking
                            createdAt:
                              description: When the account was created
                              format: date-time
                              type: string
                            fundingSourceId:
                              type: string
                              description: >-
                                Associated opaque public funding source
                                identifier, or null when no funding source
                                exists for this bank account.
                              nullable: true
                            type:
                              type: string
                              enum:
                                - us
                            currency:
                              type: string
                              enum:
                                - USD
                            accountNumberLast4:
                              description: Last 4 digits of account number
                              type: string
                              example: '6789'
                            routingNumberLast4:
                              description: Last 4 digits of routing number
                              type: string
                              example: '0021'
                            accountSubtype:
                              description: Type of bank account (checking or savings)
                              anyOf:
                                - type: string
                                  enum:
                                    - checking
                                - type: string
                                  enum:
                                    - savings
                              example: checking
                          required:
                            - id
                            - status
                            - statusReason
                            - accountHolderName
                            - supportedRails
                            - createdAt
                            - fundingSourceId
                            - type
                            - currency
                            - accountNumberLast4
                            - routingNumberLast4
                        - description: Canadian bank account response
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the bank account
                              type: string
                              example: ba_abc123
                            status:
                              description: Current status of the account
                              anyOf:
                                - type: string
                                  enum:
                                    - active
                                - type: string
                                  enum:
                                    - pending
                                - type: string
                                  enum:
                                    - inactive
                                - type: string
                                  enum:
                                    - rejected
                              example: active
                            statusReason:
                              description: >-
                                Why the account is not usable, or null when no
                                reason applies.
                              anyOf:
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_invalid
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_closed
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_blocked
                              example: account_invalid
                            accountHolderName:
                              description: Name of the account holder
                              type: string
                              example: John Doe
                            institution:
                              description: Financial institution details
                              type: object
                              properties:
                                name:
                                  description: Name of the financial institution
                                  type: string
                                  example: Chase
                                logo:
                                  description: URL to institution logo
                                  type: string
                                  example: https://example.com/chase-logo.png
                              required:
                                - name
                            supportedRails:
                              description: Payment rails available for this account
                              type: array
                              items:
                                description: >-
                                  Fiat delivery rail.


                                  - `ach_standard`: ACH bank transfer, next
                                  business day.

                                  - `ach_same_day`: ACH same-day transfer,
                                  delivered same business day.

                                  - `rtp`: Real-time payment, seconds, 24/7.

                                  - `wire`: Wire transfer, same/next day.

                                  - `eft`: Electronic funds transfer, 1-2
                                  business days.

                                  - `sepa`: SEPA transfer (EU), 1-2 business
                                  days.

                                  - `faster_payments`: UK Faster Payments,
                                  near-instant.

                                  - `push_to_card`: Push to debit card, minutes.

                                  - `bill_pay`: Bill payment rail.

                                  - `card_deposit`: Deposit to crypto card.
                                anyOf:
                                  - type: string
                                    enum:
                                      - ach_standard
                                  - type: string
                                    enum:
                                      - ach_same_day
                                  - type: string
                                    enum:
                                      - rtp
                                  - type: string
                                    enum:
                                      - wire
                                  - type: string
                                    enum:
                                      - eft
                                  - type: string
                                    enum:
                                      - sepa
                                  - type: string
                                    enum:
                                      - faster_payments
                                  - type: string
                                    enum:
                                      - push_to_card
                                  - type: string
                                    enum:
                                      - bill_pay
                                  - type: string
                                    enum:
                                      - card_deposit
                                example: ach_standard
                              example:
                                - ach_standard
                                - rtp
                            label:
                              description: Friendly name for the account
                              type: string
                              example: Primary Checking
                            createdAt:
                              description: When the account was created
                              format: date-time
                              type: string
                            fundingSourceId:
                              type: string
                              description: >-
                                Associated opaque public funding source
                                identifier, or null when no funding source
                                exists for this bank account.
                              nullable: true
                            type:
                              type: string
                              enum:
                                - ca
                            currency:
                              type: string
                              enum:
                                - CAD
                            accountNumberLast4:
                              description: Last 4 digits of account number
                              type: string
                              example: '4567'
                            institutionNumber:
                              description: 3-digit institution number
                              type: string
                              example: '001'
                            transitNumberLast3:
                              description: Last 3 digits of transit number
                              type: string
                              example: '345'
                            accountSubtype:
                              description: Type of bank account (checking or savings)
                              anyOf:
                                - type: string
                                  enum:
                                    - checking
                                - type: string
                                  enum:
                                    - savings
                              example: checking
                          required:
                            - id
                            - status
                            - statusReason
                            - accountHolderName
                            - supportedRails
                            - createdAt
                            - fundingSourceId
                            - type
                            - currency
                            - accountNumberLast4
                            - institutionNumber
                            - transitNumberLast3
                        - description: UK bank account response
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the bank account
                              type: string
                              example: ba_abc123
                            status:
                              description: Current status of the account
                              anyOf:
                                - type: string
                                  enum:
                                    - active
                                - type: string
                                  enum:
                                    - pending
                                - type: string
                                  enum:
                                    - inactive
                                - type: string
                                  enum:
                                    - rejected
                              example: active
                            statusReason:
                              description: >-
                                Why the account is not usable, or null when no
                                reason applies.
                              anyOf:
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_invalid
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_closed
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_blocked
                              example: account_invalid
                            accountHolderName:
                              description: Name of the account holder
                              type: string
                              example: John Doe
                            institution:
                              description: Financial institution details
                              type: object
                              properties:
                                name:
                                  description: Name of the financial institution
                                  type: string
                                  example: Chase
                                logo:
                                  description: URL to institution logo
                                  type: string
                                  example: https://example.com/chase-logo.png
                              required:
                                - name
                            supportedRails:
                              description: Payment rails available for this account
                              type: array
                              items:
                                description: >-
                                  Fiat delivery rail.


                                  - `ach_standard`: ACH bank transfer, next
                                  business day.

                                  - `ach_same_day`: ACH same-day transfer,
                                  delivered same business day.

                                  - `rtp`: Real-time payment, seconds, 24/7.

                                  - `wire`: Wire transfer, same/next day.

                                  - `eft`: Electronic funds transfer, 1-2
                                  business days.

                                  - `sepa`: SEPA transfer (EU), 1-2 business
                                  days.

                                  - `faster_payments`: UK Faster Payments,
                                  near-instant.

                                  - `push_to_card`: Push to debit card, minutes.

                                  - `bill_pay`: Bill payment rail.

                                  - `card_deposit`: Deposit to crypto card.
                                anyOf:
                                  - type: string
                                    enum:
                                      - ach_standard
                                  - type: string
                                    enum:
                                      - ach_same_day
                                  - type: string
                                    enum:
                                      - rtp
                                  - type: string
                                    enum:
                                      - wire
                                  - type: string
                                    enum:
                                      - eft
                                  - type: string
                                    enum:
                                      - sepa
                                  - type: string
                                    enum:
                                      - faster_payments
                                  - type: string
                                    enum:
                                      - push_to_card
                                  - type: string
                                    enum:
                                      - bill_pay
                                  - type: string
                                    enum:
                                      - card_deposit
                                example: ach_standard
                              example:
                                - ach_standard
                                - rtp
                            label:
                              description: Friendly name for the account
                              type: string
                              example: Primary Checking
                            createdAt:
                              description: When the account was created
                              format: date-time
                              type: string
                            fundingSourceId:
                              type: string
                              description: >-
                                Associated opaque public funding source
                                identifier, or null when no funding source
                                exists for this bank account.
                              nullable: true
                            type:
                              type: string
                              enum:
                                - uk
                            currency:
                              type: string
                              enum:
                                - GBP
                            accountNumberLast4:
                              description: Last 4 digits of account number
                              type: string
                              example: '2345'
                            sortCode:
                              description: 6-digit sort code (not sensitive)
                              type: string
                              example: '108800'
                          required:
                            - id
                            - status
                            - statusReason
                            - accountHolderName
                            - supportedRails
                            - createdAt
                            - fundingSourceId
                            - type
                            - currency
                            - accountNumberLast4
                            - sortCode
                        - description: IBAN bank account response
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the bank account
                              type: string
                              example: ba_abc123
                            status:
                              description: Current status of the account
                              anyOf:
                                - type: string
                                  enum:
                                    - active
                                - type: string
                                  enum:
                                    - pending
                                - type: string
                                  enum:
                                    - inactive
                                - type: string
                                  enum:
                                    - rejected
                              example: active
                            statusReason:
                              description: >-
                                Why the account is not usable, or null when no
                                reason applies.
                              anyOf:
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_invalid
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_closed
                                - type: string
                                  nullable: true
                                  enum:
                                    - account_blocked
                              example: account_invalid
                            accountHolderName:
                              description: Name of the account holder
                              type: string
                              example: John Doe
                            institution:
                              description: Financial institution details
                              type: object
                              properties:
                                name:
                                  description: Name of the financial institution
                                  type: string
                                  example: Chase
                                logo:
                                  description: URL to institution logo
                                  type: string
                                  example: https://example.com/chase-logo.png
                              required:
                                - name
                            supportedRails:
                              description: Payment rails available for this account
                              type: array
                              items:
                                description: >-
                                  Fiat delivery rail.


                                  - `ach_standard`: ACH bank transfer, next
                                  business day.

                                  - `ach_same_day`: ACH same-day transfer,
                                  delivered same business day.

                                  - `rtp`: Real-time payment, seconds, 24/7.

                                  - `wire`: Wire transfer, same/next day.

                                  - `eft`: Electronic funds transfer, 1-2
                                  business days.

                                  - `sepa`: SEPA transfer (EU), 1-2 business
                                  days.

                                  - `faster_payments`: UK Faster Payments,
                                  near-instant.

                                  - `push_to_card`: Push to debit card, minutes.

                                  - `bill_pay`: Bill payment rail.

                                  - `card_deposit`: Deposit to crypto card.
                                anyOf:
                                  - type: string
                                    enum:
                                      - ach_standard
                                  - type: string
                                    enum:
                                      - ach_same_day
                                  - type: string
                                    enum:
                                      - rtp
                                  - type: string
                                    enum:
                                      - wire
                                  - type: string
                                    enum:
                                      - eft
                                  - type: string
                                    enum:
                                      - sepa
                                  - type: string
                                    enum:
                                      - faster_payments
                                  - type: string
                                    enum:
                                      - push_to_card
                                  - type: string
                                    enum:
                                      - bill_pay
                                  - type: string
                                    enum:
                                      - card_deposit
                                example: ach_standard
                              example:
                                - ach_standard
                                - rtp
                            label:
                              description: Friendly name for the account
                              type: string
                              example: Primary Checking
                            createdAt:
                              description: When the account was created
                              format: date-time
                              type: string
                            fundingSourceId:
                              type: string
                              description: >-
                                Associated opaque public funding source
                                identifier, or null when no funding source
                                exists for this bank account.
                              nullable: true
                            type:
                              type: string
                              enum:
                                - iban
                            currency:
                              description: Fiat currency code
                              anyOf:
                                - type: string
                                  enum:
                                    - USD
                                - type: string
                                  enum:
                                    - CAD
                                - type: string
                                  enum:
                                    - EUR
                                - type: string
                                  enum:
                                    - GBP
                              example: USD
                            ibanLast4:
                              description: Last 4 characters of IBAN
                              type: string
                              example: '3000'
                            bic:
                              description: Bank Identifier Code
                              type: string
                              example: COBADEFFXXX
                          required:
                            - id
                            - status
                            - statusReason
                            - accountHolderName
                            - supportedRails
                            - createdAt
                            - fundingSourceId
                            - type
                            - currency
                            - ibanLast4
                required:
                  - bankAccounts
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 401
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                    example: Bearer token required
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  realm:
                    description: The authentication realm
                    type: string
                    example: API
                  scope:
                    description: The required scope for this resource
                    type: string
                    example: read:users
                required:
                  - title
                  - status
                additionalProperties: false
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 400
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                    example: /errors/1234567890
                  code:
                    description: >-
                      Machine-readable cause, present when exactly one thing
                      failed. Branch on this, never on `detail`, which is
                      human-facing copy and may change. For deposit limits the
                      vocabulary matches the `reason` values the limits API
                      returns pre-flight.
                    type: string
                    example: transaction_limit
                  field:
                    description: The offending request field, present alongside `code`.
                    type: string
                    example: amountUsd
                  retryable:
                    description: >-
                      Whether retrying the same request later may succeed
                      without changing its inputs.
                    type: boolean
                    example: true
                required:
                  - title
                  - status
                additionalProperties: false
      security:
        - bearerAuth: []
        - integratorJwt: []
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication
    integratorJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Integrator JWT token (prefix: spr_) for frontend integrator
        authentication. Obtained via token exchange endpoint.
    hmacAuth:
      type: apiKey
      in: header
      name: X-Signature
      description: >-
        HMAC signature authentication for backend integrators.


        **Required Headers:**

        - X-Integrator-Key: Integrator API key (format: int_...)

        - X-Signature: HMAC signature (format: sha256={hex})

        - X-Timestamp: Unix timestamp in milliseconds

        - Authorization: Bearer {user-api-key}


        **Signature Algorithm:** HMAC-SHA256


        **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}

        - timestamp: Unix timestamp in milliseconds

        - METHOD: HTTP method in UPPERCASE (GET, POST, etc.)

        - path: Request path (e.g., /v1/transactions)

        - bodyHash: SHA256 hex digest of request body (empty string if no body)


        **Timestamp Tolerance:** ±5 minutes (300 seconds)


        **Example:**

        For POST /v1/transactions with body {"amount":100} and timestamp
        1234567890000:

        Payload: 1234567890000.POST./v1/transactions.{sha256(body)}

        Signature: sha256=abc123...
    integratorKey:
      type: apiKey
      in: header
      name: X-Integrator-Key
      description: 'Integrator API key (format: int_...) used with HMAC authentication'
    timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: >-
        Unix timestamp in milliseconds for replay attack prevention. Must be
        within 5 minutes of server time.

````