Narmi

Narmi swift wire templates API

The swift wire templates API from Narmi — 2 operation(s) for swift wire templates.

GitHub OpenAPI
Business capability
Cross-Border Payment Management BC-1340.40

Operations 6

GET /v1/swiftwire_templates/ List Swift Wire templates #
POST /v1/swiftwire_templates/ Create a Swift Wire template #
GET /v1/swiftwire_templates/{uuid}/ Retrieve a Swift Wire template #
PUT /v1/swiftwire_templates/{uuid}/ Update a Swift Wire template #
PATCH /v1/swiftwire_templates/{uuid}/ Update a Swift Wire template #
DELETE /v1/swiftwire_templates/{uuid}/ Delete a Swift Wire template #

Documentation

📖
Documentation
https://docs.narmi.com/docs/narmi-developer-docs/xl9dvbz84o11l-introduction
📖
APIReference
https://docs.narmi.com/docs/narmi-developer-docs/68n444msv6n7x-narmi-public-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/narmi/refs/heads/main/openapi/narmi-swift-wire-templates-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/narmi/refs/heads/main/json-schema/narmi-swift-wire-template-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/narmi/refs/heads/main/json-schema/narmi-swift-wire-template-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/narmi/refs/heads/main/json-schema/narmi-patched-swift-wire-template-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/narmi/refs/heads/main/json-schema/narmi-paginated-swift-wire-template-list-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/narmi:narmi-swift-wire-templates-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

narmi-swift-wire-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Narmi Public swift wire templates API
  version: v1
  description: To read about Public API access and authentication, go to API Overview.
  termsOfService: https://www.narmi.com/policies/developer-terms-conditions
  contact:
    name: Narmi Support
    email: support@narmi.com
servers:
- url: https://api.sandbox.narmi.dev/
  description: ''
tags:
- name: swift wire templates
paths:
  /v1/swiftwire_templates/:
    get:
      operationId: swiftwire_templates_list
      description: 'List a user''s Swift Wire templates for their organization.


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: List Swift Wire templates
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      tags:
      - swift wire templates
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSwiftWireTemplateList'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
      x-stoplight:
        id: oncewf4esgpmy
    post:
      operationId: swiftwire_templates_create
      description: 'Create a template that can be used to send Swift Wire transfers.


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: Create a Swift Wire template
      tags:
      - swift wire templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftWireTemplate'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
          description: ''
      x-stoplight:
        id: szdmfwibfdqan
  /v1/swiftwire_templates/{uuid}/:
    get:
      operationId: swiftwire_templates_retrieve
      description: 'Fetch details for a specified template.


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: Retrieve a Swift Wire template
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - swift wire templates
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftWireTemplate'
          description: ''
      x-stoplight:
        id: xmeztif6y4vwz
    put:
      operationId: swiftwire_templates_update
      description: 'Update the details of a template belonging to authenticated user, identified by `uuid`


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: Update a Swift Wire template
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - swift wire templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SwiftWireTemplateRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftWireTemplate'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
          description: ''
      x-stoplight:
        id: a8rekvafizz8t
    patch:
      operationId: swiftwire_templates_partial_update
      description: 'Update the details of a template belonging to authenticated user, identified by `uuid`


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: Update a Swift Wire template
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - swift wire templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSwiftWireTemplateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSwiftWireTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSwiftWireTemplateRequest'
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftWireTemplate'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
          description: ''
      x-stoplight:
        id: sregk9dty6vnc
    delete:
      operationId: swiftwire_templates_destroy
      description: 'Delete a specified Swift Wire template belonging to the user. The template will continue to exist in the database, but won''t be retrievable by the user. The name of the deleted template will be available for use in creating a new template.


        All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.


        How can we improve these docs? Share your feedback.'
      summary: Delete a Swift Wire template
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - swift wire templates
      security:
      - oauth2:
        - write
      responses:
        '204':
          description: No response body
      x-stoplight:
        id: dba72yw8y894w
