Slash Fdx API

openapi: 3.1.0
info:
  title: Slash Public Account Fdx API
  description: API description
  version: 0.0.1
  contact: {}
servers:
- url: https://api.slash.com
  description: production
security:
- api_key: []
- partner_api_key: []
- bearer: []
- developer_application: []
tags:
- name: Fdx
paths:
  /fdx/customers/current:
    x-reference-path: paths/fdx/customers/current/route.yaml
    get:
      description: Get current authenticated customer ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  customerId:
                    type: string
                required:
                - customerId
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts:
    x-reference-path: paths/fdx/accounts/route.yaml
    get:
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: The number of items to skip before starting to collect the result set
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: The number of items to return (default 100, max 1000)
      description: List all accounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: object
                    properties:
                      nextOffset:
                        type: string
                  accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/paths.fdx.accounts._dto.Account'
                      x-entrypoint:
                        virtualPath: paths/fdx/accounts/_dto/Account
                        sourcePath: paths/fdx/accounts/_dto/Account.yaml
                        title: Account
                        origin: ./src/publicApi
                required:
                - accounts
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}:
    x-reference-path: paths/fdx/accounts/{accountId}/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      description: Get account balances and liabilities
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paths.fdx.accounts._dto.AccountWithBalance'
                x-entrypoint:
                  virtualPath: paths/fdx/accounts/_dto/AccountWithBalance
                  sourcePath: paths/fdx/accounts/_dto/AccountWithBalance.yaml
                  title: AccountWithBalance
                  origin: ./src/publicApi
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}/contact:
    x-reference-path: paths/fdx/accounts/{accountId}/contact/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      description: Get an account's contact information
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  holders:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: object
                          properties:
                            first:
                              type: string
                            middle:
                              type: string
                            last:
                              type: string
                            suffix:
                              type: string
                            prefix:
                              type: string
                          required:
                          - first
                          - middle
                          - last
                      required:
                      - name
                      - relationship
                  emails:
                    type: array
                    items:
                      type: string
                  addresses:
                    type: array
                    items:
                      type: object
                      properties:
                        line1:
                          type: string
                        line2:
                          type: string
                        line3:
                          type: string
                        city:
                          type: string
                        region:
                          type: string
                          description: State or province or territory.
                        postalCode:
                          type: string
                        country:
                          type: string
                          description: Iso3166CountryCode
                      required:
                      - line1
                      - line2
                      - city
                      - country
                  telephones:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - HOME
                          - BUSINESS
                          - CELL
                          - FAX
                        country:
                          type: string
                          description: Country calling codes defined by ITU-T recommendations E.123 and E.164
                        number:
                          type: string
                          description: Telephone subscriber number defined by ITU-T recommendation E.164
                      required:
                      - type
                      - number
                required:
                - holders
                - emails
                - addresses
                - telephones
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}/statements:
    x-reference-path: paths/fdx/accounts/{accountId}/statements/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      - name: startTime
        in: query
        required: false
        schema:
          type: string
        description: Start time for use in retrieval of statements (ISO 8601).
      - name: endTime
        in: query
        required: false
        schema:
          type: string
        description: End time for use in retrieval of statements (ISO 8601).
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: The ID of the last item in the previous page of results
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: The number of items to return (default 100, max 1000)
      description: Search for statements
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: object
                    properties:
                      nextOffset:
                        type: string
                  statements:
                    type: array
                    items:
                      type: object
                      properties:
                        accountId:
                          type: string
                          description: Long-term persistent identity of the account, though not an account number.
                        statementId:
                          type: string
                          description: Long-term persistent identity of the statement.
                        statementDate:
                          type: string
                          description: The date of the statement.
                        description:
                          type: string
                          description: A description of the statement.
                        links:
                          type: array
                          description: Will only contain one element, which is a link to the /accounts/{accountId}/statements/{statementId} endpoint.
                          items:
                            type: object
                            properties:
                              href:
                                type: string
                              rel:
                                type: string
                              action:
                                type: string
                                enum:
                                - GET
                              types:
                                type: array
                                items:
                                  type: string
                                  enum:
                                  - application/pdf
                            required:
                            - href
                        status:
                          type: string
                          enum:
                          - AVAILABLE
                          - PROCESSING
                          - FAILED
                      required:
                      - accountId
                      - statementId
                      - statementDate
                      - description
                      - links
                      - status
                required:
                - statements
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}/statements/{statementId}:
    x-reference-path: paths/fdx/accounts/{accountId}/statements/{statementId}/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      - name: statementId
        in: path
        required: true
        schema:
          type: string
        description: Statement ID returned by /accounts/{accountId}/statements
      description: Get account statement PDF.
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}/transactions:
    x-reference-path: paths/fdx/accounts/{accountId}/transactions/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      - name: startTime
        in: query
        required: false
        schema:
          type: string
        description: Start time for use in retrieval of transactions (ISO 8601).
      - name: endTime
        in: query
        required: false
        schema:
          type: string
        description: End time for use in retrieval of transactions (ISO 8601).
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: The ID of the last item in the previous page of results
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: The number of items to return (default 100, max 1000)
      description: Search for transactions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: object
                    properties:
                      nextOffset:
                        type: string
                  transactions:
                    type: array
                    items:
                      oneOf:
                      - type: object
                        properties:
                          depositTransaction:
                            $ref: '#/components/schemas/paths.fdx.accounts._param_accountId.transactions._dto.DepositTransaction'
                            x-entrypoint:
                              virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/DepositTransaction
                              sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/DepositTransaction.yaml
                              title: DepositTransaction
                              origin: ./src/publicApi
                        required:
                        - depositTransaction
                      - type: object
                        properties:
                          loanTransaction:
                            $ref: '#/components/schemas/paths.fdx.accounts._param_accountId.transactions._dto.LoanTransaction'
                            x-entrypoint:
                              virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/LoanTransaction
                              sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/LoanTransaction.yaml
                              title: LoanTransaction
                              origin: ./src/publicApi
                        required:
                        - loanTransaction
                      - type: object
                        properties:
                          locTransaction:
                            $ref: '#/components/schemas/paths.fdx.accounts._param_accountId.transactions._dto.LineOfCreditTransaction'
                            x-entrypoint:
                              virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/LineOfCreditTransaction
                              sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/LineOfCreditTransaction.yaml
                              title: LineOfCreditTransaction
                              origin: ./src/publicApi
                        required:
                        - locTransaction
                      - type: object
                        properties:
                          investmentTransaction:
                            $ref: '#/components/schemas/paths.fdx.accounts._param_accountId.transactions._dto.InvestmentTransaction'
                            x-entrypoint:
                              virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/InvestmentTransaction
                              sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/InvestmentTransaction.yaml
                              title: InvestmentTransaction
                              origin: ./src/publicApi
                        required:
                        - investmentTransaction
                required:
                - transactions
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
  /fdx/accounts/{accountId}/payment-networks:
    x-reference-path: paths/fdx/accounts/{accountId}/payment-networks/route.yaml
    get:
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
        description: Account ID
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: The ID of the last item in the previous page of results
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: The number of items to return (default 100, max 1000)
      description: Get payment networks supported by the account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: object
                    properties:
                      nextOffset:
                        type: string
                  paymentNetworks:
                    type: array
                    items:
                      type: object
                      properties:
                        bankId:
                          type: string
                          description: Bank identifier used by the payment network ie. Routing Number
                        identifier:
                          type: string
                          description: The number used to identify the account within the payment network.
                        type:
                          type: string
                          enum:
                          - US_ACH
                          - US_FEDWIRE
                          - US_CHIPS
                          - US_RTP
                          - CA_ACSS
                          - CA_LVTS
                        transferIn:
                          type: boolean
                          description: Indicates if the account can receive transfers from the payment network. If the account is closed or locked, this will be false.
                        transferOut:
                          type: boolean
                          description: Indicates if the account can send transfers to the payment network. If the account is closed or locked, this will be false.
                      required:
                      - bankId
                      - identifier
                      - type
                      - transferIn
                      - transferOut
                required:
                - paymentNetworks
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Fdx
components:
  schemas:
    paths.fdx.accounts._dto.InsuranceAccount:
      type: object
      description: An insurance account. For example, whole life insurance or short-term disability.
      properties:
        accountId:
          type: string
          description: Long-term persistent identity of the account, though not an account number.
        accountNumberDisplay:
          type: string
          description: A masked version of the account number, which includes the last 4 digits in plain text.
        productName:
          type: string
          description: Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum".
        nickname:
          type: string
          description: A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection.
        status:
          type: string
          enum:
          - CLOSED
          - DELINQUENT
          - NEGATIVECURRENTBALANCE
          - OPEN
          - PAID
          - PENDINGCLOSE
          - PENDINGOPEN
          - RESTRICTED
        currency:
          type: object
          properties:
            currencyCode:
              type: string
              description: The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars.
          required:
          - currencyCode
        accountType:
          type: string
          enum:
          - LONGTERMDISABILITY
          - SHORTTERMDISABILITY
          - UNIVERSALLIFE
          - WHOLELIFE
      required:
      - accountId
      - productName
      - status
      - currency
      - accountType
      x-entrypoint:
        virtualPath: paths/fdx/accounts/_dto/InsuranceAccount
        sourcePath: paths/fdx/accounts/_dto/InsuranceAccount.yaml
        title: InsuranceAccount
        origin: ./src/publicApi
      title: InsuranceAccount
    paths.fdx.accounts._dto.InvestmentAccount:
      type: object
      description: An investment account. For example, a 401K or IRA.
      properties:
        accountId:
          type: string
          description: Long-term persistent identity of the account, though not an account number.
        accountNumberDisplay:
          type: string
          description: A masked version of the account number, which includes the last 4 digits in plain text.
        productName:
          type: string
          description: Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum".
        nickname:
          type: string
          description: A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection.
        status:
          type: string
          enum:
          - CLOSED
          - DELINQUENT
          - NEGATIVECURRENTBALANCE
          - OPEN
          - PAID
          - PENDINGCLOSE
          - PENDINGOPEN
          - RESTRICTED
        currency:
          type: object
          properties:
            currencyCode:
              type: string
              description: The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars.
          required:
          - currencyCode
        accountType:
          type: string
          enum:
          - 401A
          - 401K
          - 403B
          - '529'
          - BROKERAGEPRODUCT
          - COVERDELL
          - DIGITALASSET
          - DEFINEDBENEFIT
          - ESOP
          - GUARDIAN
          - INSTITUTIONALTRUST
          - IRA
          - KEOGH
          - NONQUALIFIEDPLAN
          - OTHERINVESTMENT
          - ROLLOVER
          - ROTH
          - SARSEP
          - TAXABLE
          - TDA
          - TRUST
          - TERM
          - UGMA
          - UTMA
      required:
      - accountId
      - productName
      - status
      - currency
      - accountType
      x-entrypoint:
        virtualPath: paths/fdx/accounts/_dto/InvestmentAccount
        sourcePath: paths/fdx/accounts/_dto/InvestmentAccount.yaml
        title: InvestmentAccount
        origin: ./src/publicApi
      title: InvestmentAccount
    paths.fdx.accounts._param_accountId.transactions._dto.LoanTransaction:
      type: object
      properties:
        transactionId:
          type: string
          description: Long-term persistent identity of the transaction.
        referenceTransactionId:
          type: string
          description: For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction
        postedTimestamp:
          type: string
          description: The ISO 8601 date and time that the transaction was posted to the account. This will be included if status is POSTED.
        transactionTimestamp:
          type: string
          description: The ISO 8601 date and time that the transaction was initiated.
        description:
          type: string
          description: A description of the transaction.
        debitCreditMemo:
          type: string
          description: The posting type of a transaction. The transaction amount is an absolute value, and this parameter indicates the direction of the transaction. This will always be DEBIT or CREDIT.
          enum:
          - DEBIT
          - CREDIT
          - MEMO
        category:
          type: string
          description: The merchant category code (MCC) of the transaction, if available.
        subCategory:
          type: string
          description: Additional information about the transaction category, if available.
        status:
          type: string
          description: The status of the transaction. This will always be PENDING or POSTED.
          enum:
          - AUTHORIZATION
          - MEMO
          - PENDING
          - POSTED
        amount:
          type: number
          description: The amount of money in the account currency in that currency's standard unit (e.g. dollars for USD). The amount is an absolute value. The debitCreditMemo parameter indicates the direction of the transaction.
        foreignAmount:
          type: number
          description: This value is only included if the transaction's currency is different than the account's default currency.
        foreignCurrency:
          $ref: '#/components/schemas/paths.fdx.accounts._param_accountId.transactions._dto.Iso4217CurrencyCode'
          description: ISO 4217 currency code. This value is only included if the transaction's currency is different than the account's default currency.
          x-entrypoint:
            virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/Iso4217CurrencyCode
            sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/Iso4217CurrencyCode.yaml
            title: Iso4217CurrencyCode
            origin: ./src/publicApi
        transactionType:
          type: string
          enum:
          - ADJUSTMENT
          - FEE
          - INTEREST
          - PAYMENT
          - LUMP_SUM_PAYMENT
          - SKIP_PAYMENT
          - DOUBLE_UP_PAYMENT
          - PAYOFF
      required:
      - transactionId
      - transactionTimestamp
      - description
      - debitCreditMemo
      - status
      - amount
      x-entrypoint:
        virtualPath: paths/fdx/accounts/{accountId}/transactions/_dto/LoanTransaction
        sourcePath: paths/fdx/accounts/{accountId}/transactions/_dto/LoanTransaction.yaml
        title: LoanTransaction
        origin: ./src/publicApi
      title: LoanTransaction
    Error:
      type: object
      properties:
        message:
          type: string
        name:
          type: string
        identifier:
          type: string
        rawStatus:
          type: number
        meta:
          type: object
          additionalProperties: true
      required:
      - message
      - name
      - identifier
      - rawStatus
      x-entrypoint:
        origin: ./src/publicApi
        sourcePath: ./src/publicApi/main.yaml
        title: Error
        virtualPath: components/Error
      title: Error
    paths.fdx.accounts._dto.LineOfCreditAccount:
      type: object
      description: A line-of-credit account. For example, a credit card or home equity line of credit.
      properties:
        accountId:
          type: string
          description: Long-term persistent identity of the account, though not an account number.
        accountNumberDisplay:
          type: string
          description: A maske

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/slash/refs/heads/main/openapi/slash-fdx-api-openapi.yml