Nacha Initiate Payment API

The Initiate Payment API from Nacha — 1 operation(s) for initiate payment.

Operations 1

POST /initiate Initiate Payment #

Documentation

📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Initiate_Payment/1.0.7
📖
Documentation
https://www.nacha.org/content/apis-development
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/IAR/1.0.1
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/IAR_Plus/1.0.1
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/transaction_status/1.0.14
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Initiate_Wire_Payment_API/1.0.3
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Get_Wire_Status_API/1.0.0
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Initiate_Instant_Payment_API/1.0.6
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Instant_Payment_Transfer/1.0.1
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Initiate_Payment_API/1.0.2
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/RET_API/1.0.3
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Authorize_To_Pay/1.0.6
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Pay_Me_API/1.0.11
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/account_validation/1.0.2
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Account_Validation_Plus_Ownership_API/1.1.0
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Account_Validation_Plus_Name_and_RET/1.0.4
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/RealTimeBillingAccountValidation/1.0.7
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Get_Corporate_Account_Balances_API/1.0.3
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Get_Corporate_Transaction_History_API/1.0.5
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Get_Transaction_Detail_API/1.0.4
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Payee_Profile_API/2.1.3
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Written_Statement_of_Unauthorized_Debit/1.0.8
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Proof_of_Authorization/1.0.6
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/bank_contacts/1.0.5
📖
APIReference
https://app.swaggerhub.com/apis/ASIG/Bank_Contact_V2/1.0.9

Specifications

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/nacha-initiate-payment-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.

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

OpenAPI Specification

nacha-initiate-payment-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.2
  title: Initiate Payment API
  description: Initiate Payment API is used to request movement of funds from the debtor account to a creditor
  contact:
    email: info@afinis.org
    url: https://www.afinis.org
servers:
- url: https://api.asig.org/payments/v1
tags:
- name: Initiate Payment
paths:
  /initiate:
    post:
      operationId: Initiate Payment
      tags:
      - Initiate Payment
      summary: Initiate Payment
      description: Initiate Payment
      responses:
        '200':
          description: Payment transactions RCVD
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response-200'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-400'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-404'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-405'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-406'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-415'
        '422':
          description: Unprocessable request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-422'
        '500':
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-503'
      security:
      - APIKeyQueryParam: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - creditor
              - creditorAccount
              - paymentIdentification
              - instructedAmount
              properties:
                initiatingParty:
                  $ref: '#/components/schemas/party'
                paymentInformationIdentification:
                  type: string
                  example: 1001ABCUSDO1_20181212
                  minLength: 1
                  maxLength: 140
                paymentTypeInformation:
                  $ref: '#/components/schemas/paymentTypeInformation'
                requestedExecutionDate:
                  format: date
                  example: '2018-12-12'
                  minLength: 10
                  maxLength: 10
                settlementTimeIndication:
                  format: date
                  example: '2018-12-12'
                  minLength: 10
                  maxLength: 10
                debtor:
                  $ref: '#/components/schemas/party'
                debtorAccount:
                  $ref: '#/components/schemas/account'
                debtorAgent:
                  $ref: '#/components/schemas/agent'
                ultimateDebtor:
                  $ref: '#/components/schemas/party'
                intermediaryAgent:
                  $ref: '#/components/schemas/agent'
                creditor:
                  $ref: '#/components/schemas/party'
                creditorAccount:
                  $ref: '#/components/schemas/account'
                creditorAgent:
                  $ref: '#/components/schemas/agent'
                ultimateCreditor:
                  $ref: '#/components/schemas/party'
                paymentIdentification:
                  $ref: '#/components/schemas/paymentIdentification'
                instructedAmount:
                  $ref: '#/components/schemas/amount'
                chargeBearer:
                  type: string
                  example: SLEV
                  minLength: 4
                  maxLength: 4
                  enum:
                  - DEBT
                  - CRED
                  - CHAR
                  - SLEV
                  description: "A programmatic code:\n  * DEBT - Charges borne by Debtor\n  * CRED - Charges borne by Creditor\n  * CHAR - Charges shared\n  * SLEV - Charges following Service Level            \n"
                paymentPurpose:
                  type: string
                  example: LOAN
                  minLength: 1
                  maxLength: 35
                relatedRemittanceInformation:
                  $ref: '#/components/schemas/remittanceLocation'
                remittanceInformation:
                  $ref: '#/components/schemas/remittanceInformation'
        description: Request movement of funds from the debtor account to a creditor
        required: true