components:
  schemas:
    PaginatedSwiftWireTemplateList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/SwiftWireTemplate'
      x-stoplight:
        id: xgc9i9azikswf
    NotFoundError:
      type: object
      properties:
        id:
          type: string
          default: not_found
        message:
          type: string
          description: An error response detailing the nature of the error.
      required:
      - message
      x-stoplight:
        id: qazjpvfdteybw
    GeneralError:
      type: object
      properties:
        id:
          type: string
          default: invalid
        message:
          type: string
          description: An error response detailing the field and the nature of the error.
      required:
      - message
      x-stoplight:
        id: v76fz3qxj5djb
    SwiftWireTemplateRequest:
      type: object
      properties:
        recipient:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the recipient for swiftwires sent using this template.
          type: string
          format: uuid
        from_account:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the source account for swiftwires sent using this template.
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 35
        wire_reason:
          type:
          - string
          - 'null'
        amount:
          example: 100
          maximum: 1000000000000000
          minimum: -1000000000000000
          description: A field that returns the original value in the currency's smallest unit (e.g. cents).
          type:
          - integer
          - 'null'
        amount_currency:
          type:
          - string
          - 'null'
          description: ISO 4217 currency code the amount is denominated in (e.g. 'USD' or the recipient's currency).
          maxLength: 3
        memo:
          type:
          - string
          - 'null'
          maxLength: 128
        note:
          type:
          - string
          - 'null'
        recipient_currency:
          type: string
          minLength: 1
          maxLength: 3
      required:
      - from_account
      - name
      - recipient
      x-stoplight:
        id: bnskmiqnavwxx
    PatchedSwiftWireTemplateRequest:
      type: object
      properties:
        recipient:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the recipient for swiftwires sent using this template.
          type: string
          format: uuid
        from_account:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the source account for swiftwires sent using this template.
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 35
        wire_reason:
          type:
          - string
          - 'null'
        amount:
          example: 100
          maximum: 1000000000000000
          minimum: -1000000000000000
          description: A field that returns the original value in the currency's smallest unit (e.g. cents).
          type:
          - integer
          - 'null'
        amount_currency:
          type:
          - string
          - 'null'
          description: ISO 4217 currency code the amount is denominated in (e.g. 'USD' or the recipient's currency).
          maxLength: 3
        memo:
          type:
          - string
          - 'null'
          maxLength: 128
        note:
          type:
          - string
          - 'null'
        recipient_currency:
          type: string
          minLength: 1
          maxLength: 3
      x-stoplight:
        id: dukgiedw1xvjv
    SwiftWireTemplate:
      type: object
      properties:
        last_used:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: Date when the template was last used to send a swiftwire.
        version_id:
          type: string
          readOnly: true
          description: The version ID of the template, based on when template or recipient details were last updated.
        id:
          type: string
          format: uuid
          readOnly: true
        recipient:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the recipient for swiftwires sent using this template.
          type: string
          format: uuid
        from_account:
          example: ccae3440-0c1f-45ce-9b91-57cbbb252818
          description: The UUID of the source account for swiftwires sent using this template.
          type: string
          format: uuid
        name:
          type: string
          maxLength: 35
        wire_reason:
          type:
          - string
          - 'null'
        amount:
          example: 100
          maximum: 1000000000000000
          minimum: -1000000000000000
          description: A field that returns the original value in the currency's smallest unit (e.g. cents).
          type:
          - integer
          - 'null'
        amount_currency:
          type:
          - string
          - 'null'
          description: ISO 4217 currency code the amount is denominated in (e.g. 'USD' or the recipient's currency).
          maxLength: 3
        memo:
          type:
          - string
          - 'null'
          maxLength: 128
        note:
          type:
          - string
          - 'null'
        recipient_currency:
          type: string
          maxLength: 3
      required:
      - from_account
      - name
      - recipient
      x-stoplight:
        id: k0d9pahpxnqko
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /v2/oauth/authorize/
          tokenUrl: /v2/oauth/token/
          scopes:
            banking:accounts:read: Can read account information.
            banking:transactions:read: Can read transaction information.
            banking:scheduled_transfers:read: Can read scheduled transfer information.
            banking:scheduled_transfers:write: Can create and update scheduled transfers.
            banking:accounts:write: Can update account information.
            banking:transactions:write: Can update transaction information.
            banking:users:read: Can read user profile information.
            banking:products:read: Can read product information.
            banking:documents:read: Can read user statements and documents.
x-stoplight:
  id: 68n444msv6n7x