Details

openapi: 3.0.0 info: version: '0.0' title: Wire Transfers API description: | Institution level configuration and information about Wires features. tags: - name: Wire Transfers servers: - url: 'https://banno.com' paths: '/a/wires/api/v0/institutions/{institutionId}/users/{userId}/wires/{wireId}': parameters: - $ref: '#/components/parameters/InstitutionId' - $ref: '#/components/parameters/UserId' - $ref: '#/components/parameters/WireId' get: security: - clientCredentials: - 'https://jackhenry.com/wires/wire-transfers.read' tags: - ISO Wire Transfers summary: View details for an ISO wire transfer. responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ISO_Wire_Details_V0' "403": description: Forbidden "404": description: Not Found "500": description: Internal Service Error "503": description: Service Not Available components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: { } parameters: InstitutionId: in: path name: institutionId description: The institution uuid required: true schema: type: string format: uuid UserId: in: path name: userId description: The Identifier of the User given by Banno. required: true schema: type: string format: uuid AccountId: in: path name: accountId description: | An identifier, created in Banno, for the credit or savings account from which the Wire Transfer (or transfers) would originate. required: true schema: type: string format: uuid WireId: in: path name: wireId required: true description: Unique identifier of a wire. schema: type: string Limit: in: query name: limit required: true schema: type: integer description: The number of items to come back in the results list. Offset: in: query name: offset required: true schema: type: integer description: The current offset of wires you are requesting to view. The first result's index is 1. The next offset comes back in the api response RepeatCode: in: query name: repeatCode required: false schema: type: string description: | The repeat code associated with the wire. IsRepetitive: in: query name: isRepetitive required: true schema: type: string description: True if the Wire transfer is a repetitive wire. IsRecurring: in: query name: isRecurring required: true schema: type: string description: True if the Wire transfer is a recurring wire. schemas: Wires_V0: type: object required: - results - totalNumberOfAvailableResults properties: results: type: array items: $ref: '#/components/schemas/Wire_V0' totalNumberOfAvailableResults: type: integer description: Total number of wires that are available to page through nextOffset: type: integer description: An optional next offset value, if this value is not present, you are viewing the last wires. Wire_V0: type: object required: - name - amount - status - isEditable - isDeletable - isRepetitive - isRecurring - recurringFrequency - fromAccountId - receivingAccountNumber - receivingFinancialInstitutionName - sequenceNumber - id - retainTemplate - futureEffectiveDate properties: name: type: string description: Name of the wire. nullable: false amount: type: string description: Total amount of the wire. nullable: false status: $ref: '#/components/schemas/Status_V0' isEditable: type: boolean description: The value indicating whether the wire is editable. nullable: false isDeletable: type: boolean description: The value indicating whether the wire is deletable. nullable: false isRepetitive: type: boolean description: The value indicating this wire can be used multiple times. nullable: false isRecurring: type: boolean description: The value indicating whether the wire is recurring. nullable: false example: true recurringFrequency: type: string enum: [ 'weekly', 'biWeekly', 'semiMonthly', 'monthly', 'quarterly', 'annually', 'semiAnnually' ] description: The frequency of the transfer request. nullable: true sequenceNumber: type: string description: The sequence number of the wire. nullable: false repeatCode: type: string description: A number returned for repetitive wire transfers only. Null for one time wire transfers. nullable: true fromAccountId: type: string format: uuid description: The Banno Account ID from which the wire transfer was sent receivingAccountNumber: type: string format: number description: The account number of the receiving account. nullable: false receivingFinancialInstitutionName: type: string description: The name of the financial institution receiving the wire transfer. nullable: false id: type: string description: The identifier of a wire transfer nullable: false retainTemplate: type: boolean description: The value indicating whether the template will be retained. nullable: false example: true futureEffectiveDate: type: string format: date description: The date a future dated wire will be processed on. When present, indicates the wire is a future dated wire. Format will be in ISO 8601 ('YYYY-MM-DD'). example: "2020-01-01" nullable: true Wire_Details_V0: type: object properties: id: type: string nullable: false name: type: string description: Name of the wire transfer. nullable: false amount: type: string description: Total amount of the wire. nullable: false status: $ref: '#/components/schemas/Status_V0' sequenceNumber: type: string description: The sequence number of the wire. nullable: false isEditable: type: boolean description: True if the wire transfer can be edited. nullable: false isDeletable: type: boolean description: True if the wire transfer can be deleted. nullable: false isRecurring: type: boolean description: True if the wire transfer is recurring. nullable: false isRepetitive: type: boolean description: True if the Wire transfer is a repetitive wire. nullable: false repeatCode: type: string description: | A sequence of digits that indicate which template a wire transfer was created from. If the wire transfer is not a repetitive wire, this field will display an empty string or "Single" nullable: false fromAccountId: type: string format: uuid description: The accountId of the wire to be transferred from. nullable: false creditAccountInformation: $ref: '#/components/schemas/Credit_Account_Information_V0' remarks: $ref: '#/components/schemas/Remarks_V0' receivingInstitutionDetails: $ref: '#/components/schemas/Receiving_Institution_Details_V0' receivingAccountNumber: type: string deprecated: true description: Deprecated. Use `creditAccountInformation.number` instead. receivingFinancialInstitutionName: type: string deprecated: true description: Deprecated. Use `receivingInstitutionDetails.name` instead. intermediaryInstitutionDetails: $ref: '#/components/schemas/Intermediary_Institution_Details_V0' recurringInformation: $ref: '#/components/schemas/Recurring_Information_V0' futureEffectiveDate: type: string format: date description: The date a future dated wire will be processed on. When present, indicates the wire is a future dated wire. Format will be in ISO 8601 ('YYYY-MM-DD'). example: "2020-01-01" nullable: true required: - id - name - fromAccountId - amount - isRepetitive - isRecurring - status - sequenceNumber - isEditable - creditAccountInformation - receivingInstitutionDetails Credit_Account_Information_V0: type: object description: Information concerning the entity receiving the wire. properties: name: type: string description: A user provided name to identity the entity receiving the wire transfer. maxLength: 35 number: type: string description: The account number receiving the wire transfer format: number maxLength: 34 address1: type: string description: The first line of the address of the account receiving the wire transfer. maxLength: 35 address2: type: string description: The second line of the address of the account receiving the wire transfer. maxLength: 35 address3: type: string description: The third line of the address of the account receiving the wire transfer. maxLength: 35 required: - name - number - address1 Remarks_V0: type: object properties: remarks1: type: string description: The first line of remarks about the wire transfer. maxLength: 35 remarks2: type: string description: Additional remarks about the wire transfer. maxLength: 35 remarks3: type: string description: Additional remarks about the wire transfer. maxLength: 35 remarks4: type: string description: Additional remarks about the wire transfer. maxLength: 35 Receiving_Institution_Details_V0: type: object properties: name: type: string description: The name of the institution receiving the wire transfer. maxLength: 18 abaNumber: type: string description: The ABA routing transit number of the receiving financial institution. maxLength: 9 address1: type: string description: The first line of the address of the receiving financial institution. maxLength: 35 address2: type: string description: The second line of the address of the receiving financial institution. maxLength: 35 address3: type: string description: The third line of the address of the receiving financial institution. maxLength: 35 required: - name - abaNumber - address1 Intermediary_Institution_Details_V0: description: | Details of the intermediary institution if one is present. An intermediary institution will be present for all international wires and on any domestic wires where the receiving institution can not receive the wire funds directly. properties: id: type: string nullable: false description: > An identifier of the Institution. The exact length/format of this value can vary based on the Type of ID that was specified by the user in the sibling `idCode` property. maxLength: 34 idCode: type: string nullable: false description: | A value indicating what type of `id` the user provided when creating the wire transfer. This value is chosen by the user when creating the wire transfer and could be one of the following: - B: a BANK ID / SWIFT number. - C: Chips Participant. - D: DDA account number. - F: FRB Routing number. - U: Chips identifier - N: Non Blank enum: [ "B", "C", "D", "F", "U", "N" ] name: type: string nullable: false description: The name of the institution maxLength: 35 address1: type: string nullable: false description: The first line of address of the institution. maxLength: 35 address2: type: string nullable: false description: The second line of the address of the institution. maxLength: 35 address3: type: string nullable: false description: The third line of the address of the institution. maxLength: 35 Status_V0: type: string enum: [ 'Ready', 'Active', 'Approval', 'Initiated', 'Next Day', 'Scheduled', 'Processed', 'Denied', 'Omitted', 'Pending', 'Under Review', 'Problem', 'Expired', 'Suspended' ] nullable: false Recurring_Information_V0: type: object required: - recurringFrequency - firstDay - secondDay - startDate - expirationDate - lastDayOfMonth - dayOfWeek - dayOfMonth - neverExpire properties: recurringFrequency: type: string enum: [ 'weekly', 'biWeekly', 'semiMonthly', 'monthly', 'quarterly', 'semiAnnually', 'annually' ] description: The frequency of the transfer request. nullable: true example: weekly firstDay: type: integer description: The day of month for first semi-monthly payment. (Ex. 1, 2...31). nullable: true example: null secondDay: type: integer description: The day of month for second semi-monthly payment. (Ex. 1, 2...31). nullable: true example: null startDate: type: string description: The date this recurring transfer request starts. format: date example: '2022-08-31' nullable: true expirationDate: type: string description: The date this recurring transfer request expires. A null value indicates that the recurring transfer request does not expire. format: date example: '2022-08-31' nullable: true lastDayOfMonth: type: boolean description: True, the recurring wire will be transmitted on the last day of the current month. False or null, the recurring wire transmitted date will be returned in the secondDay or dayOfMonth field. nullable: true example: false dayOfWeek: type: string enum: [ 'monday', 'tuesday', 'wednesday', 'thursday', 'friday' ] description: The day of the week this transfer occurs. nullable: true example: "monday" dayOfMonth: type: integer description: The day of the month this transfer occurs when frequency is monthly. (Ex. 1, 2...31). nullable: true example: null ISO_Status_V0: type: string enum: [ 'Ready', 'Processing', 'Approval', 'Complete', 'Failed', 'Canceled', 'Returned'] nullable: false ISO_Wire_Details_V0: type: object properties: wireId: type: string format: uuid nullable: false name: type: string description: Name of the wire transfer. nullable: false amount: type: string description: Total amount of the wire. nullable: false status: $ref: '#/components/schemas/ISO_Status_V0' wireTemplateId: type: string format: uuid description: Reference to the wire template. nullable: true isEditable: type: boolean description: True if the wire transfer can be edited. nullable: false isDeletable: type: boolean description: True if the wire transfer can be deleted. nullable: false isRecurring: type: boolean description: True if the wire transfer is recurring. nullable: false isRepetitive: type: boolean description: True if the Wire transfer is a repetitive wire. nullable: false futureEffectiveDate: type: string format: date description: The date a future dated wire will be processed on. When present, indicates the wire is a future dated wire. Format will be in ISO 8601 ('YYYY-MM-DD'). example: "2020-01-01" nullable: true fromAccountId: type: string format: uuid description: The accountId of the wire to be transferred from. nullable: false creditorInformation: $ref: '#/components/schemas/ISO20022_Creditor_Information_V1' instructedAgentInformation: $ref: '#/components/schemas/ISO20022_Instructed_Agent_Information_V1' intermediaryAgentInformation: $ref: '#/components/schemas/ISO20022_Intermediary_Agent_Information_V1' creditorAgentInformation: $ref: '#/components/schemas/ISO20022_Creditor_Agent_Information_V1' debtorAgentInformation: $ref: '#/components/schemas/ISO20022_Debtor_Agent_Information_V1' recurringInformation: $ref: '#/components/schemas/Recurring_Information_V0' endToEndIdentification: type: string description: | Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. If it is not provided, then "NOTPROVIDED" is used remittanceInformation: type: string description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system. approvals: type: array items: type: string format: uuid description: an array of user ids tracking who has approved a dual control wire. The array is always empty for banks. The array becomes empty when the wire is initiated. required: - wireId - name - fromAccountId - amount - isRepetitive - isRecurring - status - isEditable - isDeletable - creditorInformation - instructedAgentInformation - creditorAgentInformation - approvals ISO20022_Creditor_Information_V1: type: object description: Information concerning the entity receiving the wire. properties: name: type: string description: A user provided name to identity the entity receiving the wire transfer. maxLength: 140 number: type: string description: The account number receiving the wire transfer format: number maxLength: 34 buildingDetails: $ref: '#/components/schemas/ISO20022_Agent_Building_Details_Optional_V1' required: - name - number ISO20022_Creditor_Agent_Information_V1: type: object description: Information concerning the entity receiving the wire. properties: institutionInformation: $ref: '#/components/schemas/Agent_Information_V1' idCode: type: string nullable: false description: | A value indicating what type of `id` the user provided when creating the wire transfer. This value is chosen by the user when creating the wire transfer and could be one of the following: - B: a BANK ID / SWIFT number. - C: Chips Participant. - F: FRB Routing number. enum: [ "B", "C", "F" ] buildingDetails: $ref: '#/components/schemas/ISO20022_Agent_Building_Details_V1' required: - institutionInformation - buildingDetails ISO20022_Instructed_Agent_Information_V1: type: object properties: name: type: string description: The name of the institution receiving the wire transfer. maxLength: 140 abaNumber: type: string description: The ABA routing transit number of the receiving financial institution. maxLength: 9 city: type: string description: City/Town name (ex. New York). maxLength: 35 state: type: string description: Identifies a subdivision of a country such as state, region, county. maxLength: 35 required: - name - abaNumber Agent_Information_V1: description: | Details of financial institution. properties: id: type: string nullable: false description: > An identifier of the Institution. maxLength: 35 name: type: string nullable: false description: The name of the institution maxLength: 140 required: - id - name ISO20022_Intermediary_Agent_Information_V1: description: | Details of the intermediary institution if one is present. An intermediary institution will be present for all international wires and on any domestic wires where the receiving institution can not receive the wire funds directly. nullable: true properties: institutionInformation: $ref: '#/components/schemas/Agent_Information_V1' idCode: type: string nullable: false description: | A value indicating what type of `id` the user provided when creating the wire transfer. This value is chosen by the user when creating the wire transfer and could be one of the following: - B: a BANK ID / SWIFT number. - C: Chips Participant. - F: FRB Routing number. enum: [ "B", "C", "F"] buildingDetails: $ref: '#/components/schemas/ISO20022_Agent_Building_Details_V1' required: - institutionInformation - idCode - buildingDetails ISO20022_Debtor_Agent_Information_V1: description: | Details of the originating institution. nullable: true properties: institutionInformation: $ref: '#/components/schemas/Agent_Information_V1' buildingDetails: $ref: '#/components/schemas/ISO20022_Agent_Building_Details_Optional_V1' ISO20022_Agent_Building_Details_Optional_V1: type: object description: Creditor postal address. properties: streetName: type: string description: Name of the street. maxLength: 70 zipCode: type: string description: Zip code/Postal code. maxLength: 16 city: type: string description: City/Town name (ex. New York). maxLength: 35 country: type: string description: Country (ex. US). maxLength: 2 pattern: '[A-Z]{2,2}' example: US department: type: string description: Identification of a division of a large organization or building. maxLength: 70 subDepartment: type: string description: Identification of a sub-division of a large organization or building. maxLength: 70 buildingNumber: type: string description: Number that identifies the position of a building on a street. maxLength: 16 buildingName: type: string description: Name of the building or house. maxLength: 35 floor: type: string description: Floor or story within a building. maxLength: 70 postBox: type: string description: Numbered box in a post office, assigned to a person or organization, where letters are kept until called for. maxLength: 16 room: type: string description: Building room number. maxLength: 70 townLocationName: type: string description: Specific location name within the town. maxLength: 35 districtName: type: string description: Identifies a subdivision within a country sub-division. maxLength: 35 state: type: string description: Identifies a subdivision of a country such as state, region, county. maxLength: 35 ISO20022_Agent_Building_Details_V1: type: object description: Creditor postal address. properties: streetName: type: string description: Name of the street. maxLength: 70 zipCode: type: string description: Zip code/Postal code. maxLength: 16 city: type: string description: City/Town name (ex. New York). maxLength: 35 country: type: string description: Country (ex. US). maxLength: 2 pattern: '[A-Z]{2,2}' example: US department: type: string description: Identification of a division of a large organization or building. maxLength: 70 subDepartment: type: string description: Identification of a sub-division of a large organization or building. maxLength: 70 buildingNumber: type: string description: Number that identifies the position of a building on a street. maxLength: 16 buildingName: type: string description: Name of the building or house. maxLength: 35 floor: type: string description: Floor or story within a building. maxLength: 70 postBox: type: string description: Numbered box in a post office, assigned to a person or organization, where letters are kept until called for. maxLength: 16 room: type: string description: Building room number. maxLength: 70 townLocationName: type: string description: Specific location name within the town. maxLength: 35 districtName: type: string description: Identifies a subdivision within a country sub-division. maxLength: 35 state: type: string description: Identifies a subdivision of a country such as state, region, county. maxLength: 35 required: - city - country Wires_V1: type: object required: - results - totalNumberOfAvailableResults properties: results: type: array items: $ref: '#/components/schemas/Wire_V1' totalNumberOfAvailableResults: type: integer description: Total number of wires that are available to page through nextOffset: type: integer description: An optional next offset value, if this value is not present, you are viewing the last wires. Wire_V1: type: object required: - wireId - name - amount - status - isEditable - isDeletable - isRepetitive - isRecurring - recurringFrequency - fromAccountId - creditorAccountNumber - instructedAgentName - futureEffectiveDate properties: wireId: type: string format: uuid description: The wire ID. nullable: false name: type: string description: Name of the wire. nullable: false amount: type: string description: Total amount of the wire. nullable: false status: $ref: '#/components/schemas/Status_V0' wireTemplateId: type: string format: uuid description: Reference to the wire template. nullable: true isEditable: type: boolean description: The value indicating whether the wire is editable. nullable: false isDeletable: type: boolean description: True if the wire transfer can be deleted. nullable: false isRepetitive: type: boolean description: The value indicating this wire can be used multiple times. nullable: false isRecurring: type: boolean description: The value indicating whether the wire is recurring. nullable: false example: true recurringFrequency: type: string enum: [ 'weekly', 'biWeekly', 'semiMonthly', 'monthly', 'quarterly', 'annually', 'semiAnnually' ] description: The frequency of the transfer request. nullable: true fromAccountId: type: string format: uuid description: The Banno Account ID from which the wire transfer was sent creditorAccountNumber: type: string format: number description: The account number of the receiving account. nullable: false instructedAgentName: type: string description: The name of the financial institution receiving the wire transfer. nullable: false futureEffectiveDate: type: string format: date description: The date a future dated wire will be processed on. When present, indicates the wire is a future dated wire. Format will be in ISO 8601 ('YYYY-MM-DD'). example: "2020-01-01" nullable: true