components:
  schemas:
    amountAndType:
      title: AmountAndType
      type: array
      items:
        type: object
        properties:
          typeCode:
            type: string
            minLength: 1
            maxLength: 35
          amount:
            $ref: '#/components/schemas/amount'
    taxPeriod:
      title: Period
      type: object
      description: Party to which the tax applies.
      properties:
        year:
          type: string
          minLength: 4
          maxLength: 10
        type:
          type: string
          minLength: 4
          maxLength: 4
        taxType:
          type: string
          minLength: 1
          maxLength: 35
        fromDate:
          format: date
          minLength: 10
          maxLength: 10
        toDate:
          format: date
          minLength: 10
          maxLength: 10
    errorDetails-400:
      title: Error 400 - Bad Request - Details
      type: object
      properties:
        errorCode:
          description: "A programmatic error code:\n  * `2000` - Invalid JSON structure.\n  * `2001` - '[Field name] is missing or invalid.'\n  * `2002` - Invalid date.\n  * `2003` - Invalid combination of fields submitted. Check the API specification for eligible combinations. \n  * `2004` - '[Field name] cannot be more than [max number] characters.'\n  * `2005` - Insufficient information for ACH\n  * `2006` - Insufficient information for Wire\n  * `2007` - Insufficient information for Instant         \n"
          example: 2000
          type: number
          enum:
          - 2000
          - 2001
          - 2002
          - 2003
          - 2004
          - 2005
          - 2006
          - 2007
        message:
          description: A human readable description of the problem
          example: Invalid JSON structure.
          type: string
    error-401:
      title: Error 401 - Unauthorized
      description: Authentication failed or user doesn’t have permissions for requested operation
      type: object
      properties:
        details:
          description: error details
          type: array
          items:
            $ref: '#/components/schemas/errorDetails-401'
    error-405:
      title: Error 405 - Method Not Allowed
      description: The request method is known by the server but has been disabled and cannot be used.
      type: object
      required:
      - errorCode
      - message
      properties:
        errorCode:
          example: 405
          type: number
          enum:
          - 405
          description: "A programmatic error code:\n  * `405` - Method Not Allowed\n"
        message:
          description: A human readable description of the problem
          example: Method Not Allowed
          type: string
    party:
      title: Party
      type: object
      description: Identification of a person or an organisation
      properties:
        name:
          type: string
          example: Company ABC
          minLength: 1
          maxLength: 140
        identification:
          type: string
          example: '1234567891'
          minLength: 1
          maxLength: 35
        identificationCode:
          type: string
          example: CBID
          minLength: 4
          maxLength: 4
          enum:
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - CUST
          - DUNS
          - EMPL
          - GS1G
          - SREN
          - SRET
          - TXID
          - BDID
          - BOID
          - ARNU
          - CCPT
          - DRLC
          - NIDN
          - SOSE
          - TELE
          description: "A programmatic code:\n  * `BANK - Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n  * `CBID - A unique identification number assigned by a central bank to identify an organisation.\n  * `CHID - A unique identification number assigned by a clearing house to identify an organisation\n  * `CINC - A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n  * `COID - Country authority given organisation identification (e.g., corporate registration number)\n  * `DUNS - A unique identification number provided by Dun & Bradstreet to identify an organisation.\n  * `GS1G - Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n  * `SREN - The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n  * `SRET - The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n  * `ARNU - Number assigned by a social security agency to identify a non-resident person.\n  * `CCPT - Number assigned by an authority to identify the passport number of a person.\n  * `CUST - Number assigned by an issuer to identify a customer.\n  * `DRLC - Number assigned by an authority to identify a driver's license.\n  * `EMPL - Number assigned by a registration authority to an employee.\n  * `NIDN - Number assigned by an authority to identify the national identity number of a person.\n  * `SOSE - Number assigned by an authority to identify the social security number of a person.\n  * `TELE - Number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n  * `TXID - Number assigned by a tax authority to identify a person.\n"
        identificationCodeIssuer:
          type: string
          example: State of Missouri
          minLength: 1
          maxLength: 35
        postalAddress:
          $ref: '#/components/schemas/postalAddress'
    organisationIdentification:
      title: OrganisationIdentification
      type: object
      description: Identification of an organisation
      properties:
        anyBIC:
          type: string
          example: NDEAFIHH
          minLength: 8
          maxLength: 11
        lei:
          type: string
          minLength: 20
          maxLength: 20
        identification:
          type: string
          example: '1234567891'
          minLength: 1
          maxLength: 35
        identificationCode:
          type: string
          minLength: 4
          maxLength: 4
          enum:
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - CUST
          - DUNS
          - EMPL
          - GS1G
          - SREN
          - SRET
          - TXID
          - BDID
          - BOID
          description: "A programmatic code:\n  * BANK - BankPartyIdentification - Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n  * CBID - CentralBankIdentificationNumber - A unique identification number assigned by a central bank to identify an organisation.\n  * CHID - ClearingIdentificationNumber - A unique identification number assigned by a clearing house to identify an organisation\n  * CINC - CertificateOfIncorporationNumber - A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n  * COID - CountryIdentificationCode - Country authority given organisation identification (e.g., corporate registration number)\n  * CUST - CustomerNumber - Number assigned by an issuer to identify a customer. Number assigned by a party to identify a creditor or debtor relationship.\"\n  * DUNS - DataUniversalNumberingSystem - A unique identification number provided by Dun & Bradstreet to identify an organisation.\n  * EMPL - EmployerIdentificationNumber - Number assigned by a registration authority to an employer.\n  * GS1G - GS1GLNIdentifier - Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n  * SREN - SIREN - The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n  * SRET - SIRET - The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n  * TXID - TaxIdentificationNumber - Number assigned by a tax authority to identify an organisation.\n  * BDID - BusinessDomainIdentifier - Identifier of the business domain in which the organisation is active.\n  * BOID - BusinessOtherIdentification - Other identification of the organisation.\n"
        issuer:
          type: string
          minLength: 1
          maxLength: 35
    amountAndReason:
      title: AdjustmentAmountAndReason
      type: array
      items:
        type: object
        properties:
          amount:
            $ref: '#/components/schemas/amount'
          creditDebitIndicator:
            type: string
            minLength: 4
            maxLength: 4
            enum:
            - CRDT
            - DBIT
            description: "A programmatic code:\n  * `CRDT - Operation is an increase.\n  * `DBIT - Operation is a decrease.\n"
          reason:
            type: string
            minLength: 1
            maxLength: 4
          additionalInformation:
            type: string
            minLength: 1
            maxLength: 140
    remittanceLocation:
      title: RelatedRemittanceInformation
      type: object
      required:
      - remittanceIdentification
      - remittanceLocationMethod
      properties:
        remittanceIdentification:
          type: string
          minLength: 1
          maxLength: 35
        remittanceLocationMethod:
          type: string
          minLength: 4
          maxLength: 4
        remittanceElectronicAddress:
          type: string
          minLength: 1
          maxLength: 2048
        remittancePostalAddress:
          $ref: '#/components/schemas/postalAddress'
        remittancePostalAddressName:
          type: string
          minLength: 1
          maxLength: 70
    paymentIdentification:
      title: PaymentIdentification
      type: object
      required:
      - instructionIdentification
      properties:
        instructionIdentification:
          description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
          type: string
          example: ABC0928
          minLength: 1
          maxLength: 35
        endToEndIdentification:
          description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
          type: string
          example: ABC13609-15-18
          minLength: 1
          maxLength: 35
        uniqueEndToEndTransactionReference:
          type: string
          example: 8a562c67-ca16-48ba-b074-65581be6f011
          minLength: 36
          maxLength: 36
          pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}'
    postalAddress:
      title: PostalAddress
      description: Information that locates and identifies a specific address, as defined by postal services.
      type: object
      properties:
        addressType:
          type: string
          minLength: 4
          maxLength: 4
          example: ADDR
        department:
          type: string
          minLength: 1
          maxLength: 70
        subDepartment:
          type: string
          minLength: 1
          maxLength: 70
        streetName:
          description: Name of a street or throughfare
          type: string
          minLength: 1
          maxLength: 140
          example: Lexington Street
        buildingNumber:
          type: string
          minLength: 1
          maxLength: 16
        buildingName:
          type: string
          minLength: 1
          maxLength: 140
        unit:
          type: string
          minLength: 1
          maxLength: 70
        floor:
          type: string
          minLength: 1
          maxLength: 70
        postBox:
          type: string
          minLength: 1
          maxLength: 16
        room:
          type: string
          minLength: 1
          maxLength: 70
        postCode:
          description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
          type: string
          minLength: 1
          maxLength: 11
          example: 19801
        townName:
          description: Name of a built-up area, with defined boundaries, and a local government
          type: string
          minLength: 1
          maxLength: 35
          example: Wilmington
        townLocationName:
          type: string
          minLength: 1
          maxLength: 35
        districtName:
          type: string
          minLength: 1
          maxLength: 35
        countrySubDivision:
          description: Identifies a subdivision of a country such as state, region, county
          type: string
          minLength: 1
          maxLength: 35
          example: DE
        country:
          description: Nation with its own government
          type: string
          minLength: 2
          maxLength: 2
          example: US
        addressLine:
          type: string
          minLength: 1
          maxLength: 70
        careOf:
          type: string
          minLength: 1
          maxLength: 140
    error-503:
      title: Error 503 - Service Unavailable
      description: Service is temporarily unavailable
      type: object
      required:
      - errorCode
      - message
      properties:
        errorCode:
          example: 503
          type: number
          enum:
          - 503
          description: "A programmatic error code:\n  * `503` - Service Unavailable\n"
        message:
          description: A human readable description of the problem
          example: Service is temporarily unavailable.
          type: string
    unprocessableRequestErrorDetails:
      title: Unprocessable request Error Details
      type: object
      required:
      - errorCode
      - message
      properties:
        errorCode:
          example: 4001
          type: number
          enum:
          - 4001
          description: "A programmatic error code:\n  * `4001` - Unprocessable request due to \"%%\"\n"
        message:
          description: A human readable description of the problem
          example: Unprocessable request due to "%%"
          type: string
    taxRemittance:
      title: TaxRemittance
      type: object
      description: Provides remittance information about a payment made for tax-related purposes.
      properties:
        creditor:
          $ref: '#/components/schemas/taxParty'
        debtor:
          $ref: '#/components/schemas/taxParty'
        ultimateDebtor:
          $ref: '#/components/schemas/taxParty'
        administrationZone:
          type: string
          minLength: 1
          maxLength: 35
        referenceNumber:
          type: string
          minLength: 1
          maxLength: 140
        method:
          type: string
          minLength: 1
          maxLength: 35
        totalTaxableBaseAmount:
          $ref: '#/components/schemas/amount'
        totalTaxAmount:
          $ref: '#/components/schemas/amount'
        date:
          format: date
          minLength: 1
          maxLength: 35
        sequenceNumber:
          type: string
          minLength: 1
          maxLength: 35
        record:
          $ref: '#/components/schemas/taxRecord'
    error-400:
      title: Error 400 - Bad Request
      description: The request could not be understood or required parameters were missing
      type: object
      properties:
        details:
          description: error details
          type: array
          items:
            $ref: '#/components/schemas/errorDetails-400'
    error-415:
      title: Error 415 - Unsupported Media Type
      description: The media format of the requested data is not supported by the server, so the server is rejecting the request.
      type: object
      required:
      - errorCode
      - message
      properties:
        errorCode:
          example: 415
          type: number
          enum:
          - 415
          description: "A programmatic error code:\n  * `415` - Unsupported Media Type\n"
        message:
          description: A human readable description of the problem
          example: Unsupported Media Type
          type: string
    lineIdentification:
      title: lineIdentification
      type: array
      items:
        type: object
        description: Set of elements used to provide the content of the referred document line.
        properties:
          typeCode:
            type: string
            minLength: 1
            maxLength: 35
          typeIssuer:
            type: string
            minLength: 1
            maxLength: 35
          number:
            type: string
            minLength: 1
            maxLength: 35
          relatedDate:
            format: date
            example: '2021-08-13'
            minLength: 10
            maxLength: 10
    error-403:
      title: Error 403 - Forbidden
      description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the client's identity is known to the server.
      type: object
      required:
      - errorCode
      - message
      properties:
        errorCode:
          example: 403
          type: number
          enum:
          - 403
          description: "A programmatic error code:\n  * `403` - Forbidden\n"
        message:
          description: A human readable description of the problem
          example: Forbidden
          type: string
    error-500:
      title: Internal Server Error
      description: 500 - Internal Server Error
      type: object
      required:
      - details
      properties:
        details:
          description: error details
          type: array
          items:
            $ref: '#/components/schemas/internalServerErrorDetails'
    remittanceInformation:
      title: RemittanceInformation
      description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
      type: object
      properties:
        unstructured:
          type: array
          items:
            type: string
            example: Payment for Example Invoice 1234
            minLength: 1
            maxLength: 140
        structured:
          $ref: '#/components/schemas/structuredRemittanceInformation'
    error-422:
      title: Unprocessable request
      description: 422 - Unprocessable request
      type: object
      required:
      - details
      properties:
        details:
          description: error details
          type: array
          items:
            $ref: '#/components/schemas/unprocessableRequestErrorDetails'
    privateIdentification:
      title: PrivateIdentification
      type: object
      description: Unique and unambiguous identification of a person, for example a passport.
      properties:
        birthDate:
          format: date
          example: '1967-08-13'
          minLength: 10
          maxLength: 10
        provinceOfBirth:
          type: string
          example: Ontario
          minLength: 1
          maxLength: 35
        cityOfBirth:
          type: string
          example: Toronto
          minLength: 1
          maxLength: 35
        countryOfBirth:
          type: string
          example: CA
          minLength: 2
          maxLength: 2
        identification:
          type: string
          example: '1234567891'
          minLength: 1
          maxLength: 35
        identificationCode:
          type: string
          minLength: 4
          maxLength: 4
          enum:
          - ARNU
          - BANK
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TELE
          - TXID
          - POID
          description: "A programmatic code:\n  * ARNU - AlienRegistrationNumber - Number assigned by a social security agency to identify a non-resident person.\n  * BANK - BankPartyIdentification - Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n  * CCPT - PassportNumber - Number assigned by an authority to identify the passport number of a person.\n  * CUST - CustomerIdentificationNumber - Number assigned by an issuer to identify a customer.\n  * DRLC - DriversLicenseNumber - Number assigned by an authority to identify a driver's license.\n  * EMPL - EmployeeIdentificationNumber - Number assigned by a registration authority to an employee.\n  * NIDN - NationalIdentityNumber - Number assigned by an authority to identify the national identity number of a person.\n  * SOSE - SocialSecurityNumber - Number assigned by an authority to identify the social security number of a person.\n  * TELE - TelephoneNumber - Number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n  * TXID - TaxIdentificationNumber - Number assigned by a tax authority to identify a person.\n  * POID - PersonCommercialIdentification - Commercial identification of the person.\n"
        issuer:
          type: string
          minLength: 1
          maxLength: 35
    garnishmentRemittance:
      title: GarnishmentRemittance
      type: object
      description: Provides remittance information about a payment for garnishment-related purposes.
      properties:
        typeCode:
          type: string
          minLength: 1
          maxLength: 35
        typeIssuer:
          type: string
          minLength: 1
          maxLength: 35
        garnishee:
          $ref: '#/components/schemas/remittanceParty'
        garnishmentAdministrator:
          $ref: '#/components/schemas/remittanceParty'
        certificateIdentification:
          type: string
          minLength: 1
          maxLength: 35
        referenceNumber:
          type: string
          minLength: 1
          maxLength: 140
        date:
          format: date
          minLength: 10
          maxLength: 10
        remittedAmount:
          $ref: '#/components/schemas/amount'
        familyMedicalInsuranceIndicator:
          type: boolean
        employeeTerminationIndicator:
          type: boolean
    remittanceParty:
      title: Party
      type: object
      description: Identification of a person or an organisation
      properties:
        name:
          type: string
          example: Company ABC
          minLength: 1
          maxLength: 140
        postalAddress:
          $ref: '#/components/schemas/postalAddress'
        organisationIdentification:
          $ref: '#/components/schemas/organisationIdentification'
        privateIdentification:
          $ref: '#/components/schemas/privateIdentification'
        countryOfResidence:
          type: string
          example: CA
          minLength: 2
          maxLength: 2
        contactDetails:
          $ref: '#/components/schemas/contactDetails'
    contactDetails:
      title: Party
      type: object
      description: Set of elements used to indicate how to contact the party.
      properties:
        namePrefix:
          type: string
          example: DOCT
          minLength: 4
          maxLength: 4
        name:
          type: string
          example: John
          minLength: 1
          maxLength: 140
        phoneNumber:
          type: string
          minLength: 1
          maxLength: 30
        mobileNumber:
          type: string
          minLength: 1
          maxLength: 30
        faxNumber:
          type: string
          minLength: 1
          maxLength: 30
        emailAddress:
          type: string
          minLength: 1
          maxLength: 2048
        emailPurpose:
          type: string
          minLength: 1
          maxLength: 35
        jobTitle:
          type: string
          minLength: 1
          maxLength: 35
        responsibility:
          type: string
          minLength: 1
          maxLength: 35
        department:
          type: string
          minLength: 1
          maxLength: 70
        channelType:
          type: string
          minLength: 1
          maxLength: 4
        channelTypeIdentification:
          type: string
          minLength: 1
          maxLength: 128
        preferredMethod:
          type: string
          minLength: 4
          maxLength: 4
    amount:
      title: Amount
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          type: number
          format: float
          example: 1.01
          minimum: 0
          maximum: 99999999999
        currency:
          type: string
          example: USD
          default: USD
          minLength: 3
          maxLength: 3
    taxParty:
      title: TaxParty
      type: object
      description: Party to which the tax applies.
      properties:
        taxIdentification:
          type: string
          minLength: 1
          maxLength: 35
        registrationIdentification:
          type: string
          minLength: 1
          maxLength: 35
        taxType:
          type: string
          minLength: 1
          maxLength: 35
        authorisationTitle:
          type: string
          minLength: 1
          maxLength: 35
        authorisationName:
          type: string
          minLength: 1
          maxLength: 35
    lineDetails:
      title: LineDetails
      type: array
      items:
        type: object
        description: Set of elements used to provide the content of the referred document line.
        properties:
          lineIdentification:
            $ref: '#/components/schemas/lineIdentification'
          description:
            type: string
            minLength: 1
            maxLength: 2048
          amount:
            $ref: '#/components/schemas/remittanceAmount'
    referredDocumentInformation:
      title: ReferredDocumentInformation
      type: array
      items:
        type: object
        description: Provides the identification and the content of the referred document.
        properties:
          typeCode:
        

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nacha/refs/heads/main/openapi/nacha-initiate-payment-api-openapi.yml